全部产品
Search
文档中心

专有网络 VPC:DescribeFailoverTestJobs - 批量查询高速通道故障演练任务

更新时间:Nov 27, 2024

调用DescribeFailoverTestJobs接口批量查询高速通道故障演练任务。

调试

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

授权信息

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

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

请求参数

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

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

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

cn-hangzhou
ClientTokenstring

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

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

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

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20。

20
Filterarray<object>

过滤信息。

object

过滤信息列表。

Keystring

过滤条件。取值:

  • JobId:故障演练任务 ID。

  • JobName:故障演练任务名称。

  • JobStatus:故障演练任务状态。

  • ResourceId:故障演练资源 ID。

  • ResourceName:故障演练资源名称。

  • ResourceType:故障演练资源类型。

说明 请确保最多输入 5 个不重复的过滤条件。当输入资源 ID 或资源名称时,需同时输入资源类型。所有过滤条件需同时满足才能得到准确的查询结果。
JobId
Valuearray

过滤条件对应的过滤值。

说明 请确保每个过滤条件可以包含最多 5 个过滤值。这些过滤值之间采用"或"的关系,即只需满足其中任一过滤值,即可认为符合该过滤条件。
string

过滤条件对应的过滤值。

说明 请确保每个过滤条件可以包含最多 5 个过滤值。这些过滤值之间采用"或"的关系,即只需满足其中任一过滤值,即可认为符合该过滤条件。
ftj-bp1yh6mvi13aq3g8w****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
FailoverTestJobListarray<object>

故障演练任务列表。

FailoverTestJobListobject

故障演练任务。

JobIdstring

故障演练任务 ID。

ftj-bp1yh6mvi13aq3g8w****
Namestring

故障演练任务的名称。

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

test
Descriptionstring

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

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

test
ResourceTypestring

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

PHYSICALCONNECTION
ResourceIdarray

故障演练资源 ID 列表。

ResourceIdstring

资源 ID。

pc-uf66k4e8pq3r00jfq****
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
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20。

20
TotalCountinteger

列表总条目数。

10
Countinteger

列表当前条目数。

10

示例

正常返回示例

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错误码错误信息描述
400IllegalParam.Filter.KeyThe filter parameter Key is invalid.过滤参数Key不合法。
400IllegalParam.Filter.ValueThe filter parameter Value is illegal.过滤参数Value不合法。
400SystemQuotaConstraint.Filter.ValueThe number of values in a key in the filter parameter cannot exceed 5.过滤参数中一个Key里面的Value个数不能超过5个。
400SystemQuotaConstraint.Filter.KeyThe number of keys in the filter parameter cannot exceed 5.过滤参数中Key的个数不允许超过5个。
400IllegalParam.FilterKey.ResourceTypeFilter parameters do not support entering only ResourceId or ResourceName without entering ResourceType.过滤参数不支持只输入ResourceId或者ResourceName而不输入ResourceType。
400IllegalParam.JobIdThe specified parameter JobId is illegal.输入的故障演练任务ID不合法。
400IllegalParam.ResourceTypeInvalid %s value.传入的参数ResourceType不合法
400IncorrectStatus.ResourceIdThe specified resource status is invalid.输入的资源ID对应的资源状态不合法。

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

变更历史

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