Queries access policies 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 DescribeDnsGtmAccessStrategies

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

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.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 1

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 1

The number of entries returned per page.

RequestId String 0CCC9971-CEC9-4132-824B-4AE611C07623

The ID of the request.

Strategies Array of Strategy

The access policies.

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

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
EffectiveAddrPoolType String ipv4

The type of the active address pools. Valid values:

  • IPV4
  • IPV6
  • DOMAIN
EffectiveAddrPools Array of EffectiveAddrPool

The active address pool groups.

EffectiveAddrPool
AddrCount Integer 3

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.

EffectiveLbaStrategy String all_rr

The load balancing policy of the active address pool group. Data is returned when StrategyMode is set to GEO. Valid values:

  • ALL_RR: returns all addresses.
  • RATIO: returns addresses by weight.
Lines Array of Line

The source regions. Data is returned when StrategyMode is set to GEO. Valid values:

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.

StrategyId String strategyid1

The ID of the access policy.

StrategyName String strategname1

The name of the access policy.

TotalItems Integer 11

The total number of entries returned on all pages.

TotalPages Integer 11

The total number of pages returned.

Examples

Sample requests

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

Sample success responses

XML format

<PageSize>1</PageSize>
<RequestId>0CCC9971-CEC9-4132-824B-4AE611C07623</RequestId>
<PageNumber>1</PageNumber>
<Strategies>
    <Strategy>
        <StrategyName>strategname1</StrategyName>
        <EffectiveAddrPoolType>ipv4</EffectiveAddrPoolType>
        <EffectiveAddrPoolGroupType>default</EffectiveAddrPoolGroupType>
        <CreateTime>2018-08-09T00:10Z</CreateTime>
        <StrategyId>strategyid1</StrategyId>
        <CreateTimestamp>1533773400000</CreateTimestamp>
        <EffectiveLbaStrategy>all_rr</EffectiveLbaStrategy>
    </Strategy>
    <Strategy>
        <EffectiveAddrPools>
            <EffectiveAddrPool>
                <Id>pool1</Id>
                <LbaWeight>1</LbaWeight>
                <AddrCount>3</AddrCount>
                <Name>test</Name>
            </EffectiveAddrPool>
        </EffectiveAddrPools>
        <Lines>
            <Line>
                <GroupName>global</GroupName>
                <GroupCode>default</GroupCode>
                <LineCode>default</LineCode>
                <LineName>global</LineName>
            </Line>
        </Lines>
    </Strategy>
</Strategies>
<TotalPages>11</TotalPages>
<TotalItems>11</TotalItems>

JSON format

{
	"PageSize": "1",
	"RequestId": "0CCC9971-CEC9-4132-824B-4AE611C07623",
	"PageNumber": "1",
	"Strategies": {
		"Strategy": [{
			"StrategyName": "strategname1",
			"EffectiveAddrPoolType": "ipv4",
			"EffectiveAddrPoolGroupType": "default",
			"CreateTime": "2018-08-09T00:10Z",
			"StrategyId": "strategyid1",
			"CreateTimestamp": "1533773400000",
			"EffectiveLbaStrategy": "all_rr"
		}, {
			"EffectiveAddrPools": {
				"EffectiveAddrPool": [{
					"Id": "pool1",
					"LbaWeight": "1",
					"AddrCount": "3",
					"Name": "test"
				}]
			},
			"Lines": {
				"Line": [{
					"GroupName": "global",
					"GroupCode": "default",
					"LineCode": "default",
					"LineName": "global"
				}]
			}
		}]
	},
	"TotalPages": "11",
	"TotalItems": "11"
}

Error codes

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