DescribeDnsGtmAccessStrategies - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries access policies of a Global Traffic Manager (GTM) instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:DescribeDnsGtmAccessStrategies	get	gtmInstance acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.	en
InstanceId	string	Yes	The ID of the instance.	instance1
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	1
StrategyMode	string	Yes	The type of the access policy. Valid values: GEO: geographical location-based LATENCY: latency-based	geo

Response parameters

Parameter	Type	Description	Example
	object
TotalPages	integer	The total number of pages returned.	11
TotalItems	integer	The total number of entries returned on all pages.	11
PageSize	integer	The number of entries returned per page.	1
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	0CCC9971-CEC9-4132-824B-4AE611C07623
Strategies	array<object>	The access policies.
Strategy	object
EffectiveLbaStrategy	string	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.	all_rr
StrategyId	string	The ID of the access policy.	strategyid1
StrategyName	string	The name of the access policy.	strategname1
EffectiveAddrPoolGroupType	string	The type of the active address pool group. Valid values: DEFAULT: the primary address pool group FAILOVER: the secondary address pool group	default
CreateTime	string	The time when the access policy was created.	2018-08-09T00:10Z
CreateTimestamp	long	The timestamp that indicates when the access policy was created.	1533773400000
EffectiveAddrPoolType	string	The type of the active address pools. Valid values: IPV4 IPV6 DOMAIN	ipv4
Lines	array<object>	The source regions. Data is returned when StrategyMode is set to GEO. Valid values:
Line	object
GroupName	string	The name of the source region group.	global
LineCode	string	The line code of the source region.	default
LineName	string	The line name of the source region.	global
GroupCode	string	The code of the source region group.	default
EffectiveAddrPools	array<object>	The active address pool groups.
EffectiveAddrPool	object
Name	string	The name of the address pool.	test
AddrCount	integer	The number of addresses in the address pool.	3
LbaWeight	integer	The weight of the address pool.	1
Id	string	The ID of the address pool.	pool1

Examples

Sample success responses

JSONformat

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

Error codes

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