Queries detailed information about 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 DescribeDnsGtmAccessStrategy

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

StrategyId String Yes strategyId1

The ID of the access policy.

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
AccessMode String auto

The primary/secondary switchover policy for address pool groups. Valid values:

  • AUTO: performs automatic switchover between the primary and secondary address pool groups upon failures.
  • DEFAULT: uses the primary address pool group.
  • FAILOVER: uses the secondary address pool group.
CreateTime String 2018-08-09T00:10Z

The time when the access policy was created.

CreateTimestamp Long 1533773400000

The timestamp that indicates when the access policy was created.

DefaultAddrPoolGroupStatus String AVAILABLE

The status of the primary address pool group. Valid values:

  • AVAILABLE: available
  • NOT_AVAILABLE: unavailable
DefaultAddrPoolType String ipv4

The type of the primary address pool. Valid values:

  • IPV4
  • IPV6
  • DOMAIN
DefaultAddrPools Array of DefaultAddrPool

The address pools in the primary address pool group.

DefaultAddrPool
AddrCount Integer 1

The number of addresses in the address pool.

Id String pool1

The ID of the address pool.

LbaWeight Integer 1

The weight of the address pool.

Name String test

The name of the address pool.

DefaultAvailableAddrNum Integer 1

The number of available addresses in the primary address pool.

DefaultLatencyOptimization String open

Indicates whether scheduling optimization for latency resolution was enabled for the primary address pool group. Valid values:

  • OPEN: enabled
  • CLOSE: disabled
DefaultLbaStrategy String all_rr

The load balancing policy of the primary address pool group. Valid values:

  • ALL_RR: returns all addresses.
  • RATIO: returns addresses by weight.
DefaultMaxReturnAddrNum Integer 1

The maximum number of addresses returned from the primary address pool group.

DefaultMinAvailableAddrNum Integer 1

The minimum number of available addresses in the primary address pool group.

EffectiveAddrPoolGroupType String DEFAULT

The type of the active address pool group. Valid values:

  • DEFAULT: the primary address pool group
  • FAILOVER: the secondary address pool group
FailoverAddrPoolGroupStatus String AVAILABLE

The status of the secondary address pool group. Valid values:

  • AVAILABLE: available
  • NOT_AVAILABLE: unavailable
FailoverAddrPoolType String ipv4

The type of the secondary address pool. Valid values:

  • IPV4
  • IPV6
  • DOMAIN
FailoverAddrPools Array of FailoverAddrPool

The address pools in the secondary address pool group.

FailoverAddrPool
AddrCount Integer 1

The number of addresses in the address pool.

Id String pool1

The ID of the address pool.

LbaWeight Integer 1

The weight of the address pool.

Name String test

The name of the address pool.

FailoverAvailableAddrNum Integer 1

The number of available addresses in the secondary address pool.

FailoverLatencyOptimization String open

Indicates whether scheduling optimization for latency resolution was enabled for the secondary address pool group. Valid values:

  • OPEN: enabled
  • CLOSE: disabled
FailoverLbaStrategy String all_rr

The load balancing policy of the secondary address pool group. Valid values:

  • ALL_RR: returns all addresses.
  • RATIO: returns addresses by weight.
FailoverMaxReturnAddrNum Integer 1

The maximum number of addresses returned from the secondary address pool group.

FailoverMinAvailableAddrNum Integer 1

The minimum number of available addresses in the secondary address pool group.

InstanceId String instance1

The ID of the associated instance.

Lines Array of Line

The source regions.

Line
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 BA1608CA-834C-4E63-8682-8AF0B11ED72D

The ID of the request.

StrategyId String strategyId1

The ID of the access policy.

StrategyMode String geo

The type of the access policy. Valid values:

  • GEO: geographical location-based
  • LATENCY: latency-based
StrategyName String strategyName1

The name of the access policy.

Examples

Sample requests

http(s)://alidns.aliyuncs.com/? Action=DescribeDnsGtmAccessStrategy
&StrategyId=strategyId1
&<Common request parameters>

Sample success responses

XML format

