All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDnsGtmAccessStrategyAvailableConfig

Last Updated:Mar 15, 2024

Queries the available configurations of an access policy 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:DescribeDnsGtmAccessStrategyAvailableConfigREAD
  • gtmInstance
    acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.

en
InstanceIdstringYes

The ID of the instance.

instance1
StrategyModestringYes

The type of the access policy. Valid values:

  • GEO: geographical location-based
  • LATENCY: latency-based
geo

Response parameters

ParameterTypeDescriptionExample
object
SuggestSetDefaultLineboolean

Indicates whether we recommend that you set the source region to global.

true
RequestIdstring

The ID of the request.

C2851BA9-CE56-49AF-8D12-4FC6A49EE688
Ipv4AddrPoolsobject []

The available address pools of the IPv4 type.

Namestring

The name of the address pool.

testpool
AddrCountinteger

The number of addresses in the address pool.

1
Idstring

The ID of the address pool.

pool1
Linesobject []

The source regions.

FatherCodestring

The parent line code of the source region. Leave it blank if no parent line exists.

telecom
GroupNamestring

The name of the source region group.

global
LineCodestring

The line code of the source region.

default
GroupCodestring

The line name of the source region.

default
LineNamestring

The code of the source region group.

global
Ipv6AddrPoolsobject []

The available address pools of the IPv6 type.

Namestring

The name of the address pool.

testpool
AddrCountinteger

The number of addresses in the address pool.

1
Idstring

The ID of the address pool.

pool1
DomainAddrPoolsobject []

The available address pools of the domain name type.

Namestring

The name of the address pool.

testpool
AddrCountinteger

The number of addresses in the address pool.

1
Idstring

The ID of the address pool.

pool1

Examples

Sample success responses

JSONformat

{
  "SuggestSetDefaultLine": true,
  "RequestId": "C2851BA9-CE56-49AF-8D12-4FC6A49EE688",
  "SelectedIpv4Lines": {
    "SelectedIpv4Line": [
      ""
    ]
  },
  "SelectedIpv6Lines": {
    "SelectedIpv6Line": [
      ""
    ]
  },
  "SelectedDomainLines": {
    "SelectedDomainLine": [
      ""
    ]
  },
  "Ipv4AddrPools": {
    "Ipv4AddrPool": [
      {
        "Name": "testpool",
        "AddrCount": 1,
        "Id": "pool1"
      }
    ]
  },
  "Lines": {
    "Line": [
      {
        "FatherCode": "telecom",
        "GroupName": "global",
        "LineCode": "default",
        "GroupCode": "default",
        "LineName": "global"
      }
    ]
  },
  "Ipv6AddrPools": {
    "Ipv6AddrPool": [
      {
        "Name": "testpool",
        "AddrCount": 1,
        "Id": "pool1"
      }
    ]
  },
  "DomainAddrPools": {
    "DomainAddrPool": [
      {
        "Name": "testpool",
        "AddrCount": 1,
        "Id": "pool1"
      }
    ]
  }
}

Error codes

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