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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDnsGtmAccessStrategyAvailableConfig

The operation that you want to perform. Set the value to DescribeDnsGtmAccessStrategyAvailableConfig.

InstanceId String Yes instance1

The ID of the instance.

StrategyMode String Yes geo

The type of the access policy. Valid values:

  • GEO: geographical location-based
  • LATENCY: latency-based
Lang String No en

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

Response parameters

Parameter Type Example Description
DomainAddrPools Array of DomainAddrPool

The available address pools of the domain name type.

DomainAddrPool
AddrCount Integer 1

The number of addresses in the address pool.

Id String pool1

The ID of the address pool.

Name String testpool

The name of the address pool.

Ipv4AddrPools Array of Ipv4AddrPool

The available address pools of the IPv4 type.

Ipv4AddrPool
AddrCount Integer 1

The number of addresses in the address pool.

Id String pool1

The ID of the address pool.

Name String testpool

The name of the address pool.

Ipv6AddrPools Array of Ipv6AddrPool

The available address pools of the IPv6 type.

Ipv6AddrPool
AddrCount Integer 1

The number of addresses in the address pool.

Id String pool1

The ID of the address pool.

Name String testpool

The name of the address pool.

Lines Array of Line

The source regions.

Line
FatherCode String telecom

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

GroupCode String default

The code of the source region group.

GroupName String global

The name of the source region group.

LineCode String default

The line code of the source region.

LineName String global

The line name of the source region.

RequestId String C2851BA9-CE56-49AF-8D12-4FC6A49EE688

The ID of the request.

SuggestSetDefaultLine Boolean true

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

Examples

Sample requests

http(s)://alidns.aliyuncs.com/? Action=DescribeDnsGtmAccessStrategyAvailableConfig
&InstanceId=instance1
&StrategyMode=geo
&<Common request parameters>

Sample success responses

XML format

<Ipv4AddrPools>
    <Ipv4AddrPool>
        <Id>pool1</Id>
        <AddrCount>1</AddrCount>
        <Name>testpool</Name>
    </Ipv4AddrPool>
</Ipv4AddrPools>
<DomainAddrPools>
    <DomainAddrPool>
        <Id>pool1</Id>
        <AddrCount>1</AddrCount>
        <Name>testpool</Name>
    </DomainAddrPool>
</DomainAddrPools>
<RequestId>C2851BA9-CE56-49AF-8D12-4FC6A49EE688</RequestId>
<Ipv6AddrPools>
    <Ipv6AddrPool>
        <Id>pool1</Id>
        <AddrCount>1</AddrCount>
        <Name>testpool</Name>
    </Ipv6AddrPool>
</Ipv6AddrPools>
<SuggestSetDefaultLine>true</SuggestSetDefaultLine>
<Lines>
    <Line>
        <GroupName>global</GroupName>
        <GroupCode>default</GroupCode>
        <FatherCode>telecom</FatherCode>
        <LineCode>default</LineCode>
        <LineName>global</LineName>
    </Line>
</Lines>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.