Queries failover tests for Express Connect.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vpc:DescribeFailoverTestJobs | list | *PhysicalConnection acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId} *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId} |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region where you want to perform the failover test. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
ClientToken | string | Yes | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 123e4567-e89b-12d3-a456-426655440000 |
MaxResults | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 20. | 20 |
Filter | array<object> | No | The filter information. | |
object | No | The list of filters. | ||
Key | string | No | The filter key. Valid values:
Note
You can specify at most five different filter keys. If you specify ResourceId or ResourceName, you must also specify ResourceType. The logical operator among the filter keys is AND. Results that meet all specified filter keys are returned.
| JobId |
Value | array | No | The value of the filter key. Note
You can specify at most five filter values for each filter key. The logical operator among filter values is OR. If a filter value is matched, the filter key is considered matched.
| |
string | No | The value of the filter key. Note
You can specify at most five filter values for each filter key. The logical operator among filter values is OR. If a filter value is matched, the filter key is considered matched.
| ftj-xxxxxxxxx |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"FailoverTestJobList": [
{
"JobId": "ftj-xxxxxxxxx\n",
"Name": "test",
"Description": "test",
"ResourceType": "PHYSICALCONNECTION",
"ResourceId": [
"pc-uf66k4e8pq3r00jfqo0b5"
],
"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
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | IllegalParam.Filter.Key | The filter parameter Key is invalid. | The filter parameter Key is invalid. |
400 | IllegalParam.Filter.Value | The filter parameter Value is illegal. | The filter parameter Value is illegal. |
400 | SystemQuotaConstraint.Filter.Value | The number of values in a key in the filter parameter cannot exceed 5. | The number of values in a key in the filter parameter cannot exceed 5. |
400 | SystemQuotaConstraint.Filter.Key | The number of keys in the filter parameter cannot exceed 5. | The number of keys in the filter parameter cannot exceed 5. |
400 | IllegalParam.FilterKey.ResourceType | Filter parameters do not support entering only ResourceId or ResourceName without entering ResourceType. | Filter parameters do not support entering only ResourceId or ResourceName without entering ResourceType. |
400 | IllegalParam.JobId | The specified parameter JobId is illegal. | The entered failover test job ID is invalid. |
400 | IllegalParam.ResourceType | Invalid %s value. | ResourceType is set to an invalid value. |
400 | IncorrectStatus.ResourceId | The specified resource status is invalid. | The resource status corresponding to the entered resource ID is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-07-29 | The Error code has changed | View Change Details |
2024-07-19 | The Error code has changed. The response structure of the API has changed | View Change Details |