Skip to content

Commit

Permalink
perf: 提供步骤详情与步骤执行结果查询的APIGW接口 TencentBlueKing#2596
Browse files Browse the repository at this point in the history 
接口文档增加字段是否存在的说明
  • Loading branch information
@jsonwan
jsonwan committed Nov 25, 2023
1 parent f4ced33 commit 1b11121
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 108 deletions.
150 changes: 75 additions & 75 deletions docs/apidoc/bk-api-gateway/v3/zh/get_step_instance_detail.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,114 +143,114 @@
```
### 返回结果说明

| 字段 | 类型 | 描述 |
|-----------|-----------|-----------|
| result | bool | 请求成功与否。true:请求成功；false请求失败 |
| code | int | 错误编码。 0表示success，>0表示失败错误 |
| message | string | 请求失败返回的错误信息|
| data | object | 请求返回的数据|
| permission | object | 权限信息|
| 字段 | 类型 | 是否一定存在 | 描述 |
|--------------|--------|------------|-------------------------------|
| result | bool | 是 |请求成功与否。true:请求成功；false请求失败 |
| code | int | 是 |错误编码。 0表示success，>0表示失败错误 |
| message | string | 是 |请求失败返回的错误信息|
| data | object | 否 |请求返回的数据|
| permission | object | 否 |权限信息|

##### data

| 字段 | 类型 | 描述 |
|----------------------|-----------|-----------|
| id | long | 作业步骤ID |
| name | string | 步骤名称 |
| type | int | 步骤类型：1-脚本，2-文件，3-人工确认 |
| script_info | object | 脚本步骤信息 |
| file_info | object | 文件步骤信息 |
| approval_info | object | 审批步骤信息 |
| 字段 | 类型 | 是否一定存在 |描述 |
|----------------------|-----------|------------|-----------|
| id | long | 是 | 作业步骤ID |
| name | string | 是 | 步骤名称 |
| type | int | 是 | 步骤类型：1-脚本，2-文件，3-人工确认 |
| script_info | object | 否 | 脚本步骤信息 |
| file_info | object | 否 | 文件步骤信息 |
| approval_info | object | 否 | 审批步骤信息 |


##### script_info

| 字段 | 类型 | 描述 |
|--------------------|-----------|-----------|
| script_type | int | 脚本类型：1-本地脚本，2-引用业务脚本，3-引用公共脚本 |
| script_id | string | 脚本ID |
| script_version_id | long | 脚本版本ID |
| script_content | string | 脚本内容 |
| script_language | int | 脚本语言：1-shell，2-bat，3-perl，4-python，5-powershell，6-sql |
| script_param | string | 脚本参数 |
| script_timeout | int | 脚本超时时间，单位为秒 |
| account | object | 执行账号，详情见account对象定义 |
| server | object | 执行目标机器，详情见server对象定义 |
| is_param_sensitive | int | 参数是否为敏感参数：0-不敏感，1-敏感 |
| is_ignore_error | int | 是否忽略错误：0-不忽略，1-忽略 |
| 字段 | 类型 | 是否一定存在 | 描述 |
|--------------------|-----------|------------|-----------|
| script_type | int | 是 | 脚本类型：1-本地脚本，2-引用业务脚本，3-引用公共脚本 |
| script_id | string | 否 | 脚本ID |
| script_version_id | long | 否 | 脚本版本ID |
| script_content | string | 否 | 脚本内容 |
| script_language | int | 是 | 脚本语言：1-shell，2-bat，3-perl，4-python，5-powershell，6-sql |
| script_param | string | 是 | 脚本参数 |
| script_timeout | int | 是 | 脚本超时时间，单位为秒 |
| account | object | 是 | 执行账号，详情见account对象定义 |
| server | object | 是 | 执行目标机器，详情见server对象定义 |
| is_param_sensitive | int | 是 | 参数是否为敏感参数：0-不敏感，1-敏感 |
| is_ignore_error | int | 是 | 是否忽略错误：0-不忽略，1-忽略 |

##### account

| 字段 | 类型 | 描述 |
|--------------------|-----------|-----------|
| id | long | 账号ID |
| name | string | 账号名称 |
| 字段 | 类型 | 是否一定存在 | 描述 |
|--------------------|-----------|------------|-----------|
| id | long | 是 | 账号ID |
| name | string | 否 | 账号名称 |

##### server

| 字段 | 类型 | 描述 |
|----------------------|----------------------|-----------|
| variable | string | 引用的全局变量名称 |
| ip_list | list<host> | 主机列表，元素详情见host对象定义 |
| topo_node_list | list<topo_node> | 拓扑节点列表，元素详情见topo_node对象定义 |
| dynamic_group_list | list<dynamic_group> | 动态分组列表，元素详情见dynamic_group对象定义 |
| 字段 | 类型 | 是否一定存在 | 描述 |
|----------------------|----------------------|------------|-----------|
| variable | string | 否 | 引用的全局变量名称 |
| ip_list | list<host> | 否 | 主机列表，元素详情见host对象定义 |
| topo_node_list | list<topo_node> | 否 | 拓扑节点列表，元素详情见topo_node对象定义 |
| dynamic_group_list | list<dynamic_group> | 否 | 动态分组列表，元素详情见dynamic_group对象定义 |

##### host

| 字段 | 类型 | 描述 |
|-------------|-----------|-----------|
| bk_host_id | long | 主机ID |
| bk_cloud_id | long | 管控区域ID |
| ip | string | IP |
| ipv6 | string | IPv6 |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-------------|-----------|------------|-----------|
| bk_host_id | long | 是 | 主机ID |
| bk_cloud_id | long | 否 | 管控区域ID |
| ip | string | 否 | IP |
| ipv6 | string | 否 | IPv6 |

##### topo_node

| 字段 | 类型 | 描述 |
|-------------|-----------|-----------|
| node_type | string | 动态topo节点类型，对应CMDB API中的 bk_obj_id，例如module、set等 |
| id | int | 动态topo节点ID，对应CMDB API中的 bk_inst_id |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-------------|-----------|------------|-----------|
| node_type | string | 是 | 动态topo节点类型，对应CMDB API中的 bk_obj_id，例如module、set等 |
| id | int | 是 | 动态topo节点ID，对应CMDB API中的 bk_inst_id |

##### dynamic_group

| 字段 | 类型 | 描述 |
|-------------|-----------|---------------|
| id | string | CMDB动态分组ID |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-------------|-----------|------------|---------------|
| id | string | 是 | CMDB动态分组ID |


##### file_info

| 字段 | 类型 | 描述 |
|-------------------------|-------------------|-----------|
| file_source_list | list<file_source> | 源文件列表，元素详情见file_source对象定义 |
| file_destination | object | 目标信息，详情见file_destination对象定义 |
| timeout | int | 超时，单位为秒 |
| source_speed_limit | int | 上传文件限速，单位为MB/s，没有值表示不限速 |
| destination_speed_limit | int | 下载文件限速，单位为MB/s，没有值表示不限速 |
| transfer_mode | int | 传输模式： 1-严谨模式，2-强制模式，3-安全模式 |
| is_ignore_error | int | 是否忽略错误：0-不忽略，1-忽略 |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-------------------------|-------------------|------------|-----------|
| file_source_list | list<file_source> | 是 | 源文件列表，元素详情见file_source对象定义 |
| file_destination | object | 是 | 目标信息，详情见file_destination对象定义 |
| timeout | int | 是 | 超时，单位为秒 |
| source_speed_limit | int | 否 | 上传文件限速，单位为MB/s，没有值表示不限速 |
| destination_speed_limit | int | 否 | 下载文件限速，单位为MB/s，没有值表示不限速 |
| transfer_mode | int | 是 | 传输模式： 1-严谨模式，2-强制模式，3-安全模式 |
| is_ignore_error | int | 是 | 是否忽略错误：0-不忽略，1-忽略 |

##### file_source

| 字段 | 类型 | 描述 |
|-------------------|--------------|-----------|
| file_type | int | 文件类型：1-服务器文件，2-本地文件，3-文件源文件 |
| file_list | list<string> | 文件路径列表 |
| server | object | 源文件所在机器，详情见server对象定义 |
| account | object | 执行账号，详情见account对象定义 |
| file_source_id | long | 第三方文件源ID |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-------------------|--------------|------------|-----------|
| file_type | int | 是 | 文件类型：1-服务器文件，2-本地文件，3-文件源文件 |
| file_list | list<string> | 是 | 文件路径列表 |
| server | object | 否 | 源文件所在机器，详情见server对象定义 |
| account | object | 是 | 执行账号，详情见account对象定义 |
| file_source_id | long | 否 | 第三方文件源ID |

##### file_destination

| 字段 | 类型 | 描述 |
|-----------------|-----------|-----------|
| path | string | 目标路径 |
| account | object | 执行账号，详情见account对象定义 |
| server | object | 分发目标机器，详情见server对象定义 |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-----------------|-----------|------------|-----------|
| path | string | 是 | 目标路径 |
| account | object | 是 | 执行账号，详情见account对象定义 |
| server | object | 是 | 分发目标机器，详情见server对象定义 |


##### approval_info

| 字段 | 类型 | 描述 |
|-------------------|-----------|-----------|
| approval_message | string | 确认消息 |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-------------------|-----------|------------|-----------|
| approval_message | string | 是 | 确认消息 |
66 changes: 33 additions & 33 deletions docs/apidoc/bk-api-gateway/v3/zh/get_step_instance_status.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,43 +89,43 @@
```
### 返回结果说明

