查询操作列表v3
更新时间 2025-10-23 14:52:01
最近更新时间: 2025-10-23 14:52:01
接口功能介绍
- 可用于查询异步操作执行状态及其他相关属性。- 用例：使用创建云电脑接口返回的操作ID，查询创建操作的执行状态，以及新创建云电脑的ID。
接口约束
无
URI
GET /v3/operation/describe
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| version | 否 | String | 操作ID版本。默认值：v1。可能值： - v1 - v2 区分版本方式：有关联操作类型的是v1，没有关联操作类型的是v2。 | v2 | |
| type | 否 | String | 操作类型。当version是v1时必须指定。可能值： - Common：通用型。 - Task：任务型。 | Task | |
| operationIds | 是 | String | 操作ID。取值由至少1个操作ID组成一个JSON数组ID之间用半角逗号（,）隔开。version是v1时，最多支持指定50个操作ID；version是v2时，最多支持1个操作ID。 | [fooId1, fooId2] |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | ||
| list | Array of Objects | 数据列表 | list | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| operationId | String | 操作ID。 | fooId | |
| type | String | 操作类型。仅当version是v1时有意义。可能值： - Common：通用型。 - Task：任务型。 | Task | |
| status | String | 操作状态。可能值： - Succeeded：成功。 - Failed：失败。 - Canceled：已取消。 - InProgress：进行中。 | Succeeded | |
| startTime | String | 操作开始时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2099-09-09T00:00:00Z | |
| endTime | String | 操作结束时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2099-09-09T00:00:00Z | |
| properties | Object | 附加属性。仅当操作成功时返回。 | properties | |
| 表 properties |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resourceId | String | 资源ID。操作关联的资源ID。例如，创建云电脑的操作成功时，为新创建云电脑的ID。 | fooId |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"operationId":"foo",
"type":"Common",
"status":"Succeeded",
"startTime":"2099-09-09T00:00:00Z",
"endTime":"2099-09-09T00:00:00Z",
"properties":{
"resourceId":"XXXXXXXXXXXXX6925"
}
},{
"operationId":"bar",
"type":"Common",
"status":"Succeeded",
"startTime":"2099-09-09T00:00:00Z",
"endTime":"2099-09-09T00:00:00Z",
"properties":{
"resourceId":"XXXXXXXXXXXXX6926"
}
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
