接口功能介绍
查询一条或多条云助手命令在弹性云主机、物理机中执行结果
接口约束
1.弹性云主机、物理机必须处于运行状态；
2.弹性云主机、物理机中必须安装天翼云云助手且服务处于运行状态；
URI
POST /v4/cloud-assistant/describe-invocation-results
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 88f8888888dd88ec888888888d888d8b | |
| commandID | 否 | String | 命令ID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf | |
| invokedID | 否 | String | 命令执行ID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf | |
| pageNo | 否 | Integer | 当前页码，默认值为1 | 1 | |
| pageSize | 否 | Integer | 分页查询时设置的每页行数，最大值为100，默认为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Param is null | |
| description | String | 失败时的错误描述，一般为中文描述 | 请求参数错误 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Object | 命令执行结果集合 | invocation | |
| pageNo | Integer | 当前页码 | 1 | |
| totalCount | Integer | 命令总个数 | 1 | |
| pageSize | Integer | 每页行数 | 10 |
表 invocation
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| invocationStatus | String | 单台云主机的命令运行状态，可能值： Pending：系统正在校验或发送命令； Running：命令正在云主机上运行； Success：命令执行完成，且退出码为0； Failed：命令执行完成，且退出码非0； |
Success | |
| createTime | String | 命令执行创建时间 | 2023-07-31T09:15:55Z | |
| updateTime | String | 命令执行完成时间 | 2023-07-31T09:15:55Z | |
| invokedID | String | 命令执行ID | a6a08d82- 2f89-11ee-a2b7-774dd7c6ebaf | |
| commandID | String | 命令ID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf | |
| instanceID | String | 云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| output | String | 命令执行后的输出信息 | test | |
| exitCode | Integer | 命令退出码 | 0 | |
| errorInfo | String | 命令执行失败原因详情 | ||
| invokeRecordStatus | String | 单个命令执行任务的总状态，取值范围： Pending：未执行，当有云主机中命令状态为Pending，则总的执行状态为未执行； Running：运行中，有云主机中命令进程为运行中，则总的执行状态为运行中； Finished：已完成。所有云主机命令进程全部完成执行； Failed：执行失败，有云主机中命令进程为执行失败，则总的状态为Failed。 |
Finished |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"invokedID": "a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf",
"pageNo": 1,
"pageSize": 10
}
响应示例
{
"returnObj": {
"totalCount": 1,
"pageNo": 1,
"pageSize": 10,
"results": [
{
"updateTime": "2025-02-21T00:45:00+08:00",
"invocationRecordStatus": "Finished",
"invocationStatus": "Success",
"invokedID": "35996ff0-9c5b-457e-9f9d-f5b4336fba13",
"commandID": null,
"errorCode": null,
"instanceID": "b29d96af-1ab8-378e-a07c-98e7675473f6",
"output": "test\n",
"errorInfo": "",
"createTime": "2025-02-21T00:44:57+08:00",
"exitCode": 0
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