| 字段 | 类型 | 描述 |
|-----------|-----------|-----------|
| result | bool | 请求成功与否。true:请求成功；false请求失败 |
| code | int | 错误编码。 0表示success，>0表示失败错误 |
| message | string | 请求失败返回的错误信息|
| data | object | 请求返回的数据|
| permission | object | 权限信息|
| 字段 | 类型 | 是否一定存在 | 描述 |
|--------------|--------|------------|-----------|
| result | bool | 是 | 请求成功与否。true:请求成功；false请求失败 |
| code | int | 是 | 错误编码。 0表示success，>0表示失败错误 |
| message | string | 是 | 请求失败返回的错误信息|
| data | object | 否 | 请求返回的数据|
| permission | object | 否 | 权限信息|

##### data

| 字段 | 类型 | 描述 |
|-----------------------|--------------------------|-----------|
| step_instance_id | long | 作业步骤实例ID |
| execute_count | int | 步骤重试次数 |
| name | string | 步骤名称 |
| type | int | 步骤类型：1-脚本步骤；2-文件步骤；4-SQL步骤 |
| status | int | 作业步骤状态码: 1-未执行，2-正在执行，3-执行成功，4-执行失败，5-跳过，6-忽略错误，7-等待用户，8-手动结束，9-状态异常，10-步骤强制终止中，11-步骤强制终止成功，12-步骤强制终止失败 |
| create_time | long | 作业步骤实例创建时间，Unix时间戳，单位毫秒 |
| start_time | long | 开始执行时间，Unix时间戳，单位毫秒 |
| end_time | long | 执行结束时间，Unix时间戳，单位毫秒 |
| total_time | int | 总耗时，单位毫秒 |
| step_host_result_list | list<step_host_result> | 每个主机的任务执行结果，定义见step_host_result |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-----------------------|--------------------------|------------|-----------|
| step_instance_id | long | 是 | 作业步骤实例ID |
| execute_count | int | 是 | 步骤重试次数 |
| name | string | 是 | 步骤名称 |
| type | int | 是 | 步骤类型：1-脚本步骤；2-文件步骤；4-SQL步骤 |
| status | int | 是 | 作业步骤状态码: 1-未执行，2-正在执行，3-执行成功，4-执行失败，5-跳过，6-忽略错误，7-等待用户，8-手动结束，9-状态异常，10-步骤强制终止中，11-步骤强制终止成功，12-步骤强制终止失败 |
| create_time | long | 是 | 作业步骤实例创建时间，Unix时间戳，单位毫秒 |
| start_time | long | 是 | 开始执行时间，Unix时间戳，单位毫秒 |
| end_time | long | 是 | 执行结束时间，Unix时间戳，单位毫秒 |
| total_time | int | 是 | 总耗时，单位毫秒 |
| step_host_result_list | list<step_host_result> | 是 | 每个主机的任务执行结果，定义见step_host_result |


