DescribeDnsGtmInstanceStatus - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the status 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:DescribeDnsGtmInstanceStatus	get	gtmInstance acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.	en
InstanceId	string	Yes	The ID of the instance.	instance1

Response parameters

Parameter	Type	Description	Example
	object
StrategyNotAvailableNum	integer	The number of access policies that are unavailable in the current active address pool group.	1
AddrAvailableNum	integer	The number of available addresses.	1
RequestId	string	The ID of the request.	389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA
SwitchToFailoverStrategyNum	integer	The number of access policies switched to the secondary address pool group.	1
AddrNotAvailableNum	integer	The number of unavailable addresses.	1
AddrPoolGroupNotAvailableNum	integer	The number of unavailable address pool groups.	1

Examples

Sample success responses

JSONformat

{
  "StrategyNotAvailableNum": 1,
  "AddrAvailableNum": 1,
  "RequestId": "389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA",
  "SwitchToFailoverStrategyNum": 1,
  "AddrNotAvailableNum": 1,
  "AddrPoolGroupNotAvailableNum": 1
}

Error codes

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