调用DescribeFailoverTestJobs接口批量查询高速通道故障演练任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:DescribeFailoverTestJobs | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 返回结构发生变更 | 查看变更详情 |