查詢操作列表v3
更新時間 2024-06-04 11:14:01
最近更新時間: 2024-06-04 11:14:01
分享文章
接口功能介紹
- 可用于查詢異步操作執行狀態及其他相關屬性。- 用例：使用創建云電腦接口返回的操作ID，查詢創建操作的執行狀態，以及新創建云電腦的ID。
接口約束
無
URI
GET /v3/operation/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| type | 是 | String | 操作類型。枚舉值范圍：Common-通用型;Task-任務型。 | Common | |
| operationIds | 是 | String | 操作ID。取值由至少1個操作ID組成一個JSON數組，最多支持50個ID，ID之間用半角逗號（,）隔開。 | %5B%22df2cbe6d4226e97c4da214389150a055%22%5D |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ECPC_1025 | |
| message | String | 提示信息。 | ok | |
| returnObj | Object | 返回數據對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Long | 總記錄數 | 1 | |
| list | Array of Objects | 數據列表 | list |
表 list
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| operationId | String | 操作ID。 | df2cbe6d4226e97c4da214389150a055 | |
| type | String | 操作類型。枚舉值范圍：Common-通用型;Task-任務型。 | Common | |
| status | String | 操作狀態。枚舉值范圍：Succeeded-成功;Failed-失敗;Canceled-已取消;InProgress-進行中。 | Succeeded | |
| startTime | String | 操作開始時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | 2023-10-11T07:01:10Z | |
| endTime | String | 操作結束時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | 2023-10-11T07:03:46Z | |
| properties | Object | 附加屬性。僅當操作成功時返回。 | D0023101101183560 | properties |
表 properties
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| resourceId | String | 資源ID。操作關聯的資源ID。例如，創建云電腦的操作成功時，為新創建云電腦的ID。 |
枚舉參數
無
請求示例
請求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"}}]}}
狀態碼
請參考
錯誤碼
請參考
