DescribeGtmAccessStrategies - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

You can call this operation to query the access policies of a Global Traffic Manager (GTM) instance.

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:DescribeGtmAccessStrategies	get	gtminstance acs:alidns::{#accountId}:gtminstance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language used by the user.	en
InstanceId	string	No	The ID of the GTM instance whose access policies you want to query.	instance1
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return per page.	20

Response parameters

Parameter	Type	Description	Example
	object
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of entries returned on all pages.	1
PageSize	integer	The number of entries returned per page.	20
PageNumber	integer	The number of the page returned.	1
RequestId	string	The ID of the request.	0CCC9971-CEC9-4132-824B-4AE611C07623
Strategies	array<object>	The returned list of access policies of the GTM instance.
Strategy	object
StrategyName	string	The name of the access policy.
AccessMode	string	The access policy. Valid values: AUTO: Automatic switch DEFAULT: Default address pool FAILOVER: Failover address pool	DEFAULT
DefaultAddrPoolMonitorStatus	string	Indicates whether health check was enabled for the default address pool. Valid values: OPEN: Enabled CLOSE: Disabled UNCONFIGURED: Not configured	OPEN
CreateTime	string	The time when the access policy was created.	2018-08-09T00:10Z
StrategyMode	string	The mode of the access policy. SELF_DEFINED indicates that the access policy is user-defined.	SELF_DEFINED
DefaultAddrPoolStatus	string	The availability status of the default address pool. Valid values: AVAILABLE: Available NOT_AVAILABLE: Unavailable	AVAILABLE
InstanceId	string	The ID of the GTM instance whose access policies you want to query.	instance1
DefaultAddrPoolId	string	The ID of the default address pool.	hra0i1
FailoverAddrPoolId	string	The ID of the failover address pool.	hra0i2
StrategyId	string	The ID of the access policy.	hra0hs
FailoverAddrPoolStatus	string	The availability status of the failover address pool.	AVAILABLE
AccessStatus	string	The access status. Valid values: DEFAULT: The default address pool is currently accessed. FAILOVER: The failover address pool is currently accessed.	DEFAULT
FailoverAddrPoolMonitorStatus	string	Indicates whether health check was 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.
LineCode	string	The code for the line of the access region.	default
LineName	string	The name for the line of the access region.
GroupCode	string	The code of the access region group.	DEFAULT

Examples

Sample success responses

JSONformat

{
  "TotalPages": 1,
  "TotalItems": 1,
  "PageSize": 20,
  "PageNumber": 1,
  "RequestId": "0CCC9971-CEC9-4132-824B-4AE611C07623",
  "Strategies": {
    "Strategy": [
      {
        "StrategyName": "",
        "AccessMode": "DEFAULT",
        "DefaultAddrPoolMonitorStatus": "OPEN",
        "CreateTime": "2018-08-09T00:10Z",
        "StrategyMode": "SELF_DEFINED",
        "DefaultAddrPoolStatus": "AVAILABLE",
        "InstanceId": "instance1",
        "DefaultAddrPoolId": "hra0i1",
        "FailoverAddrPoolId": "hra0i2",
        "StrategyId": "hra0hs",
        "FailoverAddrPoolStatus": "AVAILABLE",
        "AccessStatus": "DEFAULT",
        "FailoverAddrPoolMonitorStatus": "OPEN",
        "DefaultAddrPoolName": "",
        "FailoverAddrPoolName": "",
        "CreateTimestamp": 1533773400000,
        "Lines": {
          "Line": [
            {
              "GroupName": "",
              "LineCode": "default",
              "LineName": "",
              "GroupCode": "DEFAULT"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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