All Products
Search
Document Center

Virtual Private Cloud:DescribeFailoverTestJobs

Last Updated:Dec 20, 2024

Queries failover tests for Express Connect.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeFailoverTestJobslist
*PhysicalConnection
acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}
*VirtualBorderRouter
acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
ClientTokenstringYes

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
MaxResultsintegerNo

The number of entries per page. Valid values: 1 to 100. Default value: 20.

20
Filterarray<object>No

The filter information.

objectNo

The list of filters.

KeystringNo

The filter key. Valid values:

  • JobId
  • JobName
  • JobStatus
  • ResourceId
  • ResourceName
  • ResourceType
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
ValuearrayNo

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.
stringNo

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

ParameterTypeDescriptionExample
object

The response parameters.

FailoverTestJobListarray<object>

The list of failover tests.

FailoverTestJobListobject

The failover test.

JobIdstring

The ID of the failover test.

ftj-xxxxxxxxx
Namestring

The name of the failover test.

The name must be 0 to 128 characters in length and cannot start with http:// or https://.

test
Descriptionstring

The description of the failover test.

The description must be 0 to 256 characters in length and cannot start with **http:// or https://**.

test
ResourceTypestring

The type of the failover test resource. Only PHYSICALCONNECTION is returned.

PHYSICALCONNECTION
ResourceIdarray

The IDs of the failover test resources.

ResourceIdstring

The resource ID.

pc-uf66k4e8pq3r00jfqo0b5
JobTypestring

Indicates whether the failover test is performed immediately. Valid values:

  • StartNow
  • StartLater
StartNow
JobDurationstring

The duration of the failover test. Unit: minutes. Valid values: 1 to 4320.

60
Statusstring

The status of the failover test. Valid values:

  • Init
  • Starting
  • Testing
  • Stopping
  • Stopped
Init
MaxResultsinteger

The number of entries per page. Valid values: 1 to 100. Default value: 20.

20

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400IllegalParam.Filter.KeyThe filter parameter Key is invalid.The filter parameter Key is invalid.
400IllegalParam.Filter.ValueThe filter parameter Value is illegal.The filter parameter Value is illegal.
400SystemQuotaConstraint.Filter.ValueThe 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.
400SystemQuotaConstraint.Filter.KeyThe number of keys in the filter parameter cannot exceed 5.The number of keys in the filter parameter cannot exceed 5.
400IllegalParam.FilterKey.ResourceTypeFilter 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.
400IllegalParam.JobIdThe specified parameter JobId is illegal.The entered failover test job ID is invalid.
400IllegalParam.ResourceTypeInvalid %s value.ResourceType is set to an invalid value.
400IncorrectStatus.ResourceIdThe 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 timeSummary of changesOperation
2024-07-29The Error code has changedView Change Details
2024-07-19The Error code has changed. The response structure of the API has changedView Change Details