調用DescribeFailoverTestJobs接口批量查詢高速通道故障演練任務。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:DescribeFailoverTestJobs | list | *PhysicalConnection acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId} *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 故障演練任務所在的地域。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
ClientToken | string | 是 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
NextToken | string | 否 | 是否擁有下一次查詢的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResults | integer | 否 | 分批次查詢時每次顯示的條目數。取值范圍:1~100,默認值為 20。 | 20 |
Filter | array<object> | 否 | 過濾信息。 | |
object | 否 | 過濾信息列表。 | ||
Key | string | 否 | 過濾條件。取值:
說明
請確保最多輸入 5 個不重復的過濾條件。當輸入資源 ID 或資源名稱時,需同時輸入資源類型。所有過濾條件需同時滿足才能得到準確的查詢結果。
| JobId |
Value | array | 否 | 過濾條件對應的過濾值。 說明
請確保每個過濾條件可以包含最多 5 個過濾值。這些過濾值之間采用"或"的關系,即只需滿足其中任一過濾值,即可認為符合該過濾條件。
| |
string | 否 | 過濾條件對應的過濾值。 說明
請確保每個過濾條件可以包含最多 5 個過濾值。這些過濾值之間采用"或"的關系,即只需滿足其中任一過濾值,即可認為符合該過濾條件。
| ftj-bp1yh6mvi13aq3g8w**** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"FailoverTestJobList": [
{
"JobId": "ftj-bp1yh6mvi13aq3g8w****\n",
"Name": "test",
"Description": "test",
"ResourceType": "PHYSICALCONNECTION",
"ResourceId": [
"pc-uf66k4e8pq3r00jfq****"
],
"JobType": "StartNow",
"JobDuration": "60",
"StartTime": "2023-11-21T14:00:00Z",
"StopTime": "2023-11-21T15:00:00Z\n",
"Status": "Init"
}
],
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"MaxResults": 20,
"TotalCount": 10,
"Count": 10
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.Filter.Key | The filter parameter Key is invalid. | 過濾參數Key不合法。 |
400 | IllegalParam.Filter.Value | The filter parameter Value is illegal. | 過濾參數Value不合法。 |
400 | SystemQuotaConstraint.Filter.Value | The number of values in a key in the filter parameter cannot exceed 5. | 過濾參數中一個Key里面的Value個數不能超過5個。 |
400 | SystemQuotaConstraint.Filter.Key | The number of keys in the filter parameter cannot exceed 5. | 過濾參數中Key的個數不允許超過5個。 |
400 | IllegalParam.FilterKey.ResourceType | Filter parameters do not support entering only ResourceId or ResourceName without entering ResourceType. | 過濾參數不支持只輸入ResourceId或者ResourceName而不輸入ResourceType。 |
400 | IllegalParam.JobId | The specified parameter JobId is illegal. | 輸入的故障演練任務ID不合法。 |
400 | IllegalParam.ResourceType | Invalid %s value. | 傳入的參數ResourceType不合法 |
400 | IncorrectStatus.ResourceId | The specified resource status is invalid. | 輸入的資源ID對應的資源狀態不合法。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-07-19 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |