DescribeGtmAccessStrategies - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the access policies for an 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:DescribeGtmAccessStrategies

get

*gtminstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response.	en
InstanceId	string	No	The ID of the instance.	gtm-cn-wwo3a3hbz**
PageNumber	integer	No	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned on each page.	20
RequestId	string	The unique ID of the request.	0CCC9971-CEC9-4132-824B-4AE611C07623
PageNumber	integer	The page number of the returned page.	1
Strategies	object
Strategy	array<object>	A list of access policies.
	object
AccessMode	string	The access mode. Valid values: AUTO: automatic switchover DEFAULT: primary address pool collection FAILOVER: secondary address pool collection	AUTO
StrategyName	string	The name of the access policy.	Access policy
DefaultAddrPoolMonitorStatus	string	The health check status of the primary address pool collection. Valid values: OPEN: enabled CLOSE: disabled UNCONFIGURED: not configured	OPEN
StrategyMode	string	The type of the access policy. Valid values: GEO: geolocation-based LATENCY: latency-based	GEO
CreateTime	string	The time when the access policy was created.	2018-08-09T00:10Z
DefaultAddrPoolStatus	string	The availability of the primary address pool collection. Valid values: AVAILABLE: available NOT_AVAILABLE: unavailable	AVAILABLE
InstanceId	string	The ID of the associated instance.	gtm-cn-wwo3a3hbz**
Lines	object
Line	array<object>	A list of source lines.
	object
GroupName	string	The name of the source line group.	Global
LineCode	string	The code of the source line.	default
LineName	string	The name of the source line.	Global
GroupCode	string	The code of the source line group.	DEFAULT
FailoverAddrPoolId	string	The ID of the secondary address pool collection.	hra0i2
DefaultAddrPoolId	string	The ID of the primary address pool collection.	hra0i1
StrategyId	string	The ID of the access policy.	hra0hs
FailoverAddrPoolStatus	string	The availability of the secondary address pool collection. Valid values: AVAILABLE: available NOT_AVAILABLE: unavailable	AVAILABLE
AccessStatus	string	The access status. Valid values: DEFAULT: The primary address pool collection is being accessed. FAILOVER: The secondary address pool collection is being accessed.	DEFAULT
FailoverAddrPoolMonitorStatus	string	The health check status of the secondary address pool collection. Valid values: OPEN: enabled CLOSE: disabled UNCONFIGURED: not configured	OPEN
DefaultAddrPoolName	string	The name of the primary address pool collection.	Address pool 1
FailoverAddrPoolName	string	The name of the secondary address pool collection.	Address pool 2
CreateTimestamp	integer	The timestamp that indicates when the access policy was created.	1533773400000
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of entries.	1

Examples

Success response

JSON format

{
  "PageSize": 20,
  "RequestId": "0CCC9971-CEC9-4132-824B-4AE611C07623",
  "PageNumber": 1,
  "Strategies": {
    "Strategy": [
      {
        "AccessMode": "AUTO",
        "StrategyName": "访问策略",
        "DefaultAddrPoolMonitorStatus": "OPEN",
        "StrategyMode": "GEO",
        "CreateTime": "2018-08-09T00:10Z",
        "DefaultAddrPoolStatus": "AVAILABLE",
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "Lines": {
          "Line": [
            {
              "GroupName": "Global",
              "LineCode": "default",
              "LineName": "Global",
              "GroupCode": "DEFAULT"
            }
          ]
        },
        "FailoverAddrPoolId": "hra0i2",
        "DefaultAddrPoolId": "hra0i1",
        "StrategyId": "hra0hs",
        "FailoverAddrPoolStatus": "AVAILABLE",
        "AccessStatus": "DEFAULT",
        "FailoverAddrPoolMonitorStatus": "OPEN",
        "DefaultAddrPoolName": "地址池1",
        "FailoverAddrPoolName": "地址池2",
        "CreateTimestamp": 1533773400000
      }
    ]
  },
  "TotalPages": 1,
  "TotalItems": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.