All Products
Search
Document Center

Alibaba Cloud DNS:DescribeGtmRecoveryPlanAvailableConfig

Last Updated:Mar 15, 2024

You can call this operation to query the available configurations of a disaster recovery plan of a Global Traffic Manager (GTM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
alidns:DescribeGtmRecoveryPlanAvailableConfigREAD
  • gtmInstance
    acs:alidns::{#accountId}:gtmInstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language used by the user.

en

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

F8F8EF50-8B7F-4702-B294-97170A423403
Instancesobject []

The list of GTM instances involved in the disaster recovery plan.

InstanceNamestring

The name of the GTM instance.

instance-name-example
InstanceIdstring

The ID of the GTM instance.

instance-example
AddrPoolsobject []

The list of address pools for the GTM instance.

Namestring

The name of the address pool.

hra0i9
AddrPoolIdstring

The ID of the address pool.

Examples

Sample success responses

JSONformat

{
  "RequestId": "F8F8EF50-8B7F-4702-B294-97170A423403",
  "Instances": {
    "Instance": [
      {
        "InstanceName": "instance-name-example",
        "InstanceId": "instance-example",
        "AddrPools": {
          "AddrPool": [
            {
              "Name": "hra0i9",
              "AddrPoolId": ""
            }
          ]
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.