All Products
Search
Document Center

Anti-DDoS:DescribeInstanceStatus

Last Updated:Apr 29, 2024

Queries the status of a specified Anti-DDoS Proxy instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
yundun-ddoscoo:DescribeInstanceStatusRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance to query.

Note You can call the DescribeInstanceIds operation to query the IDs of all Anti-DDoS Pro or Anti-DDoS Premium instances.
ddoscoo-cn-6ja1y6p5****
ProductTypeintegerYes

The type of the instance to query. Valid values:

  • 1: an Anti-DDoS Pro instance
  • 2: an Anti-DDoS Premium instance
1

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

ParameterTypeDescriptionExample
object
InstanceStatusinteger

The status of the instance. Valid values:

  • 1: normal
  • 2: expired
  • 3: overdue
  • 4: released
1
RequestIdstring

The ID of the request.

112777CC-2AD6-46FC-A263-00B931406FCD
InstanceIdstring

The ID of the instance.

ddoscoo-cn-6ja1y6p5****

Examples

Sample success responses

JSONformat

{
  "InstanceStatus": 1,
  "RequestId": "112777CC-2AD6-46FC-A263-00B931406FCD",
  "InstanceId": "ddoscoo-cn-6ja1y6p5****"
}

Error codes

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