<FailoverMinAvailableAddrNum>1</FailoverMinAvailableAddrNum>
<DefaultAddrPoolType>ipv4</DefaultAddrPoolType>
<DefaultAvailableAddrNum>1</DefaultAvailableAddrNum>
<FailoverAddrPoolGroupStatus>AVAILABLE</FailoverAddrPoolGroupStatus>
<StrategyId>strategyId1</StrategyId>
<FailoverAvailableAddrNum>1</FailoverAvailableAddrNum>
<FailoverLbaStrategy>all_rr</FailoverLbaStrategy>
<DefaultMaxReturnAddrNum>1</DefaultMaxReturnAddrNum>
<StrategyMode>geo</StrategyMode>
<CreateTimestamp>1533773400000</CreateTimestamp>
<DefaultAddrPoolGroupStatus>AVAILABLE</DefaultAddrPoolGroupStatus>
<DefaultLbaStrategy>all_rr</DefaultLbaStrategy>
<FailoverAddrPoolType>ipv4</FailoverAddrPoolType>
<RequestId>BA1608CA-834C-4E63-8682-8AF0B11ED72D</RequestId>
<InstanceId>instance1</InstanceId>
<FailoverAddrPools>
    <FailoverAddrPool>
        <Id>pool1</Id>
        <LbaWeight>1</LbaWeight>
        <AddrCount>1</AddrCount>
        <Name>test</Name>
    </FailoverAddrPool>
</FailoverAddrPools>
<DefaultLatencyOptimization>open</DefaultLatencyOptimization>
<CreateTime>2018-08-09T00:10Z</CreateTime>
<EffectiveAddrPoolGroupType>DEFAULT</EffectiveAddrPoolGroupType>
<DefaultAddrPools>
    <DefaultAddrPool>
        <Id>pool1</Id>
        <LbaWeight>1</LbaWeight>
        <AddrCount>1</AddrCount>
        <Name>test</Name>
    </DefaultAddrPool>
</DefaultAddrPools>
<DefaultMinAvailableAddrNum>1</DefaultMinAvailableAddrNum>
<FailoverLatencyOptimization>open</FailoverLatencyOptimization>
<StrategyName>strategyName1</StrategyName>
<FailoverMaxReturnAddrNum>1</FailoverMaxReturnAddrNum>
<AccessMode>auto</AccessMode>
<Lines>
    <Line>
        <GroupName>global</GroupName>
        <GroupCode>default</GroupCode>
        <LineCode>default</LineCode>
        <LineName>global</LineName>
    </Line>
</Lines>

JSON format

{
	"FailoverMinAvailableAddrNum": "1",
	"DefaultAddrPoolType": "ipv4",
	"DefaultAvailableAddrNum": "1",
	"FailoverAddrPoolGroupStatus": "AVAILABLE",
	"StrategyId": "strategyId1",
	"FailoverAvailableAddrNum": "1",
	"FailoverLbaStrategy": "all_rr",
	"DefaultMaxReturnAddrNum": "1",
	"StrategyMode": "geo",
	"CreateTimestamp": "1533773400000",
	"DefaultAddrPoolGroupStatus": "AVAILABLE",
	"DefaultLbaStrategy": "all_rr",
	"FailoverAddrPoolType": "ipv4",
	"RequestId": "BA1608CA-834C-4E63-8682-8AF0B11ED72D",
	"InstanceId": "instance1",
	"FailoverAddrPools": {
		"FailoverAddrPool": [{
			"Id": "pool1",
			"LbaWeight": "1",
			"AddrCount": "1",
			"Name": "test"
		}]
	},
	"DefaultLatencyOptimization": "open",
	"CreateTime": "2018-08-09T00:10Z",
	"EffectiveAddrPoolGroupType": "DEFAULT",
	"DefaultAddrPools": {
		"DefaultAddrPool": [{
			"Id": "pool1",
			"LbaWeight": "1",
			"AddrCount": "1",
			"Name": "test"
		}]
	},
	"DefaultMinAvailableAddrNum": "1",
	"FailoverLatencyOptimization": "open",
	"StrategyName": "strategyName1",
	"FailoverMaxReturnAddrNum": "1",
	"AccessMode": "auto",
	"Lines": {
		"Line": [{
			"GroupName": "global",
			"GroupCode": "default",
			"LineCode": "default",
			"LineName": "global"
		}]
	}
}

Error codes

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