DescribeGtmAccessStrategy - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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

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:DescribeGtmAccessStrategy	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language used by the user.	en
StrategyId	string	Yes	The ID of the access policy that you want to query.	hra0hs

Response parameters

Parameter	Type	Description	Example
	object
StrategyName	string	The name of the access policy queried.
AccessMode	string	The access policy.	AUTO
DefaultAddrPoolMonitorStatus	string	Indicates whether health check is enabled for the default address pool.	OPEN
StrategyMode	string	The mode of traffic scheduling.	SELF_DEFINED
DefaultAddrPoolStatus	string	The availability status of the default address pool.	AVAILABLE
DefultAddrPoolId	string	The ID of the default address pool.	hra0i1
InstanceId	string	The ID of the GTM instance whose access policy details you want to query.	instance1
FailoverAddrPoolId	string	The ID of the failover address pool.	hra0i2
StrategyId	string	The ID of the access policy queried.	hra0hs
RequestId	string	The ID of the request.	BA1608CA-834C-4E63-8682-8AF0B11ED72D
FailoverAddrPoolStatus	string	The availability status of the failover address pool.	AVAILABLE
AccessStatus	string	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
FailoverAddrPoolMonitorStatus	string	Indicates whether health check is enabled for the failover address pool.	OPEN
DefaultAddrPoolName	string	The name of the default address pool.
FailoverAddrPoolName	string	The name of the failover address pool.
Lines	array<object>	The returned lines of access regions.
Line	object
GroupName	string	The name of the access region group.	Global
LineCode	string	The code for the line of the access region.	default
LineName	string	The name for the line of the access region.	Global
GroupCode	string	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.