##### step_host_result

| 字段 | 类型 | 描述 |
|-------------|-----------|-----------|
| bk_host_id | long | 主机ID |
| ip | string | IP |
| ipv6 | string | IPv6 |
| bk_cloud_id | long | 管控区域ID |
| status | int | 任务状态：0-未知错误，1-Agent异常，2-无效主机，3-上次已成功，5-等待执行，7-正在执行，9-执行成功，11-执行失败，12-任务下发失败，13-任务超时，15-任务日志错误，16-GSE脚本日志超时，17-GSE文件日志超时，101-脚本执行失败，102-脚本执行超时，103-脚本执行被终止，104-脚本返回码非零，202-文件传输失败，203-源文件不存在，301-文件任务系统错误-未分类的，303-文件任务超时，310-Agent异常，311-用户名不存在，312-用户密码错误，320-文件获取失败，321-文件超出限制，329-文件传输错误，399-任务执行出错，403-任务强制终止成功，404-任务强制终止失败，500-未知状态 |
| status_desc | string | 任务状态描述 |
| tag | string | 用户通过job_success/job_fail函数模板自定义输出的结果。仅脚本任务存在该参数 |
| group_key | string | 基于status与tag字段的分组键，仅用于调用方验证分组内数据数量是否正确，请勿强依赖该字段 |
| exit_code | int | 脚本任务exit code |
| start_time | long | 开始执行时间，Unix时间戳，单位毫秒 |
| end_time | long | 执行结束时间，Unix时间戳，单位毫秒 |
| total_time | int | 总耗时，单位毫秒 |
| 字段 | 类型 | 是否一定存在 | 描述 |
|-------------|-----------|------------|-----------|
| bk_host_id | long | 是 | 主机ID |
| ip | string | 否 | IP |
| ipv6 | string | 否 | IPv6 |
| bk_cloud_id | long | 否 | 管控区域ID |
| status | int | 是 | 任务状态：0-未知错误，1-Agent异常，2-无效主机，3-上次已成功，5-等待执行，7-正在执行，9-执行成功，11-执行失败，12-任务下发失败，13-任务超时，15-任务日志错误，16-GSE脚本日志超时，17-GSE文件日志超时，101-脚本执行失败，102-脚本执行超时，103-脚本执行被终止，104-脚本返回码非零，202-文件传输失败，203-源文件不存在，301-文件任务系统错误-未分类的，303-文件任务超时，310-Agent异常，311-用户名不存在，312-用户密码错误，320-文件获取失败，321-文件超出限制，329-文件传输错误，399-任务执行出错，403-任务强制终止成功，404-任务强制终止失败，500-未知状态 |
| status_desc | string | 是 | 任务状态描述 |
| tag | string | 否 | 用户通过job_success/job_fail函数模板自定义输出的结果。仅脚本任务存在该参数 |
| group_key | string | 否 | 基于status与tag字段的分组键，仅用于调用方验证分组内数据数量是否正确，请勿强依赖该字段 |
| exit_code | int | 否 | 脚本任务exit code |
| start_time | long | 是 | 开始执行时间，Unix时间戳，单位毫秒 |
| end_time | long | 是 | 执行结束时间，Unix时间戳，单位毫秒 |
| total_time | int | 是 | 总耗时，单位毫秒 |

0 comments on commit 1b11121

Please sign in to comment.