調用CreateFailoverTestJob接口創建高速通道故障演練任務。
接口說明
以下場景不支持創建故障演練任務：
-
當前地域您已經有正在演練的故障演練任務，且本次創建故障演練任務的任務類型為立即開始。
-
物理專線實例或者共享物理專線實例沒有支付完成或者處于欠費狀態。
-
物理專線實例或者共享物理專線實例處于其他正在演練的故障演練任務中。
-
物理專線實例下有超過 1 個共享物理專線。
-
物理專線實例下有超過 1 個跨賬號 VBR。
-
共享物理專線實例沒有綁定 VBR。
-
共享物理專線實例的 VLAN 配置為 0。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreateFailoverTestJob | create | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}*PhysicalConnection acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 故障演練任務所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| ClientToken | string | 是 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
| Name | string | 否 | 故障演練任務的名稱。 長度為 0～128 個字符，不能以 | test |
| Description | string | 否 | 故障演練任務的描述信息。 長度為 0～256 個字符，不能以 | test |
| ResourceType | string | 是 | 演練資源類型。取值：PHYSICALCONNECTION 物理專線。 | PHYSICALCONNECTION |
| ResourceId | array | 是 | 演練資源 ID 列表。最多可以添加 16 個演練資源。 | |
| string | 是 | 演練資源 ID。 | pc-uf66k4e8pq3r00jfq**** | |
| JobType | string | 是 | 故障演練任務方式。取值：
| StartNow |
| JobDuration | integer | 是 | 故障演練任務時長。單位為分鐘，取值范圍為：1~4320。 | 60 |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值范圍：
| false |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF\n",
"JobId": "ftj-bp1yh6mvi13aq3g8w****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.Name | The param of Name [%s] is illegal. | 參數 Name 不合法，請根據請求參數規定重新輸入。 |
| 400 | IllegalParam.Description | The param of Description [%s] is illegal. | 參數Description 不合法，請根據請求參數規定重新輸入。 |
| 400 | IllegalParam.ResourceType | Invalid Resource Type value. | 指定的ResourceType未支持或不合法 |
| 400 | EcFailoverTestJobExceedMaxResourceNum | The input resource number is exceeded the quota of 16. | 故障演練任務最多可以添加16個資源。 |
| 400 | EcFailoverTestJobResourceInAnotherProcessingJob | There is another processing failover test job. | 當前用戶已經存在一個正在進行的故障演練任務，請完成后再重試。 |
| 400 | IllegalParam.ResourceId | The input parameter resource ID is invalid. | 輸入的參數資源ID不合法 |
| 400 | IncorrectStatus.ResourceId | The specified resource status is invalid. | 輸入的資源ID對應的資源狀態不合法。 |
| 400 | IncorrectBusinessStatus.ResourceId | The specified resource business status is invalid. | 輸入的資源處于欠費狀態。 |
| 400 | VpconnNotAssociatedVbr | The specified vpconn is not associated with vbr. | 輸入的共享物理專線沒有關聯虛擬邊界路由器 |
| 400 | VpconnWithVlan0NotSupportShutdown | The specified virtualPhysicalConnection with vlan 0 does not support shutdown. | VLAN 0的共享物理專線不支持進行故障演練。 |
| 400 | PconnContainsMoreThanOneVpconn | The specified physicalConnection contains more than one virtualPhysicalConnection. | 包含了超過1個共享物理專線的物理專線不支持故障演練。 |
| 400 | PconnContailsMoreThanOneAcrossCountVbr | The specified physicalConnection contains more than one virtualBorderRouter which is across count. | 包含了超過1個跨賬號VBR的物理專線不支持故障演練。 |
| 400 | IllegalParam.JobType | The specified parameter JobType is illegal. | 輸入的任務類型不合法。 |
| 400 | IllegalParam.JobDuration | The specified parameter JobDuration is illegal. | 輸入的任務時長不合法。 |
| 400 | AnotherJobTesting | There is another job which is testing. | 同一個用戶在同一個地域只能同時進行一個故障演練任務。 |
| 400 | MultiplePconnSingleVbrNotSupportShutdown | Vbr for single vbr and multiple pconn scenarios does not support failover test job. | 單vbr多pconn場景的vbr不支持故障演練。 |
| 400 | EcFailoverTestJobConflict | The current failover test job task is in operation, please try again later. | 當前的故障演練任務正在操作中，請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-19 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |