DescribeDnsGtmAccessStrategy - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries detailed information about an access policy 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:DescribeDnsGtmAccessStrategy	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
StrategyId	string	Yes	The ID of the access policy.	strategyId1

Response parameters

Parameter	Type	Description	Example
	object
DefaultAddrPoolType	string	The type of the primary address pool. Valid values: IPV4 IPV6 DOMAIN	ipv4
FailoverAvailableAddrNum	integer	The number of available addresses in the secondary address pool.	1
DefaultAvailableAddrNum	integer	The number of available addresses in the primary address pool.	1
AccessMode	string	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.	auto
FailoverLatencyOptimization	string	Indicates whether scheduling optimization for latency resolution was enabled for the secondary address pool group. Valid values: OPEN: enabled CLOSE: disabled	open
StrategyName	string	The name of the access policy.	strategyName1
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
FailoverMinAvailableAddrNum	integer	The minimum number of available addresses in the secondary address pool group.	1
CreateTime	string	The time when the access policy was created.	2018-08-09T00:10Z
FailoverMaxReturnAddrNum	integer	The maximum number of addresses returned from the secondary address pool group.	1
StrategyMode	string	The type of the access policy. Valid values: GEO: geographical location-based LATENCY: latency-based	geo
DefaultLbaStrategy	string	The load balancing policy of the primary address pool group. Valid values: ALL_RR: returns all addresses. RATIO: returns addresses by weight.	all_rr
DefaultAddrPoolGroupStatus	string	The status of the primary address pool group. Valid values: AVAILABLE: available NOT_AVAILABLE: unavailable	AVAILABLE
InstanceId	string	The ID of the associated instance.	instance1
DefaultMinAvailableAddrNum	integer	The minimum number of available addresses in the primary address pool group.	1
FailoverLbaStrategy	string	The load balancing policy of the secondary address pool group. Valid values: ALL_RR: returns all addresses. RATIO: returns addresses by weight.	all_rr
StrategyId	string	The ID of the access policy.	strategyId1
RequestId	string	The ID of the request.	BA1608CA-834C-4E63-8682-8AF0B11ED72D
DefaultLatencyOptimization	string	Indicates whether scheduling optimization for latency resolution was enabled for the primary address pool group. Valid values: OPEN: enabled CLOSE: disabled	open
FailoverAddrPoolType	string	The type of the secondary address pool. Valid values: IPV4 IPV6 DOMAIN	ipv4
DefaultMaxReturnAddrNum	integer	The maximum number of addresses returned from the primary address pool group.	1
CreateTimestamp	long	The timestamp that indicates when the access policy was created.	1533773400000
FailoverAddrPoolGroupStatus	string	The status of the secondary address pool group. Valid values: AVAILABLE: available NOT_AVAILABLE: unavailable	AVAILABLE
Lines	array<object>	The source regions.
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
DefaultAddrPools	array<object>	The address pools in the primary address pool group.
DefaultAddrPool	object
Name	string	The name of the address pool.	test
AddrCount	integer	The number of addresses in the address pool.	1
LbaWeight	integer	The weight of the address pool.	1
Id	string	The ID of the address pool.	pool1
FailoverAddrPools	array<object>	The address pools in the secondary address pool group.
FailoverAddrPool	object
Name	string	The name of the address pool.	test
AddrCount	integer	The number of addresses in the address pool.	1
LbaWeight	integer	The weight of the address pool.	1
Id	string	The ID of the address pool.	pool1

Examples

Sample success responses

JSONformat

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

Error codes

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