# @dynatrace-sdk/client-automation 中文文档

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

版本：8\.10\.0
npm 元数据更新时间：2026-10-16T09:36:30.148Z
中文译文更新时间：2026-11-13T02:58:27.014Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.1 MB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2023-04-24T03:51:35.430Z
- 最新版本发布：2026-10-16T09:36:29.799Z
- 近 30 天下载量：3505（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：50（近 12 个月 10 个）

## 中文简介

自动化API允许与工作流程和各种触发选项合作.

## 安装

```sh
npm install @dynatrace-sdk/client-automation
```

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

## README

# @ dynatrace- sdk/ 客户端自定义

[![npm](https://img.shields.io/badge/npm-v8.10.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-automation/v/8.10.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

与自动化Engine API管理并运行工作流程.

## 安装

```bash
npm install @dynatrace-sdk/client-automation
```

## 获得帮助

-   访问 [用于打字的 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-automation/)。 。 。 .

## 动作执行

```js
import { actionExecutionsClient } from '@dynatrace-sdk/client-automation';
```

### 获取动作执行

**动作Executions Client.get ActionExecution(配置):承诺 <[动作执行](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-actionexecution)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个UUID字符串识别此动作执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [动作执行](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-actionexecution) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { actionExecutionsClient } from "@dynatrace-sdk/client-automation";

const data =
  await actionExecutionsClient.getActionExecution({
    id: "...",
  });
```

### 获取动作执行日志

**executionsClient.get ActionExecutionLog( config):承诺<\[string\](https://developer.mozila.org/en-US/docs/Glossary/String)>**

**所需范围 :** 自动化:工作流程:已读

返回特定动作的日志输出 .

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个UUID字符串识别此动作执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { actionExecutionsClient } from "@dynatrace-sdk/client-automation";

const data =
  await actionExecutionsClient.getActionExecutionLog({
    id: "...",
  });
```

## 动作SampleResult客户端

```js
import { actionsSampleResultClient } from '@dynatrace-sdk/client-automation';
```

### ~获得行动实例~

> ⚠️ **折旧**

**动作SampleResultClient.get ActionSampleResult( config):承诺<\[任何\](https://www.typescriptlang.org/docs/handbook/2/every-types.html#any)>**

**所需范围 :** 自动化:工作流程:已读

#### 参数

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

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { actionsSampleResultClient } from "@dynatrace-sdk/client-automation";

const data =
  await actionsSampleResultClient.getActionSampleResult({
    actionIdentifier: "...",
  });
```

## 商业卡通

```js
import { businessCalendarsClient } from '@dynatrace-sdk/client-automation';
```

### 创建商务日历

**companyCalendersClient.create BusinessCalendar(配置):承诺 <[商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse)\> 翻译:**

**所需范围 :** 自动化: calendars: write

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [商业算法创造](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarcreate) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse) | 201 (韩语) |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.createBusinessCalendar({
    body: { title: "..." },
  });
```

### 删除商务日历

**商业术语CalendersClient.delete BusinessCalendar(配置):承诺<void>**

**所需范围 :** 自动化: calendars: write

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此业务日历 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.deleteBusinessCalendar({
    id: "...",
  });
```

### 重复商务日历

**calenders Client. 重复商业 Calendar(配置):承诺 <[商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse)\> 翻译:**

**所需范围 :** 自动化: calendars: write

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [重复请求](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-duplicationrequest) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此业务日历 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse) | 201 (韩语) |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

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

### 获取商务日历

**calendars Client.get BusinessCalendar(配置):承诺 <[商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse)\> 翻译:**

**所需范围 :** 自动化: 日历: 已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此业务日历 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.getBusinessCalendar({
    id: "...",
  });
```

### 获取商务记录历史

**商业交易中心.get 商业交易历史记录(配置):承诺 <[商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse)\> 翻译:**

**所需范围 :** 自动化: 日历: 已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此业务日历 . |
| 配置. version\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 模式 : `^[\d]+$` |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.getBusinessCalendarHistoryRecord(
    { id: "...", version: "..." },
  );
```

### 获取商务记录历史记录

**商业交易中心.getBusinessCalendar历史记录(配置):承诺 <[标注 变化历史](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedchangehistory)\> 翻译:**

**所需范围 :** 自动化: 日历: 已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 全部配置 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 当作假时,最新的历史记录不会被退回.  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此业务日历 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [标注 变化历史](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedchangehistory) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.getBusinessCalendarHistoryRecords(
    { id: "..." },
  );
```

### 获取商务算法

**calendarsClient.get BusinessCalendars(配置):承诺 <[分层商业响应列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedbusinesscalendarresponselist)\> 翻译:**

**所需范围 :** 自动化: 日历: 已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.限制 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 每页返回的结果数量. |
| 配置。 关闭 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 初始指数用来返回结果. |
| 配置. 顺序 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 命令结果时要使用哪个字段 . |
| 配置. 搜索 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个搜索术语. |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [分层商业响应列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedbusinesscalendarresponselist) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.getBusinessCalendars();
```

### 补丁商务日历

**商业交易中心.patch BusinessCalendar(配置):承诺 <[商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse)\> 翻译:**

**所需范围 :** 自动化: calendars: write

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [商业分类更新](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarupdate) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此业务日历 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

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

### 恢复商业分类历史记录

**calendarsClient.restore BusinessCalendarHistory Record(配置):承诺<void>**

**所需范围 :** 自动化: calendars: write

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此业务日历 . |
| 配置. version\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 模式 : `^[\d]+$` |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.restoreBusinessCalendarHistoryRecord(
    { id: "...", version: "..." },
  );
```

### 更新商务日历

**商业交易中心( Calendars).update BusinessCalendar(配置):承诺 <[商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse)\> 翻译:**

**所需范围 :** 自动化: calendars: write

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [商业分类更新](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarupdate) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此业务日历 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [商业平衡对策](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-businesscalendarresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

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

## 触发事件

```js
import { eventTriggersClient } from '@dynatrace-sdk/client-automation';
```

### ~预览筛选~

> ⚠️ **折旧**

**事件 Triggers Client. previewFilter( 配置): 保证 <[事件 Trigger 预览回复](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-eventtriggerpreviewresponse)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [事件调试器预览请求](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-eventtriggerpreviewrequest) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [事件 Trigger 预览回复](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-eventtriggerpreviewresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { eventTriggersClient } from "@dynatrace-sdk/client-automation";

const data = await eventTriggersClient.previewFilter({
  body: {
    triggerConfiguration: {
      type: "event",
      value: { query: "..." },
    },
  },
});
```

## 处决

```js
import { executionsClient } from '@dynatrace-sdk/client-automation';
```

### 取消执行

**execution( 配置): 保证< 无效>**

**所需范围 :** 自动化:工作流程:运行

试图取消处决. 只有在处决处于活跃状态时才能进行.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串可以识别此执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.cancelExecution({
  id: "...",
});
```

### 取消任务执行

**execution( 配置): 保证< 无效>**

**所需范围 :** 自动化:工作流程:运行

取消任务执行 . 取消处决行动导致任务被取消 导致工作流程被取消 .

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置. 执行Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 任务名称 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.cancelTaskExecution({
  executionId: "...",
  id: "...",
});
```

### 获取全部事件日志

**执行 Client. get AllEventLogs( 配置): 保证 <[事件日志](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-eventlogs)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

获取全部事件日志

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串可以识别此执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [事件日志](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-eventlogs) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getAllEventLogs({
  id: "...",
});
```

### 获取执行

**execution( 配置): 许诺 <[执行](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-execution)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

获得执行

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串可以识别此执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [执行](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-execution) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getExecution({
  id: "...",
});
```

### 获取执行动作

**execution Actions(配置):承诺 <Array < \[string\](https://developer.mozila.org/en-US/docs/Glossary/String) \***

**所需范围 :** 自动化:工作流程:已读

返回指定执行中指派任务的行动列表 .

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串可以识别此执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getExecutionActions({
  id: "...",
});
```

### 获取执行日志

**executionLog(配置):承诺<\[字符串\](https://developer.mozila.org/en-US/docs/Glossary/String)>**

**所需范围 :** 自动化:工作流程:已读

获取执行日志

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串可以识别此执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getExecutionLog({
  id: "...",
});
```

### 获取执行

**executions( 配置): 承诺 <[分解列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedexecutionlist)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

获得处决名单(草稿的执行和简单的工作流程没有包括在答复中).

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.限制 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 每页返回的结果数量. |
| 配置。 关闭 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 初始指数用来返回结果. |
| 配置. 顺序 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 命令结果时要使用哪个字段 . |
| 配置。 外观 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置. parentWorkflow | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置. 排程 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 多个值可以通过逗号来分隔. |
| 配置. 搜索 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个搜索术语. |
| 配置. 已启动 AtGte | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置. 已启动 AtLte | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置. 状态 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 多个值可以通过逗号来分隔. |
| 配置. subworkflow of Task | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 过滤执行 `parentExecution/task`。 。 。 . |
| 配置 触发 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置. triggerType | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置用户 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 多个值可以通过逗号来分隔. |
| 配置. 工作流程 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 多个值可以通过逗号来分隔. |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [分解列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedexecutionlist) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getExecutions();
```

### 获取任务执行

**executive( 配置): 保证 <[任务执行](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-taskexecution)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置. 执行Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 任务名称 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [任务执行](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-taskexecution) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getTaskExecution({
  executionId: "...",
  id: "...",
});
```

### 获得任务输出

**expert Client.getTaskExecution Input(config):承诺<\[任何\](https://www.typescriptlang.org/docs/handbook/2/ everyday-types.html#any)>**

**所需范围 :** 自动化:工作流程:已读

返回属于 TaskExecution 的所有动作Execution 的合并输入 .

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置. 执行Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 任务名称 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getTaskExecutionInput({
  executionId: "...",
  id: "...",
});
```

### 获取任务执行日志

**getTaskExecutionLog(配置):承诺 < \[string\](https://developer.mozila.org/en-US/docs/Glossary/String)>**

**所需范围 :** 自动化:工作流程:已读

返回特定任务的日志输出 . 这可能是大 因为它的 STDOUT 行动 由用户定义.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置. 执行Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 任务名称 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getTaskExecutionLog({
  executionId: "...",
  id: "...",
});
```

### 获得任务执行结果

**expective.getTaskExecution Result(config):承诺<\[任何\](https://www.typescriptlang.org/docs/handbook/2/ everyday-types.html#any)> (中文(简体) )**

**所需范围 :** 自动化:工作流程:已读

属于 TaskExecution 的所有动作执行器的返回合并结果 .

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置. 执行Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 任务名称 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getTaskExecutionResult({
  executionId: "...",
  id: "...",
});
```

### 获取任务执行

**expecutions( 配置): 保证 <[任务执行](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-taskexecutions)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置. 执行Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [任务执行](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-taskexecutions) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getTaskExecutions({
  executionId: "...",
});
```

### 获取过渡

**执行 Client. get Transitions( 配置): 保证 <[任务转换](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-tasktransitions)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置. 执行Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [任务转换](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-tasktransitions) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getTransitions({
  executionId: "...",
});
```

### 暂停执行

**execution(配置):承诺<void>**

**所需范围 :** 自动化:工作流程:运行

暂停处决. 只有在处决处于活跃状态时才能进行.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串可以识别此执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.pauseExecution({
  id: "...",
});
```

### 恢复执行

**executive( 配置): 保证< 无效>**

**所需范围 :** 自动化:工作流程:运行

恢复处决. 只有执行处于不活动状态时才能完成.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串可以识别此执行 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.resumeExecution({
  id: "...",
});
```

## 调度

```js
import { schedulesClient } from '@dynatrace-sdk/client-automation';
```

### 获取国家

**附表Client.getCountries(配置):承诺 <[国家列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-countrylist)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

返回可用于查看节假日日历的国家列表

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [国家列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-countrylist) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulesClient.getCountries();
```

### 获取 Holiday 日历

**expressClient.getHolidayCalendar(配置):承诺 <[假日日历列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-holidaycalendarlist)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置从 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 从ISO格式的日期开始 |
| 配置. key\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 国名 |
| 配置( t) | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 迄今采用ISO格式 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [假日日历列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-holidaycalendarlist) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulesClient.getHolidayCalendar({
  key: "...",
});
```

### 获取时区

**extableClient.getTimezones(配置):承诺 < Array < \[string\](https://developer.mozila.org/en-US/docs/Glossary/String) \***

**所需范围 :** 自动化:工作流程:已读

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulesClient.getTimezones();
```

### ~预览附表~

> ⚠️ **折旧**

**附表 Client.preview 附表(配置):承诺 <[排程审查回复](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-schedulepreviewresponse)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [排程审查请求](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-schedulepreviewrequest) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [排程审查回复](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-schedulepreviewresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulesClient.previewSchedule({
  body: {
    schedule: {
      trigger: { type: "cron", cron: "0 0 * * *" },
    },
  },
});
```

## 调度规则

```js
import { schedulingRulesClient } from '@dynatrace-sdk/client-automation';
```

### 创建规则

**调度规则Client.create Rules(配置):承诺 <[规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule)\> 翻译:**

**所需范围 :** 自动化: 规则: 写入

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [规则创建](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rulecreate) |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule) | 201 (韩语) |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.createRule({
  body: { title: "...", ruleType: "rrule" },
});
```

### 删除规则

**排程规则Client.delate Rule(配置):承诺<void>**

**所需范围 :** 自动化: 规则: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串表示此规则 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.deleteRule({
  id: "...",
});
```

### 复制规则

**排程规则 Client. 复制规则(配置):承诺 <[规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule)\> 翻译:**

**所需范围 :** 自动化: 规则: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [重复请求](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-duplicationrequest) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串表示此规则 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule) | 201 (韩语) |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

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

### 获取规则

**排程规则Client.get Rule(配置):承诺 <[规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule)\> 翻译:**

**所需范围 :** 自动化:规则:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串表示此规则 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.getRule({
  id: "...",
});
```

### 获取规则历史记录

**排程规则Client.get RuleHistory Record(配置):承诺 <[规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule)\> 翻译:**

**所需范围 :** 自动化:规则:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串表示此规则 . |
| 配置. version\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 模式 : `^[\d]+$` |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data =
  await schedulingRulesClient.getRuleHistoryRecord({
    id: "...",
    version: "...",
  });
```

### 获取规则历史记录

**排程规则Client.get RulesHistory Records(配置):承诺 <[标注 变化历史](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedchangehistory)\> 翻译:**

**所需范围 :** 自动化:规则:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 全部配置 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 当作假时,最新的历史记录不会被退回.  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串表示此规则 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [标注 变化历史](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedchangehistory) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data =
  await schedulingRulesClient.getRuleHistoryRecords({
    id: "...",
  });
```

### 获取规则

**调度规则Client.get Rules(配置):承诺 <[平面规则列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedrulelist)\> 翻译:**

**所需范围 :** 自动化:规则:已读

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.限制 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 每页返回的结果数量. |
| 配置。 关闭 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 初始指数用来返回结果. |
| 配置. 顺序 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 命令结果时要使用哪个字段 . |
| 配置. 搜索 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个搜索术语. |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [平面规则列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-paginatedrulelist) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.getRules();
```

### 补丁规则

**调度规则Client.patch Rule(配置):承诺 <[规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule)\> 翻译:**

**所需范围 :** 自动化: 规则: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [规则更新](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-ruleupdate) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串表示此规则 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

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

### ~预览规则~

> ⚠️ **折旧**

**调度规则 Client. preview Rules( 配置): 承诺 <[规则审查回复](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rulepreviewresponse)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | 规则审查创建 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [规则审查回复](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rulepreviewresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.previewRule({
  body: {
    ruleType: "rrule",
    rrule: { freq: "YEARLY", datestart: "..." },
  },
});
```

### 恢复规则历史记录

**排程规则Client.restore RuleHistory Record(配置):承诺<void>**

**所需范围 :** 自动化: 规则: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串表示此规则 . |
| 配置. version\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 模式 : `^[\d]+$` |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data =
  await schedulingRulesClient.restoreRuleHistoryRecord({
    id: "...",
    version: "...",
  });
```

### 更新规则

**排程规则Client.update Rules(配置):承诺 <[规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule)\> 翻译:**

**所需范围 :** 自动化: 规则: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [规则更新](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-ruleupdate) |  |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串表示此规则 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [规则](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-rule) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

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

## 设置

```js
import { settingsClient } from '@dynatrace-sdk/client-automation';
```

### ~获取服务用户~

> ⚠️ **折旧**

**设置 Client. get Service Users( 配置): 保证 <[获取服务用户响应](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-getserviceusersresponse)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

获取可用作工作流程演员的服务用户( 已贬值) .

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.getServiceUsers();
```

### ~获取设置~

> ⚠️ **折旧**

**设置 Client.getSettings( 配置): 保证 <[获取定居响应](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-getsettingsresponse)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

获取系统设置

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [获取定居响应](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-getsettingsresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.getSettings();
```

### ~用户许可~

> ⚠️ **折旧**

**设置 Client.getUserPermissions(配置):承诺 < Array < \[string\](https://developer.mozila.org/en-US/docs/Glossary/String)**

**所需范围 :** 自动化:工作流程:已读

获取当前用户有效权限 .

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.getUserPermissions();
```

### ~获取用户设置~

> ⚠️ **折旧**

**设置 Client. get UserSettings( 配置): 保证 <[用户设置](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-usersettings)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

获取用户特定设置

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [用户设置](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-usersettings) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.getUserSettings();
```

### ~更新授权~

> ⚠️ **折旧**

**设置 Client.update Authorizations( 配置): 保证<void>**

**所需范围 :** 自动化:工作流程:已读

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 202 (韩语) | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.updateAuthorizations();
```

## 版本客户端

```js
import { versionClient } from '@dynatrace-sdk/client-automation';
```

### 获取版本

**版本Client.getVersion(配置):承诺 <[版本响应](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-versionresponse)\> 翻译:**

**所需范围 :** 自动化:工作流程:已读

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [版本响应](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-versionresponse) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { versionClient } from "@dynatrace-sdk/client-automation";

const data = await versionClient.getVersion();
```

## 网约车

```js
import { webhookHandlersClient } from '@dynatrace-sdk/client-automation';
```

### 删除Webhook汉德勒

**webhookHandlers Client.deleteWebhookHandler(配置):承诺<void> 页面存档备份,存于互联网档案馆 互联网档案馆的存檔,存档日期2011-12-22**

**所需范围 :** 自动化: webhookhandlers: write :

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 连接Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 此 Webhook 处理器所属的连接的ID |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { webhookHandlersClient } from "@dynatrace-sdk/client-automation";

const data =
  await webhookHandlersClient.deleteWebhookHandler({
    connectionId: "...",
  });
```

### 获得韦布克汉德勒

**webhookHandlersClient.getWebhookHandler(配置):承诺 <[韦伯霍克汉德勒](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-webhookhandler)\> 翻译:**

**所需范围 :** 自动化:webhookhandlers: read

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 连接Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 此 Webhook 处理器所属的连接的ID |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [韦伯霍克汉德勒](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-webhookhandler) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { webhookHandlersClient } from "@dynatrace-sdk/client-automation";

const data = await webhookHandlersClient.getWebhookHandler({
  connectionId: "...",
});
```

### 获取WebhookHandlers 软件

**webhookHandlers Client.getWebhookHandlers(配置):保证<Array>[网络汉字列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-webhookhandlerlist)\>>**

**所需范围 :** 自动化:webhookhandlers: read

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [网络汉字列表](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-webhookhandlerlist) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { webhookHandlersClient } from "@dynatrace-sdk/client-automation";

const data =
  await webhookHandlersClient.getWebhookHandlers();
```

### 写出WebhookHandler

**webhook Handlers Client.write WebhookHandler(配置): 承诺 <[韦伯霍克汉德勒](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-webhookhandler)\> 翻译:**

**所需范围 :** 自动化: webhookhandlers: write :

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [韦伯霍克汉德勒 Write](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-webhookhandlerwrite) |  |
| 配置. 连接Id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 此 Webhook 处理器所属的连接的ID |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [韦伯霍克汉德勒](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-webhookhandler) | 200个 |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { webhookHandlersClient } from "@dynatrace-sdk/client-automation";

const data =
  await webhookHandlersClient.writeWebhookHandler({
    connectionId: "...",
    body: {
      active: false,
      validationMethod: "slack",
      eventSignatureHeader: "...",
    },
  });
```

## 工作流程

```js
import { workflowsClient } from '@dynatrace-sdk/client-automation';
```

### 创建工作流程

**工作流程 Client.createWorkflow(配置):承诺 <[工作流程](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-workflow)\> 翻译:**

**所需范围 :** 自动化: 工作流程: 写入

创建工作流程并设定用法

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置. 身体\*必须 | [工作流程创造](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-workflowcreate) |  |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [工作流程](https://npmcn.com/package/%40dynatrace-sdk/client-automation/#readme-workflow) | 201 (韩语) |  |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { workflowsClient } from "@dynatrace-sdk/client-automation";

const data = await workflowsClient.createWorkflow({
  body: { title: "...", throttle: { isLimitHit: false } },
});
```

### 删除已崩溃的工作流程

**工作流程 Client.delateTrashedWorkflow(配置):承诺<void>**

**所需范围 :** 自动化: 工作流程: 写入

永久删除垃圾堆中的工作流程 。 如果工作流程不存在或没有在垃圾桶中,则返回 404 .

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此工作流程 . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 204 (韩语) | 无反应机构 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 信封错误 |  |

代码示例

```ts
import { workflowsClient } from "@dynatrace-sdk/client-automation";

const data = await workflowsClient.deleteTrashedWorkflow({
  id: "...",
});
```

### 删除工作流程

**工作流程Client.delateWorkflow(配置):承诺<void>**

**所需范围 :** 自动化: 工作流程: 写入

将工作流程移动到垃圾堆( N)`trash=true`)或永久删除(`trash=false` 或省略)。 中断的工作流程可以通过 `/trash/workflows/{id}`。 。 。 .

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.admin 访问 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 允许访问所有工作流程/执行----额外要求 **自动化:工作流程:admin**  
  
**默认 :** `false` |
| 配置.id\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 一个 UUID 字符串来识别此工作流程 . |
| 配置. 废物 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 何时 `true`,将工作流程移动到垃圾堆中,而不是永久删除。 重复的工作流程是 |

## 常见问题

### @dynatrace-sdk/client-automation 是什么？

自动化API允许与工作流程和各种触发选项合作\.

### 如何安装 @dynatrace-sdk/client-automation？

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

### @dynatrace-sdk/client-automation 支持 TypeScript 吗？

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

### @dynatrace-sdk/client-automation 支持 ESM 还是 CommonJS？

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

### @dynatrace-sdk/client-automation 可以商用吗？

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

### @dynatrace-sdk/client-automation 的下载量有多少？

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

### @dynatrace-sdk/client-automation 还在维护吗？

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