DescribeDnsGtmAccessStrategies - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the access strategies for a Global Traffic Manager (GTM) instance.

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:DescribeDnsGtmAccessStrategies

get

*gtmInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Default value: en. Valid values: en, zh, and ja.	en
InstanceId	string	Yes	The instance ID. Call DescribeDnsGtmInstances to obtain the instance ID.	gtm-cn-wwo3a3hbz**
PageNumber	integer	No	The page number. The value starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 20.	1
StrategyMode	string	Yes	The type of the access policy. GEO: Geographic location-based access policy LATENCY: Latency-based access policy	GEO

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page. Maximum value: 100. Default value: 20.	1
RequestId	string	The unique request ID.	0CCC9971-CEC9-4132-824B-4AE611C07623
PageNumber	integer	The page number of the returned page. The value starts from 1. Default value: 1.	1
Strategies	object
Strategy	array<object>	The list of policies.
	object
EffectiveLbaStrategy	string	The load balancing policy for the active address pool group. This parameter is returned only if StrategyMode is set to GEO. ALL_RR: All addresses are returned. RATIO: Addresses are returned based on weights.	ALL_RR
StrategyId	string	The ID of the access policy.	hr***
StrategyName	string	The name of the access policy.	strategname1
EffectiveAddrPoolGroupType	string	The type of the active address pool group: DEFAULT: The primary address pool group. FAILOVER: The secondary address pool group.	DEFAULT
CreateTime	string	The time when the policy was created.	2018-08-09T00:10Z
EffectiveAddrPools	object
EffectiveAddrPool	array<object>	The list of active address pools.
	object	The active address pool.
LbaWeight	integer	The weight.	1
Name	string	The name of the address pool.	test
AddrCount	integer	The number of addresses in the address pool.	3
Id	string	The ID of the address pool.	po***
CreateTimestamp	integer	The time when the policy was created. This is a UNIX timestamp.	1533773400000
EffectiveAddrPoolType	string	The type of the active address pool: IPV4 IPV6 DOMAIN	IPV4
Lines	object
Line	array<object>	The list of source regions for DNS requests. This parameter is returned only if StrategyMode is set to GEO.
	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
TotalPages	integer	The total number of pages returned.	11
TotalItems	integer	The total number of entries returned.	11

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.