调用UpdateFailoverTestJob接口更新高速通道故障演练任务。
接口说明
只支持更新处于待演练状态的故障演练任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:UpdateFailoverTestJob | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
ResourceId | array | 否 | 故障演练资源 ID 列表。最多可以添加 16 个资源。 | |
string | 否 | 故障演练资源 ID。 | pc-uf66k4e8pq3r00jfq**** | |
JobDuration | integer | 否 | 故障演练任务时长。单位为分钟,取值范围为:1~4320。 | 60 |
JobId | string | 是 | 故障演练任务 ID。 | ftj-bp1yh6mvi13aq3g8w**** |
DryRun | boolean | 否 | 是否只预检此次请求。取值范围:
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF\n"
}
错误码
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 | 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.JobDuration | The specified parameter JobDuration is illegal. | 输入的任务时长不合法。 |
400 | IllegalParam.JobId | The specified parameter JobId is illegal. | 输入的故障演练任务ID不合法。 |
400 | IncorrectStatus.OnlyForInit | Only the init status failover test job can be started. | 只有待演练的故障演练任务才可以开始。 |
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 入参发生变更 | 查看变更详情 |