# @dynatrace-sdk/client-classic-environment-v2 中文文档

规范地址：https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/

版本：11\.0\.0
npm 元数据更新时间：2026-10-30T08:04:38.575Z
中文译文更新时间：2026-11-13T02:39:33.005Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dynatrace-sdk/client-classic-environment-v2
原文对照：https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：5.4 MB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-11-25T12:36:21.774Z
- 最新版本发布：2026-10-30T08:04:38.341Z
- 近 30 天下载量：15823（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：48（近 12 个月 10 个）

## 中文简介

Dynatrace 环境 API v2 的客户端

## 安装

```sh
npm install @dynatrace-sdk/client-classic-environment-v2
```

也可以使用：`pnpm add @dynatrace-sdk/client-classic-environment-v2`、`yarn add @dynatrace-sdk/client-classic-environment-v2`、`bun add @dynatrace-sdk/client-classic-environment-v2`

## README

# @dynathrace-sdk/客户端-经典-环境-v2

[![npm](https://img.shields.io/badge/npm-v11.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/11.0.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Dynatrace环境API v2的文档. 这里的资源一般取代v1中的资源. V1的资源转移正在进行.

如果您错过资源, 请考虑使用 Dynatrace 环境 API v1 .

阅读使用案例和实例,参见: [Dynatrace 文档](https://dt-url.net/2u23k1k)。 。 。 .

关于兼容性的注释 :

-   标记为早期采纳者或预览的操作可能以不相容的方式被更改,尽管我们试图避免.
-   我们可以在不增加API版本的情况下添加新的enum常数;因此,客户端需要优雅地处理未知的enum常数.

## 安装

```bash
npm install @dynatrace-sdk/client-classic-environment-v2
```

## 获得帮助

-   访问 [用于打字的 SDK](https://developer.dynatrace.com/reference/sdks/) 指南中 [Dynatrace 开发者](https://developer.dynatrace.com/)
-   问个问题 [Dynatrace社区](https://community.dynatrace.com/)

## 许可证

此 SDK 分布于 [Apache 许可证,2.0版本](http://www.apache.org/licenses/LICENSE-2.0),更多信息见LICENSE.

# API 参考

最新版本SDK的API 完整参考文件也可在 [Dynatrace 开发者](https://developer.dynatrace.com/reference/sdks/client-classic-environment-v2/)。 。 。 .

## 访问 TokensAactiveGateTokens 客户端

```js
import { accessTokensActiveGateTokensClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### 创建托肯

**accessTokensAactiveGateTokensClient.createToken(配置):承诺 <[活动GateToken创建](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetokencreated)\> 翻译:**

创建新活动Gate 令牌

**需要以下范围之一:**

-   环境- api: 活动门- tokens: 创建
-   环境- api: 活动门- tokens: write
-   机队管理:活性gate.tokens:create
-   机队管理:活性门. tokens:write

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活性门. tokens:write

新创建的指使会由拥有用于认证呼叫的指使的同名用户所拥有.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [活动GateToken创造](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetokencreate) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [活动GateToken创建](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetokencreated) | 201 (韩语) | 圆满. 信使已经创建了. 反应的正文中包含着象征的秘密. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensActiveGateTokensClient.createToken({
    body: {
      activeGateType: "ENVIRONMENT",
      name: "myToken",
    },
  });
```

### 获取托肯

**accessTokensAactiveGateTokensClient.getToken(配置):承诺 <[活动 GateToken 语句](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetoken)\> 翻译:**

获取活动Gate 令牌的元数据

**需要以下范围之一:**

-   环境- api: 活动门- tokens: read
-   机队管理:活性gate.tokens:read

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活性gate.tokens:read

标志性的秘密是 **没有** 暴露了 暴露了.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 活性GateToken标识符\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | ActiveGate 符号标识符,由 [前缀和公开部分](https://dt-url.net/rn00tjg) 的标志. |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [活动 GateToken 语句](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetoken) | 200个 | 圆满. 回复中包含符的元数据. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 失败。 请求的资源不存在. QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensActiveGateTokensClient.getToken({
    activeGateTokenIdentifier: "...",
  });
```

### 列表脚本

**访问 TokensAactiveGateTokensClient.listTokens(配置): 保证 <[活动目录](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetokenlist)\> 翻译:**

列出所有可用的 ActiveGate 令牌

**需要以下范围之一:**

-   环境- api: 活动门- tokens: read
-   机队管理:活性gate.tokens:read

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活性gate.tokens:read

您可以使用 pagination 限制输出 :

1.  指定在 **页面大小** 查询参数.
2.  使用光标 **下一个PageKey** 字段输入 **下一个PageKey** 查询参数以获取后续页面.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置( nextPageKey) | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
下一页结果的光标 。 你可以在电影里找到它 **下一个PageKey** 字段.

首页总是返回,如果你没有指定 **下一个PageKey** 查询参数.

当 **下一个PageKey** 要获取后续页面,您必须省略所有其他查询参数.

 |
| 配置.页面大小 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 

单个应答有效载荷中的活化Gate令牌数量.

允许的最大页面尺寸为3000个,最小尺寸为100个.

如果没有设置,则使用100.

 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [活动目录](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetokenlist) | 200个 | 圆满. 回复包含ActiveGate令牌列表. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 失败。 请求的资源不存在. QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensActiveGateTokensClient.listTokens();
```

### 撤销托肯

**访问 TokensAactiveGateTokensClient.revokeToken(配置):保证<void>**

删除活动Gate 令牌

**需要以下范围之一:**

-   环境- api: 活动门- tokens: write
-   机队管理:活性门. tokens:write

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活性门. tokens:write

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 活性GateToken标识符\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | ActiveGate 符号标识符,由 [前缀和公开部分](https://dt-url.net/rn00tjg) 的符号. |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 圆满. 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 失败。 请求的资源不存在. QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensActiveGateTokensClient.revokeToken({
    activeGateTokenIdentifier: "...",
  });
```

## 访问 Tokens 代理客户端

```js
import { accessTokensAgentTokensClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### 获取代理连接键

**访问 Tokens AgentTokensClient.get AgentConnection Token(配置): 保证 <[代理连接键](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-agentconnectiontoken)\> 翻译:**

获取代理连接符 QQ 成熟度= EARLY ADOPTER

**需要以下范围之一:**

-   环境- api: 代理连接键: 已读
-   机队管理:oneagent.tokens:read

**需要下列许可之一:**

-   环境:作用:代理安装
-   机队管理:oneagent.tokens:read

返回代理连接符 .

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [代理连接键](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-agentconnectiontoken) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 失败。 请求的资源不存在. QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensAgentTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensAgentTokensClient.getAgentConnectionToken();
```

## 访问 TokensApiTokens 客户端

```js
import { accessTokensApiTokensClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### ~创建 ApiToken 语句~

> ⚠️ **折旧**

**accessTokens ApiTokensClient.create ApiToken(配置):承诺 <[ApiToken 创建](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitokencreated)\> 翻译:**

创建新的 API 令牌

**需要以下范围之一:**

-   环境- api: api- tokens: write
-   api-tokens:tokens:写

**需要下列许可之一:**

-   环境:作用:查看器
-   api-tokens:tokens:写

新创建的指使会由拥有用于认证呼叫的指使的同名用户所拥有.

创建个人访问符号需要 `environment:roles:viewer` 允许。 创建访问令牌需要 `environment:roles:manage-settings` 允许.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [ApiToken 创建](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitokencreate) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [ApiToken 创建](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitokencreated) | 201 (韩语) | 圆满. 信使已经创建了. 反应的正文中包含着象征的秘密. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.createApiToken({
    body: { name: "tokenName", scopes: ["metrics.read"] },
  });
```

### ~删除 ApiToken~

> ⚠️ **折旧**

**accessTokens ApiTokensClient.delete ApiToken(配置):保证<void>**

删除 API 令牌

**需要以下范围之一:**

-   环境- api: api- tokens: write
-   api-tokens:tokens:写

**需要下列许可之一:**

-   环境:作用:查看器
-   api-tokens:tokens:写

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
要删除的符号的ID .

您可以指定代号或代号的秘密 .

无法删除用于请求认证的代号.

 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 圆满. 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 无法删除用于请求认证的代号. QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.deleteApiToken({
    id: "...",
  });
```

### ~获取 ApiToken~

> ⚠️ **折旧**

**访问 Tokens ApiTokensClient.get ApiToken(配置): 保证 <[阿皮托肯语Name](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitoken)\> 翻译:**

通过代号ID获取 API 令牌元数据

**需要以下范围之一:**

-   环境- api: api- tokens: read
-   api-tokens:tokens: read (中文(简体) )

**需要下列许可之一:**

-   环境:作用:查看器
-   api-tokens:tokens: read (中文(简体) )

标志性的秘密是 **没有** 暴露了 暴露了.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [阿皮托肯语Name](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitoken) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await accessTokensApiTokensClient.getApiToken({
  id: "...",
});
```

### ~列表 Apitokens 数据~

> ⚠️ **折旧**

**访问 Tokens ApiTokensClient.list ApiTokens(配置): 承诺 <[ApiToken 列表](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitokenlist)\> 翻译:**

列出所有可用的 API 令牌

**需要以下范围之一:**

-   环境- api: api- tokens: read
-   api-tokens:tokens: read (中文(简体) )

**需要下列许可之一:**

-   环境:作用:查看器
-   api-tokens:tokens: read (中文(简体) )

您可以使用 pagination 限制输出 :

1.  指定在 **页面大小** 查询参数.
2.  使用光标 **下一个PageKey** 字段输入 **下一个PageKey** 查询参数以获取后续页面.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. api Token 选择器 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
过滤由此产生的几组令牌。 答复中只包含符合指定标准的标志.

您可以设置以下一个或多个标准:

-   拥有者 : `owner("value")`。拥有该符号的用户。 案件敏感.
-   个人访问令牌 : `personalAccessToken(false)`设置为 `true` 仅包含个人访问令牌或 `false` 只包含 API 令牌.
-   切入范围 : `scope("scope1","scope2")`如果指定了数个值,则 **或** 逻辑适用.

要设定多重标准,请用逗号将其分离(`,`) (中文(简体) ). 只匹配结果 **全部** 标准被纳入答复.

 |
| 相会. 字段 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

指定要包含在响应中的字段.

默认包含以下字段:

-   `id`
-   `name`
-   `enabled`
-   `owner`
-   `creationDate`

要从响应中去除字段,请用负数指定(`-`作为逗号分隔列表的运算符(例如, `-creationDate,-owner`) (中文(简体) ).

包括其它字段:

-   `personalAccessToken`
    
-   `expirationDate`
    
-   `lastUsedDate`
    
-   `lastUsedIpAddress`
    
-   `modifiedDate`
    
-   `scopes`
    
-   `additionalMetadata`
    

要在响应中添加字段,请以加字表示(`+`作为逗号分隔列表的运算符(例如, `+expirationDate,+scopes`) (中文(简体) ). 可以合并添加和去除字段(例如, `+scopes,-creationDate`) (中文(简体) ).

或者,您可以在响应中定义想要的一组字段。 指定所需字段为逗号分隔列表,不包含运算符(例如, `creationDate,expirationDate,owner`) (中文(简体) ). ID总是包含在响应中.

这个 **字段** 字符串必须是 URL 编码 .

 |
| 配置从 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

基于上次使用时间的过滤符 。 所要求的时间框架的开始.

您可以使用下列格式之一:

-   UTC毫秒内的时间戳.
-   人类可读格式 `2021-01-25T05:57:01.123+01:00`。如果没有指定时区,则使用协调世界时。 您可以使用空间字符代替 `T`。秒和分数是可选的.
-   相对时间,从现在开始。 格式为 `now-NU/A`时 `N` 是时间, `U` 是时间的单位,并且 `A` 是一个对齐。 对齐将所有更小的值都绕到过去最接近的零. 譬如说, `now-1y/w` 一年前,一周前开始 也可以指定相对时间框架而不调整 : `now-NU`支持的相对时间框架时间单位有:
    -   `m`: 分钟
    -   `h`时间:
    -   `d`天数 :
    -   `w`单位:星期
    -   `M`月数
    -   `y`年数 :

 |
| 配置( nextPageKey) | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

下一页结果的光标 。 你可以在电影里找到它 **下一个PageKey** 字段.

首页总是返回,如果你没有指定 **下一个PageKey** 查询参数.

当 **下一个PageKey** 要获取后续页面,您必须省略所有其他查询参数.

 |
| 配置.页面大小 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 

单个响应有效载荷中的API令牌数量.

允许的最大页面大小为10000个,允许的最小页面大小为100个.

如果没有设定,则使用200.

 |
| 配置. sort (帮助) | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

符号列表的排序顺序 .

您可以用排序顺序的符号前缀排序以下属性:

-   `name`: 符号名称 (`+` a.z 或 (简体中文) `-` z... a) (英语)
-   `lastUsedDate` 上次使用( e)`+` 从未先使用过符号 `-` 最近使用的先用符号)
-   `creationDate` (单位:千美元)`+` 最古老的标志 `-` 最新标志 )
-   `expirationDate` (单位:千美元)`+` 即将到期的标志 `-` 首个无限符号)
-   `modifiedDate` 上次修改( e)`+` 从未先修改过符号 `-` 最近修改过的符号首先)

如果没有设置前缀,则使用+.

如果不设定, 则按创建日期排序 .

  
  
**默认 :** `-creationDate` |
| 配置( t) | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

基于上次使用时间的过滤符 。 所要求的时限结束.

您可以使用下列格式之一:

-   UTC毫秒内的时间戳.
-   人类可读格式 `2021-01-25T05:57:01.123+01:00`。如果没有指定时区,则使用协调世界时。 您可以使用空间字符代替 `T`。秒和分数是可选的.
-   相对时间,从现在开始。 格式为 `now-NU/A`时 `N` 是时间, `U` 是时间的单位,并且 `A` 是一个对齐。 对齐将所有更小的值都绕到过去最接近的零. 譬如说, `now-1y/w` 一年前,一周前开始 也可以指定相对时间框架而不调整 : `now-NU`支持的相对时间框架时间单位有:
    -   `m`: 分钟
    -   `h`时间:
    -   `d`天数 :
    -   `w`单位:星期
    -   `M`月数
    -   `y`年数 :

如果没有设置,则使用当前时间戳.

 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [ApiToken 列表](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitokenlist) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.listApiTokens();
```

### ~寻找 ApiToken~

> ⚠️ **折旧**

**访问 Tokens ApiTokensClient. Lookup ApiToken( 配置): 承诺 <[阿皮托肯语Name](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitoken)\> 翻译:**

以符号秘密获取 API 令牌元数据

**需要以下范围之一:**

-   环境- api: api- tokens: read
-   api-tokens:tokens: read (中文(简体) )

**需要下列许可之一:**

-   环境:作用:查看器
-   api-tokens:tokens: read (中文(简体) )

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [ApiToken 密钥](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitokensecret) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [阿皮托肯语Name](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitoken) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.lookupApiToken({
    body: {
      token:
        "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",
    },
  });
```

### ~更新 ApiToken~

> ⚠️ **折旧**

**访问 Tokens ApiTokensClient.update ApiToken(配置):承诺<void>**

更新 API 令牌

**需要以下范围之一:**

-   环境- api: api- tokens: write
-   api-tokens:tokens:写

**需要下列许可之一:**

-   环境:作用:查看器
-   api-tokens:tokens:写

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [ApiToken 更新日期](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-apitokenupdate) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
要更新的代号的ID .

无法禁用用于请求认证的代号.

 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 圆满. 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.updateApiToken({
    id: "...",
    body: {},
  });
```

## 访问 TokensTenant Tokens 客户端

```js
import { accessTokensTenantTokensClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### 取消旋转

**accessTokensTenantTokensClient.cancel Rotation(配置):承诺<[租户TokenFig](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-tenanttokenconfig)\> 翻译:**

取消租户代号轮换

**需要以下范围之一:**

-   环境- api: tenant- token- rotation: write
-   机队管理:租机:旋转

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:租机:旋转

要学会如何旋转符号,看 [按键旋转](https://dt-url.net/1543sf6) 在 Dynatrace 文档中.

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [租户TokenFig](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-tenanttokenconfig) | 200个 | 圆满. 旋转进程被取消 。 目前的租户证仍然有效. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 目前没有轮调进程。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensTenantTokensClient.cancelRotation();
```

### 完成旋转

**访问 TokensTenantTokensClient. 完成旋转( 配置): 承诺 <[租户TokenFig](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-tenanttokenconfig)\> 翻译:**

完成租户代号旋转

**需要以下范围之一:**

-   环境- api: tenant- token- rotation: write
-   机队管理:租机:旋转

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:租机:旋转

要学会如何旋转符号,看 [按键旋转](https://dt-url.net/1543sf6) 在 Dynatrace 文档中.

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [租户TokenFig](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-tenanttokenconfig) | 200个 | 圆满. 轮调过程已经完成。 这个 **活动** 答复中包含新的租户代号. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 没有进行中的轮换程序。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensTenantTokensClient.finishRotation();
```

### 获取旋转状态

**accessTokensTenantTokensClient.get 旋转状态(配置):承诺 <[租户轮换状况](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-tenanttokenrotationstatus)\> 翻译:**

获得租户代币轮换身份

**需要以下范围之一:**

-   环境- api: tenant- token- rotation: write
-   机队管理:租机:旋转

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:租机:旋转

要学会如何旋转符号,看 [按键旋转](https://dt-url.net/1543sf6) 在 Dynatrace 文档中.

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [租户轮换状况](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-tenanttokenrotationstatus) | 200个 | 圆满. 返回旋转状态. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 无法使用租户代币配置 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensTenantTokensClient.getRotationStatus();
```

### 启动旋转

**访问 TokensTenant TokensClient. start Rotation( 配置): 承诺 <[租户TokenFig](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-tenanttokenconfig)\> 翻译:**

开始租户代号旋转

**需要以下范围之一:**

-   环境- api: tenant- token- rotation: write
-   机队管理:租机:旋转

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:租机:旋转

要学会如何旋转符号,看 [按键旋转](https://dt-url.net/1543sf6) 在 Dynatrace 文档中.

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [租户TokenFig](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-tenanttokenconfig) | 200个 | 圆满. 新建了租户代币,将取代旧的代币. 这个 **活动** 答复中包含新的租户代号. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 另一个轮调进程已在进行中。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensTenantTokensClient.startRotation();
```

## 活动Gates 动作Gate Groups 客户端

```js
import { activeGatesActiveGateGroupsClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### ~获取动作组~

> ⚠️ **折旧**

**活动Gates 动作GateGroups Client.get 动作GateGateGroups(配置): 保证 <[活动组](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegategroups)\> 翻译:**

活动组列表

**需要以下范围之一:**

-   环境- api: 活动门: 已读
-   机队管理:活动门:已读

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活动门:已读

自1.343版本起折旧. 使用 DQL Smartscape 节点查询 ActiveGate 数据取而代之. 见 [https://dt-url.net/mf03894 (英语)](https://dt-url.net/mf03894)

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [活动组](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegategroups) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesActiveGateGroupsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesActiveGateGroupsClient.getActiveGateGroups();
```

## 活动GateGateTokens 执行客户端

```js
import { activeGatesActiveGateTokensEnforcementClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### 获得执行

**活动GatesAactiveGateTokens EnforcementClient.getToken Enforcement(配置):承诺 <[活动GateToken 执行](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetokenenforcement)\> 翻译:**

获得 ActiveGate 令牌执行状态

**所需范围 :** 机队管理:活动门:已读 **需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活动门:已读

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [活动GateToken 执行](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatetokenenforcement) | 200个 | 圆满. 回复包含 ActiveGate 令牌执行状态 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesActiveGateTokensEnforcementClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesActiveGateTokensEnforcementClient.getTokenEnforcement();
```

## 活动Gates 自动更新配置

```js
import { activeGatesAutoUpdateConfigurationClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### ~获取自动更新ConfigById~

> ⚠️ **折旧**

**活动Gates 自动更新配置Client.get 自动更新 ConfigById(配置): 保证 <[活动Gate 自动更新配置](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegateautoupdateconfig)\> 翻译:**

获取指定的 ActiveGate 自动更新的配置

**需要以下范围之一:**

-   环境- api: 活动门: 已读
-   机队管理:活动门:已读

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活动门:已读

获取指定的 ActiveGate 自动更新的配置

**折旧通知:** 此端点被贬. 使用设置 API 端点 `GET /api/v2/settings/objects` 有计划 `builtin:deployment.activegate.updates` 财务报告和审定财务报表 `scopes=ENVIRONMENT_ACTIVE_GATE-{ActiveGate ID}` 以获取特定 ActiveGate 的自动更新设置.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. agId\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的 ActiveGate 的标识 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [活动Gate 自动更新配置](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegateautoupdateconfig) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 没有找到。 详细情况见反应机构。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById(
    { agId: "..." },
  );
```

### ~获取全球自动更新配置~

> ⚠️ **折旧**

**活动 Gates 自动更新 Configation Client.get Global Autoupdate ConfigForTenant(配置): 保证 <[ActiveGate 全球自动更新配置](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegateglobalautoupdateconfig)\> 翻译:**

获得环境 ActiveGates 全球自动更新配置.

**需要以下范围之一:**

-   环境- api: 活动门: 已读
-   机队管理:活动门:已读

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活动门:已读

获得环境 ActiveGates 全球自动更新配置.

**折旧通知:** 此端点被贬. 使用设置 API 端点 `GET /api/v2/settings/objects` 有计划 `builtin:deployment.activegate.updates` 财务报告和审定财务报表 `scopes=tenant` 以获取环境 ActiveGates 的全球自动更新设置.

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [ActiveGate 全球自动更新配置](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegateglobalautoupdateconfig) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.getGlobalAutoUpdateConfigForTenant();
```

### ~设置自动更新ConfigById~

> ⚠️ **折旧**

**活动 Gates 自动更新配置Client.putoUndate ConfigById(配置):承诺<void>**

更新指定的 ActiveGate 自动更新的配置

**需要以下范围之一:**

-   环境- api: 活动门: 写入
-   机队管理: 活动门: 写入

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理: 活动门: 写入

更新指定的 ActiveGate 自动更新的配置

**折旧通知:** 此端点被贬. 使用设置 API 端点 `POST /api/v2/settings/objects` 有计划 `builtin:deployment.activegate.updates` 财务报告和审定财务报表 `scope=ENVIRONMENT_ACTIVE_GATE-{ActiveGate ID}` 更改特定 ActiveGate 的自动更新设置.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. agId\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的 ActiveGate 的标识 . |
| 配置. 身体\*必须 | [活动Gate 自动更新配置](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegateautoupdateconfig) |  |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 圆满. 自动更新配置已经更新 。 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(
    {
      agId: "...",
      body: {
        setting: "INHERITED",
        updateWindows: {
          windows: [
            {
              id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
            },
          ],
        },
      },
    },
  );
```

### ~设置全球自动更新配置~

> ⚠️ **折旧**

**活动 Gates 自动更新 Configation Client.put Global 自动更新 ConfigForTenant(配置): 保证<void>**

设置环境 ActiveGates 的全球自动更新配置.

**需要以下范围之一:**

-   环境- api: 活动门: 写入
-   机队管理: 活动门: 写入

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理: 活动门: 写入

设置环境 ActiveGates 的全球自动更新配置.

**折旧通知:** 此端点被贬. 使用设置 API 端点 `POST /api/v2/settings/objects` 有计划 `builtin:deployment.activegate.updates` 财务报告和审定财务报表 `scope=tenant` 以改变环境 ActiveGates 的全球自动更新设置.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [ActiveGate 全球自动更新配置](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegateglobalautoupdateconfig) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 圆满. 全球自动更新配置已经更新。 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
    {
      body: {
        globalSetting: "ENABLED",
        updateWindows: {
          windows: [
            {
              id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
            },
          ],
        },
      },
    },
  );
```

### ~验证自动更新 ConfigById~

> ⚠️ **折旧**

**活动 Gates 自动更新 Configation Client.validate 自动更新 ConfigById( 配置): 保证<void>**

验证该装置的有效载荷 `POST /activeGates/{agId}/autoUpdate` 请求.

**需要以下范围之一:**

-   环境- api: 活动门: 写入
-   机队管理: 活动门: 写入

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理: 活动门: 写入

验证该装置的有效载荷 `POST /activeGates/{agId}/autoUpdate` 请求.

**折旧通知:** 此端点被贬. 使用设置 API 端点 `POST /api/v2/settings/objects?validateOnly=true` 有计划 `builtin:deployment.activegate.updates` 财务报告和审定财务报表 `scope=ENVIRONMENT_ACTIVE_GATE-{ActiveGate ID}` 用于验证特定 ActiveGate 的自动更新设置.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. agId\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的 ActiveGate 的标识 . |
| 配置. 身体\*必须 | [活动Gate 自动更新配置](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegateautoupdateconfig) |  |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 已验. 提交的自动更新配置是有效的 。 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(
    {
      agId: "...",
      body: {
        setting: "INHERITED",
        updateWindows: {
          windows: [
            {
              id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
            },
          ],
        },
      },
    },
  );
```

### ~验证全球自动更新配置~

> ⚠️ **折旧**

**活动 Gates 自动更新 Configation Client.validate Global 自动更新 ConfigForTenant(配置): 承诺<void>**

验证该装置的有效载荷 `POST /activeGates/autoUpdate` 请求.

**需要以下范围之一:**

-   环境- api: 活动门: 写入
-   机队管理: 活动门: 写入

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理: 活动门: 写入

验证该装置的有效载荷 `POST /activeGates/autoUpdate` 请求.

**折旧通知:** 此端点被贬. 使用设置 API 端点 `POST /api/v2/settings/objects?validateOnly=true` 有计划 `builtin:deployment.activegate.updates` 财务报告和审定财务报表 `scope=tenant` 以验证环境 ActiveGates 的全球自动更新设置.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [ActiveGate 全球自动更新配置](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegateglobalautoupdateconfig) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 已验. 提交的配置是有效的 。 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
    {
      body: {
        globalSetting: "ENABLED",
        updateWindows: {
          windows: [
            {
              id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
            },
          ],
        },
      },
    },
  );
```

## 活动Gates 自动更新工作

```js
import { activeGatesAutoUpdateJobsClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### ~创建 Update JobForAg~

> ⚠️ **折旧**

**活动GatesAutodateJobsClient. 创建 UpdateJobForAg(配置):承诺 <[更新工作](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejob)\> 翻译:**

为指定的 ActiveGate 创建新更新任务

**需要以下范围之一:**

-   环境- api: 活动门: 写入
-   机队管理: 活动门: 写入

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理: 活动门: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. agId\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的 ActiveGate 的标识 . |
| 配置. 身体\*必须 | [更新工作](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejob) |  |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [更新工作](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejob) | 201 (韩语) | 圆满. 更新工作已经创建 . |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.createUpdateJobForAg(
    {
      agId: "...",
      body: { targetVersion: "1.190.0.20200301-130000" },
    },
  );
```

### ~删除更新JobByJobIdForAg~

> ⚠️ **折旧**

**活动 Gates 自动更新JobsClient. delateUpdateJobByJobIdForAg(配置): 保证<void>**

删除指定的更新任务

**需要以下范围之一:**

-   环境- api: 活动门: 写入
-   机队管理: 活动门: 写入

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理: 活动门: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. agId\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的 ActiveGate 的标识 . |
| 配置。 任务\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | ActiveGate 更新工作的唯一标识符 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 圆满. 更新任务已删除 。 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 没有找到。 详细情况见反应机构。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.deleteUpdateJobByJobIdForAg(
    { agId: "...", jobId: "..." },
  );
```

### ~获取全部更新工作列表~

> ⚠️ **折旧**

**活动 Gates 自动更新JobsClient.get AllUpdateJobList(配置):承诺 <[更新全部工作](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejobsall)\> 翻译:**

列出带有更新任务的活动Gates

**需要以下范围之一:**

-   环境- api: 活动门: 已读
-   机队管理:活动门:已读

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活动门:已读

反应包括ActiveGates既已完成(成功和失败)工作,也正在完成中的工作.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置从 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
请求更新任务的时间框架的开始 .

您可以使用下列格式之一:

-   UTC毫秒内的时间戳.
-   人类可读格式 `2021-01-25T05:57:01.123+01:00`。如果没有指定时区,则使用协调世界时。 您可以使用空间字符代替 `T`。秒和分数是可选的.
-   相对时间,从现在开始。 格式为 `now-NU/A`时 `N` 是时间, `U` 是时间的单位,并且 `A` 是一个对齐。 对齐将所有更小的值都绕到过去最接近的零. 譬如说, `now-1y/w` 一年前,一周前开始 也可以指定相对时间框架而不调整 : `now-NU`支持的相对时间框架时间单位有:
    -   `m`: 分钟
    -   `h`时间:
    -   `d`天数 :
    -   `w`单位:星期
    -   `M`月数
    -   `y`年数 :

如果不设定,则使用一天的相对时间框架(`now-1d`) (中文(简体) ).

最长时限为31天.

 |
| 配置. last 更新日期 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 若为 `true`,将所生成的一组更新任务过滤到每个类型的最新更新.  
  
**默认 :** `false` |
| 配置. 启动Version | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 按初始版本过滤所产生的一组更新工作( 需要的格式) `<major>.<minor>.<revision>`) (中文(简体) ). |
| 配置. startVersion CompareType | "EQUAL""GREATER""GREATER-EQUAL""LAWER"""LAWER-EQUAL""""""""""""""""" | 

按指定的初始版本过滤所产生的一组更新任务.

在此指定比较运算符 .

 |
| 配置. 目标版本 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 按目标版本过滤所产生的一组更新工作( 需要的格式) `<major>.<minor>.<revision>`) (中文(简体) ). |
| 配置. 目标VersionCompareType | "EQUAL""GREATER""GREATER-EQUAL""LAWER"""LAWER-EQUAL""""""""""""""""" | 

按指定的目标版本过滤所产生的一组更新任务.

在此指定比较运算符 .

 |
| 配置( t) | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

请求更新任务的时间框架结束 .

您可以使用下列格式之一:

-   UTC毫秒内的时间戳.
-   人类可读格式 `2021-01-25T05:57:01.123+01:00`。如果没有指定时区,则使用协调世界时。 您可以使用空间字符代替 `T`。秒和分数是可选的.
-   相对时间,从现在开始。 格式为 `now-NU/A`时 `N` 是时间, `U` 是时间的单位,并且 `A` 是一个对齐。 对齐将所有更小的值都绕到过去最接近的零. 譬如说, `now-1y/w` 一年前,一周前开始 也可以指定相对时间框架而不调整 : `now-NU`支持的相对时间框架时间单位有:
    -   `m`: 分钟
    -   `h`时间:
    -   `d`天数 :
    -   `w`单位:星期
    -   `M`月数
    -   `y`年数 :

如果没有设置,则使用当前时间戳.

 |
| 配置. 更新Type | "SYNTHETIC""ACTIVE GATE""REMOTE PLUGINT""AGENT""Z REMOTE""Z-REMOTE""TIVE""RE""RE"" | 按更新类型过滤所产生的一组更新工作.  
  
**示例** `ACTIVE_GATE` |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [更新全部工作](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejobsall) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.getAllUpdateJobList();
```

### ~获取更新JobByJobIdForAg~

> ⚠️ **折旧**

**活动 Gates 自动更新JobsClient. 获得更新JobByJobIdForAg( 配置): 承诺 <[更新工作](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejob)\> 翻译:**

获取指定的更新任务的参数

**需要以下范围之一:**

-   环境- api: 活动门: 已读
-   机队管理:活动门:已读

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活动门:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. agId\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的 ActiveGate 的标识 . |
| 配置。 任务\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | ActiveGate 更新工作的唯一标识符 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [更新工作](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejob) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 没有找到。 详细情况见反应机构。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.getUpdateJobByJobIdForAg(
    { agId: "...", jobId: "..." },
  );
```

### ~获取更新工作列表ByAgId~

> ⚠️ **折旧**

**活动Gates Autodate JobsClient. 获取 Update JobListByAgId(配置): 保证 <[更新工作列表](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejoblist)\> 翻译:**

为指定的 ActiveGate 更新任务列表

**需要以下范围之一:**

-   环境- api: 活动门: 已读
-   机队管理:活动门:已读

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活动门:已读

任务可以将 ActiveGate 更新到指定的版本或最新的可用版本.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. agId\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的 ActiveGate 的标识 . |
| 配置从 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
请求更新任务的时间框架的开始 .

您可以使用下列格式之一:

-   UTC毫秒内的时间戳.
-   人类可读格式 `2021-01-25T05:57:01.123+01:00`。如果没有指定时区,则使用协调世界时。 您可以使用空间字符代替 `T`。秒和分数是可选的.
-   相对时间,从现在开始。 格式为 `now-NU/A`时 `N` 是时间, `U` 是时间的单位,并且 `A` 是一个对齐。 对齐将所有更小的值都绕到过去最接近的零. 譬如说, `now-1y/w` 一年前,一周前开始 也可以指定相对时间框架而不调整 : `now-NU`支持的相对时间框架时间单位有:
    -   `m`: 分钟
    -   `h`时间:
    -   `d`天数 :
    -   `w`单位:星期
    -   `M`月数
    -   `y`年数 :

如果不设定,则使用一周的相对时限(`now-1w`) (中文(简体) ).

最长时限为31天.

 |
| 配置. last 更新日期 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 若为 `true`,将所生成的一组更新任务过滤到每个类型的最新更新.  
  
**默认 :** `false` |
| 配置. 启动Version | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 按初始版本过滤所产生的一组更新工作( 需要的格式) `<major>.<minor>.<revision>`) (中文(简体) ). |
| 配置. startVersion CompareType | "EQUAL""GREATER""GREATER-EQUAL""LAWER"""LAWER-EQUAL""""""""""""""""" | 

按指定的初始版本过滤所产生的一组更新任务.

在此指定比较运算符 .

 |
| 配置. 目标版本 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 按目标版本过滤所产生的一组更新工作( 需要的格式) `<major>.<minor>.<revision>`) (中文(简体) ). |
| 配置. 目标VersionCompareType | "EQUAL""GREATER""GREATER-EQUAL""LAWER"""LAWER-EQUAL""""""""""""""""" | 

按指定的目标版本过滤所产生的一组更新任务.

在此指定比较运算符 .

 |
| 配置( t) | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

请求更新任务的时间框架结束 .

您可以使用下列格式之一:

-   UTC毫秒内的时间戳.
-   人类可读格式 `2021-01-25T05:57:01.123+01:00`。如果没有指定时区,则使用协调世界时。 您可以使用空间字符代替 `T`。秒和分数是可选的.
-   相对时间,从现在开始。 格式为 `now-NU/A`时 `N` 是时间, `U` 是时间的单位,并且 `A` 是一个对齐。 对齐将所有更小的值都绕到过去最接近的零. 譬如说, `now-1y/w` 一年前,一周前开始 也可以指定相对时间框架而不调整 : `now-NU`支持的相对时间框架时间单位有:
    -   `m`: 分钟
    -   `h`时间:
    -   `d`天数 :
    -   `w`单位:星期
    -   `M`月数
    -   `y`年数 :

如果没有设置,则使用当前时间戳.

 |
| 配置. 更新Type | "SYNTHETIC""ACTIVE GATE""REMOTE PLUGINT""AGENT""Z REMOTE""Z-REMOTE""TIVE""RE""RE"" | 按更新类型过滤所产生的一组更新工作.  
  
**示例** `ACTIVE_GATE` |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [更新工作列表](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejoblist) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 没有找到。 详细情况见反应机构。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.getUpdateJobListByAgId(
    { agId: "..." },
  );
```

### ~验证更新日期JobForAg~

> ⚠️ **折旧**

**活动Gates Autodate JobsClient.validate Update JobForAg(配置):承诺<void>**

验证该装置的有效载荷 `POST /activeGates/{agId}/updateJobs` 请求.

**需要以下范围之一:**

-   环境- api: 活动门: 写入
-   机队管理: 活动门: 写入

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理: 活动门: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. agId\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的 ActiveGate 的标识 . |
| 配置. 身体\*必须 | [更新工作](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-updatejob) |  |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 已验. 提交的更新工作是有效的 。 反应没有尸体. |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 | 失败 。 输入无效 。 QQ 客户端错误。 QQ 服务器端错误 . |

代码示例

```ts
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.validateUpdateJobForAg(
    {
      agId: "...",
      body: { targetVersion: "1.190.0.20200301-130000" },
    },
  );
```

## 活动Gates 客户端

```js
import { activeGatesClient } from '@dynatrace-sdk/client-classic-environment-v2';
```

### ~获取全部动作Gates~

> ⚠️ **折旧**

**活动GatesClient.get AllActiveGates(配置):承诺 <[活动目录](https://npmcn.com/package/%40dynatrace-sdk/client-classic-environment-v2/#readme-activegatelist)\> 翻译:**

列出所有可用的 ActiveGates

**需要以下范围之一:**

-   环境- api: 活动门: 已读
-   机队管理:活动门:已读

**需要下列许可之一:**

-   环境:作用:设定管理
-   机队管理:活动门:已读

反应包括目前与环境相连或在过去两个小时内已经连接的所有ActiveGates. 自1.343版本起折旧. 使用 DQL Smartscape 节点查询 ActiveGate 数据取而代之. 见 [https://dt-url.net/mf03894 (英语)](https://dt-url.net/mf03894)

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 自动更新 | (原始内容存档于2018-10-29) (英语). "ENABLED" QQ "DISABLED" | 通过自动更新的实际状态过滤生成的一组活化Gates. |
| 已配置 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 过滤生成的一组活化Gates到那些在容器中运行的(`true`)或不(`false`) (中文(简体) ). |
| 配置. disabled 模块 | Array <"SYNTHETTION""AWS""AZURE""BEACON FORWARDER"""CLOUD FOUNDRY""DB INSIST"""DEBUGGING""EXTENSIONS V1"""EXTENSIONS V2"""KUBERNETES"""LOGS""MEMORY-DUMPS""""METRICI-API""ONE AGENT-ROWINGT""REST-API"""VMARE""Z-OS""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | 由已禁用模块过滤生成的一组活性Gates. |
| 配置. 已启用模块 | Array <"SYNTHETTION""AWS""AZURE""BEACON FORWARDER"""CLOUD FOUNDRY""DB INSIST"""DEBUGGING""EXTENSIONS V1"""EXTENSIONS V2"""KUBERNETES"""LOGS""MEMORY-DUMPS""""METRICI-API""ONE AGENT-ROWINGT""REST-API"""VMARE""Z-OS""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | 通过启用的模块过滤所生成的一组活动Gates. |
| 配置.fips 模式 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 将结果的一组 ActiveGates 过滤到以 FIPS 模式运行的 `true`)或不(`false`) (中文(简体) ). |
| 配置. 组 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
按组过滤生成的一组活性Gates.

您可以指定一个部分名称。 在这种情况下 `CONTAINS` 使用运算符.

 |
| 配置. hostname | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

以它所运行的主机的名称过滤由此产生的一组活化Gates.

您可以指定一个部分名称。 内

 |

## 常见问题

### @dynatrace-sdk/client-classic-environment-v2 是什么？

Dynatrace 环境 API v2 的客户端

### 如何安装 @dynatrace-sdk/client-classic-environment-v2？

在项目目录运行 npm install @dynatrace-sdk/client-classic-environment-v2，或使用 pnpm add / yarn add / bun add。

### @dynatrace-sdk/client-classic-environment-v2 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dynatrace-sdk/client-classic-environment-v2 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @dynatrace-sdk/client-classic-environment-v2 可以商用吗？

@dynatrace-sdk/client-classic-environment-v2 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dynatrace-sdk/client-classic-environment-v2 的下载量有多少？

根据 npm 官方下载统计，@dynatrace-sdk/client-classic-environment-v2 在 2026/10/13 – 2026/11/11 这 30 天内被下载 15,823 次，日均约 527 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dynatrace-sdk/client-classic-environment-v2 还在维护吗？

最新版本 11\.0\.0 发布于 2026/10/30（14 天前）；至今共发布 48 个版本，其中过去 12 个月发布了 10 个；首次发布于 2022/11/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。