All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDnsGtmAccessStrategies

Last Updated:Mar 15, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeDnsGtmAccessStrategiesREAD
  • gtmInstance
    acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.

en
InstanceIdstringYes

The ID of the instance.

instance1
PageNumberintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

1
StrategyModestringYes

The type of the access policy. Valid values:

  • GEO: geographical location-based
  • LATENCY: latency-based
geo

Response parameters

ParameterTypeDescriptionExample
object
TotalPagesinteger

The total number of pages returned.

11
TotalItemsinteger

The total number of entries returned on all pages.

11
PageSizeinteger

The number of entries returned per page.

1
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

0CCC9971-CEC9-4132-824B-4AE611C07623
Strategiesobject []

The access policies.

EffectiveLbaStrategystring

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
StrategyIdstring

The ID of the access policy.

strategyid1
StrategyNamestring

The name of the access policy.

strategname1
EffectiveAddrPoolGroupTypestring

The type of the active address pool group. Valid values:

  • DEFAULT: the primary address pool group
  • FAILOVER: the secondary address pool group
default
CreateTimestring

The time when the access policy was created.

2018-08-09T00:10Z
CreateTimestamplong

The timestamp that indicates when the access policy was created.

1533773400000
EffectiveAddrPoolTypestring

The type of the active address pools. Valid values:

  • IPV4
  • IPV6
  • DOMAIN
ipv4
Linesobject []

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

GroupNamestring

The name of the source region group.

global
LineCodestring

The line code of the source region.

default
LineNamestring

The line name of the source region.

global
GroupCodestring

The code of the source region group.

default
EffectiveAddrPoolsobject []

The active address pool groups.

Namestring

The name of the address pool.

test
AddrCountinteger

The number of addresses in the address pool.

3
LbaWeightinteger

The weight of the address pool.

1
Idstring

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.