DescribeDnsGtmAccessStrategy - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the details of a specified access strategy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeDnsGtmAccessStrategy

get

*gtmInstance

acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of some returned parameters. The default value is en. Valid values: en, zh, and ja.	en
StrategyId	string	Yes	The ID of the access policy. For more information, see DescribeDnsGtmAccessStrategies.	hr****

Response elements

Element	Type	Description	Example
	object
FailoverMinAvailableAddrNum	integer	The minimum number of available addresses in the secondary address pool group.	1
DefaultAddrPoolType	string	The type of the primary address pool. Valid values: IPV4 IPV6 DOMAIN	IPV4
DefaultAvailableAddrNum	integer	The number of available addresses in the primary address pool.	1
StrategyId	string	The ID of the access policy.	hr***
FailoverAddrPoolGroupStatus	string	The status of the secondary address pool group. Valid values: AVAILABLE NOT_AVAILABLE	AVAILABLE
FailoverAvailableAddrNum	integer	The number of available addresses in the secondary address pool.	1
FailoverLbaStrategy	string	The load balancing policy for the secondary address pool group. Valid values: ALL_RR: returns all addresses. RATIO: returns addresses by weight.	ALL_RR
DefaultMaxReturnAddrNum	integer	The maximum number of addresses that can be returned from the primary address pool group.	1
StrategyMode	string	The type of the access policy. Valid values: GEO: a geolocation-based access policy. LATENCY: a latency-based access policy.	GEO
CreateTimestamp	integer	The time when the access policy was created. This value is a UNIX timestamp.	1533773400000
DefaultLbaStrategy	string	The load balancing policy for 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 NOT_AVAILABLE	AVAILABLE
FailoverAddrPoolType	string	The type of the secondary address pool. Valid values: IPV4 IPV6 DOMAIN	IPV4
RequestId	string	The unique request ID.	BA1608CA-834C-4E63-8682-8AF0B11ED72D
InstanceId	string	The ID of the associated Global Traffic Manager (GTM) instance.	gtm-cn-wwo3a3hbz**
FailoverAddrPools	object
FailoverAddrPool	array<object>	The list of secondary address pools.
	object
LbaWeight	integer	The weight.	1
Name	string	The name of the address pool.	test
AddrCount	integer	The number of addresses in the address pool.	1
Id	string	The ID of the address pool.	po**
DefaultLatencyOptimization	string	Indicates whether latency-based scheduling is enabled for the primary address pool group. Valid values: OPEN: enabled. CLOSE: disabled.	OPEN
EffectiveAddrPoolGroupType	string	The type of the address pool group that is currently in effect. 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
DefaultAddrPools	object
DefaultAddrPool	array<object>	The list of primary address pools.
	object
LbaWeight	integer	The weight.	1
Name	string	The name of the address pool.	test
AddrCount	integer	The number of addresses in the address pool.	1
Id	string	The ID of the address pool.	po***
DefaultMinAvailableAddrNum	integer	The minimum number of available addresses in the primary address pool group.	1
FailoverLatencyOptimization	string	Indicates whether latency-based scheduling is enabled for the secondary address pool group. Valid values: OPEN: enabled. CLOSE: disabled.	OPEN
StrategyName	string	The name of the access policy.	strategyName1
FailoverMaxReturnAddrNum	integer	The maximum number of addresses that can be returned from the secondary address pool group.	1
AccessMode	string	The switchover policy for the address pool group. Valid values: AUTO: automatic switchover. DEFAULT: the primary address pool group. FAILOVER: the secondary address pool group.	AUTO
Lines	object
Line	array<object>	The list of source regions for DNS requests.
	object
GroupName	string	The name of the source region group.	Global
LineCode	string	The code of the source region.	default
LineName	string	The name of the source region.	Global
GroupCode	string	The code of the source region group.	DEFAULT

Examples

Success response

JSON format

{
  "FailoverMinAvailableAddrNum": 1,
  "DefaultAddrPoolType": "IPV4",
  "DefaultAvailableAddrNum": 1,
  "StrategyId": "hr***",
  "FailoverAddrPoolGroupStatus": "AVAILABLE",
  "FailoverAvailableAddrNum": 1,
  "FailoverLbaStrategy": "ALL_RR",
  "DefaultMaxReturnAddrNum": 1,
  "StrategyMode": "GEO",
  "CreateTimestamp": 1533773400000,
  "DefaultLbaStrategy": "ALL_RR",
  "DefaultAddrPoolGroupStatus": "AVAILABLE",
  "FailoverAddrPoolType": "IPV4",
  "RequestId": "BA1608CA-834C-4E63-8682-8AF0B11ED72D",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "FailoverAddrPools": {
    "FailoverAddrPool": [
      {
        "LbaWeight": 1,
        "Name": "test",
        "AddrCount": 1,
        "Id": "po**"
      }
    ]
  },
  "DefaultLatencyOptimization": "OPEN",
  "EffectiveAddrPoolGroupType": "DEFAULT",
  "CreateTime": "2018-08-09T00:10Z",
  "DefaultAddrPools": {
    "DefaultAddrPool": [
      {
        "LbaWeight": 1,
        "Name": "test",
        "AddrCount": 1,
        "Id": "po***"
      }
    ]
  },
  "DefaultMinAvailableAddrNum": 1,
  "FailoverLatencyOptimization": "OPEN",
  "StrategyName": "strategyName1",
  "FailoverMaxReturnAddrNum": 1,
  "AccessMode": "AUTO",
  "Lines": {
    "Line": [
      {
        "GroupName": "Global",
        "LineCode": "default",
        "LineName": "Global",
        "GroupCode": "DEFAULT"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.