All Products
Search
Document Center

Alibaba Cloud DNS:DescribeGtmInstanceStatus

Last Updated:Oct 11, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeGtmInstanceStatusget
  • GtmInstance
    acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language.

en
InstanceIdstringYes

The instance ID.

instance1

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

The state of the instance. Valid values:

  • ALLOW: The operation on the instance is allowed.
  • DENY: The operation on the instance is not allowed.
ALLOW
StrategyNotAvailableNuminteger

The number of unavailable access policies.

10
RequestIdstring

The request ID.

389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA
SwitchToFailoverStrategyNuminteger

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

10
StatusReasonstring

The reasons why the instance is in the current state. Valid values:

  • INSTANCE_OPERATE_BLACK_LIST: The operation on the instance is not allowed.
  • BETA_INSTANCE: The instance is in public preview.
["BETA_INSTANCE"]
AddrNotAvailableNuminteger

The number of unavailable addresses.

10
AddrPoolNotAvailableNuminteger

The number of unavailable address pools.

10

Examples

Sample success responses

JSONformat

{
  "Status": "ALLOW",
  "StrategyNotAvailableNum": 10,
  "RequestId": "389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA",
  "SwitchToFailoverStrategyNum": 10,
  "StatusReason": "[\"BETA_INSTANCE\"]",
  "AddrNotAvailableNum": 10,
  "AddrPoolNotAvailableNum": 10
}

Error codes

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