All Products
Search
Document Center

Alibaba Cloud DNS:DescribeGtmAccessStrategy

Last Updated:Mar 15, 2024

You can call this operation to query the details about an access policy of a Global Traffic Manager (GTM) instance based on the policy ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language used by the user.

en
StrategyIdstringYes

The ID of the access policy that you want to query.

hra0hs

Response parameters

ParameterTypeDescriptionExample
object
StrategyNamestring

The name of the access policy queried.

AccessModestring

The access policy.

AUTO
DefaultAddrPoolMonitorStatusstring

Indicates whether health check is enabled for the default address pool.

OPEN
StrategyModestring

The mode of traffic scheduling.

SELF_DEFINED
DefaultAddrPoolStatusstring

The availability status of the default address pool.

AVAILABLE
DefultAddrPoolIdstring

The ID of the default address pool.

hra0i1
InstanceIdstring

The ID of the GTM instance whose access policy details you want to query.

instance1
FailoverAddrPoolIdstring

The ID of the failover address pool.

hra0i2
StrategyIdstring

The ID of the access policy queried.

hra0hs
RequestIdstring

The ID of the request.

BA1608CA-834C-4E63-8682-8AF0B11ED72D
FailoverAddrPoolStatusstring

The availability status of the failover address pool.

AVAILABLE
AccessStatusstring

The access status. Valid values:

  • DEFAULT: Indicates normal when the default address pool is accessed.
  • FAILOVER: Indicates an exception when a failover address pool is accessed.
DEFAULT
FailoverAddrPoolMonitorStatusstring

Indicates whether health check is enabled for the failover address pool.

OPEN
DefaultAddrPoolNamestring

The name of the default address pool.

FailoverAddrPoolNamestring

The name of the failover address pool.

Linesobject []

The returned lines of access regions.

GroupNamestring

The name of the access region group.

Global
LineCodestring

The code for the line of the access region.

default
LineNamestring

The name for the line of the access region.

Global
GroupCodestring

The code of the access region group.

DEFAULT

Examples

Sample success responses

JSONformat

{
  "StrategyName": "",
  "AccessMode": "AUTO",
  "DefaultAddrPoolMonitorStatus": "OPEN",
  "StrategyMode": "SELF_DEFINED",
  "DefaultAddrPoolStatus": "AVAILABLE",
  "DefultAddrPoolId": "hra0i1",
  "InstanceId": "instance1",
  "FailoverAddrPoolId": "hra0i2",
  "StrategyId": "hra0hs",
  "RequestId": "BA1608CA-834C-4E63-8682-8AF0B11ED72D",
  "FailoverAddrPoolStatus": "AVAILABLE",
  "AccessStatus": "DEFAULT",
  "FailoverAddrPoolMonitorStatus": "OPEN",
  "DefaultAddrPoolName": "",
  "FailoverAddrPoolName": "",
  "Lines": {
    "Line": [
      {
        "GroupName": "Global",
        "LineCode": "default",
        "LineName": "Global",
        "GroupCode": "DEFAULT"
      }
    ]
  }
}

Error codes

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