DescribeFailoverTestJob - 查询高速通道故障演练任务详情

调用DescribeFailoverTestJob接口查询高速通道故障演练任务详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeFailoverTestJobget
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

故障演练任务所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
JobIdstring

故障演练任务 ID。

ftj-bp1yh6mvi13aq****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

C44F62BE-9CE7-4277-B117-69243F3988BF
FailoverTestJobModelobject

故障演练任务。

JobIdstring

故障演练任务 ID。

ftj-bp1yh6mvi13aq3g8w****
Namestring

故障演练任务的名称。

长度为 0~128 个字符,不能以http://https://开头。

test
Descriptionstring

故障演练任务的描述信息。

长度为 0~256 个字符,不能以http://https://开头。

test
ResourceTypestring

故障演练资源类型。取值:PHYSICALCONNECTION 物理专线。

PHYSICALCONNECTION
ResourceIdarray

故障演练资源 ID 列表。

ResourceIdstring

故障演练资源 ID。

pc-hp34pxu31qo36a72u****
JobTypestring

故障演练类型。取值:

  • StartNow:立即开始,任务演练任务创建成功后立即开始执行演练。

  • StartLater:暂不演练,仅创建演练任务暂不执行演练。

StartNow
JobDurationstring

故障演练时长。单位为分钟,取值范围为:1~4320

60
StartTimestring

故障演练任务开始时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

2023-11-21T14:00:00Z
StopTimestring

故障演练任务结束时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

2023-11-21T15:00:00Z
Statusstring

故障演练任务状态。取值:

  • Init:待演练。

  • Starting:开始中。

  • Testing:演练中。

  • Stopping:结束中。

  • Stopped:已完成。

Init

示例

正常返回示例

JSON格式

{
  "RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF",
  "FailoverTestJobModel": {
    "JobId": "ftj-bp1yh6mvi13aq3g8w****",
    "Name": "test",
    "Description": "test",
    "ResourceType": "PHYSICALCONNECTION",
    "ResourceId": [
      "pc-hp34pxu31qo36a72u****"
    ],
    "JobType": "StartNow",
    "JobDuration": "60",
    "StartTime": "2023-11-21T14:00:00Z\n",
    "StopTime": "2023-11-21T15:00:00Z\n",
    "Status": "Init"
  }
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.JobIdThe specified parameter JobId is illegal.输入的故障演练任务ID不合法。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-19OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情