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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeGtmInstanceStatus

The operation that you want to perform. Set the value to DescribeGtmInstanceStatus.

InstanceId String Yes instance1

The ID of the GTM instance whose status you want to query.

Lang String No en

The language used by the user.

Response parameters

Parameter Type Example Description
AddrNotAvailableNum Integer 10

The number of unavailable addresses.

AddrPoolNotAvailableNum Integer 10

The number of unavailable address pools.

RequestId String 389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA

The ID of the request.

StrategyNotAvailableNum Integer 10

The number of access policies that are unavailable in the current address pool.

SwitchToFailoverStrategyNum Integer 10

The number of access policies switched to the failover address pool.

Examples

Sample requests


http(s)://alidns.aliyuncs.com/? Action=DescribeGtmInstanceStatus
&InstanceId=instance1
&<Common request parameters>

Sample success responses

XML format

<DescribeGtmInstanceStatusResponse>
	  <RequestId>389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA</RequestId>
	  <AddrNotAvailableNum>10</AddrNotAvailableNum>
	  <AddrPoolNotAvailableNum>10</AddrPoolNotAvailableNum>
	  <SwitchToFailoverStrategyNum>10</SwitchToFailoverStrategyNum>
	  <StrategyNotAvailableNum>10</StrategyNotAvailableNum>
</DescribeGtmInstanceStatusResponse>

JSON format

{
	"StrategyNotAvailableNum":10,
	"RequestId":"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA",
	"SwitchToFailoverStrategyNum":10,
	"AddrPoolNotAvailableNum":10,
	"AddrNotAvailableNum":10
}

Error codes

For a list of error codes, visit the API Error Center.