DescribeGtmAccessStrategy - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the details of an access policy based on the policy ID.

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:DescribeGtmAccessStrategy

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
StrategyId	string	Yes	The ID of the access policy.	hra0hs

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	BA1608CA-834C-4E63-8682-8AF0B11ED72D
InstanceId	string	The ID of the associated Global Traffic Manager (GTM) instance.	gtm-cn-wwo3a3hbz**
StrategyId	string	The policy ID.	hra0hs
DefaultAddrPoolStatus	string	The availability status of the primary address pool group. Valid values: AVAILABLE: The address pool group is available. NOT_AVAILABLE: The address pool group is unavailable.	AVAILABLE
FailoverAddrPoolId	string	The ID of the secondary address pool group. If no secondary address pool group is configured, EMPTY is returned.	hra0i2
AccessStatus	string	The access status. Valid values: DEFAULT: Normal. Access requests are routed to the primary address pool group. FAILOVER: Abnormal. Access requests are routed to the secondary address pool group.	DEFAULT
DefaultAddrPoolMonitorStatus	string	The health check status of the primary address pool group. Valid values: OPEN: Enabled CLOSE: Disabled UNCONFIGURED: Not configured	OPEN
DefaultAddrPoolName	string	The name of the primary address pool group.	地址池1
DefultAddrPoolId	string	The ID of the primary address pool group.	hra0i1
StrategyName	string	The name of the access policy.	全局
FailoverAddrPoolStatus	string	The availability status of the secondary address pool group. Valid values: AVAILABLE: The address pool group is available. NOT_AVAILABLE: The address pool group is unavailable.	AVAILABLE
AccessMode	string	The switchover policy for the address pool groups: AUTO: Automatic switchover DEFAULT: Primary address pool group FAILOVER: Secondary address pool group	AUTO
StrategyMode	string	The policy mode. SELF_DEFINED indicates a custom policy.	SELF_DEFINED
FailoverAddrPoolMonitorStatus	string	The health check status of the secondary address pool group. Valid values: OPEN: Enabled CLOSE: Disabled UNCONFIGURED: Not configured	OPEN
FailoverAddrPoolName	string	The name of the secondary address pool group.	地址池2
Lines	object
Line	array<object>	The list of source regions for DNS requests.
	object
GroupName	string	The name of the source region group for DNS requests.	Global
LineCode	string	The code of the source region for DNS requests.	default
LineName	string	The name of the source region for DNS requests.	Global
GroupCode	string	The code of the source region group for DNS requests.	DEFAULT

Examples

Success response

JSON format

{
  "RequestId": "BA1608CA-834C-4E63-8682-8AF0B11ED72D",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "StrategyId": "hra0hs",
  "DefaultAddrPoolStatus": "AVAILABLE",
  "FailoverAddrPoolId": "hra0i2",
  "AccessStatus": "DEFAULT",
  "DefaultAddrPoolMonitorStatus": "OPEN",
  "DefaultAddrPoolName": "地址池1",
  "DefultAddrPoolId": "hra0i1",
  "StrategyName": "全局",
  "FailoverAddrPoolStatus": "AVAILABLE",
  "AccessMode": "AUTO",
  "StrategyMode": "SELF_DEFINED",
  "FailoverAddrPoolMonitorStatus": "OPEN",
  "FailoverAddrPoolName": "地址池2",
  "Lines": {
    "Line": [
      {
        "GroupName": "Global",
        "LineCode": "default",
        "LineName": "Global",
        "GroupCode": "DEFAULT"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.