Queries the status of an Anti-DDoS Pro or Anti-DDoS Premium 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 DescribeInstanceStatus

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

InstanceId String Yes ddoscoo-cn-6ja1y6p5****

The ID of the instance that you want to query.

Note You can call the DescribeInstanceIds operation to query the IDs of all Anti-DDoS Pro or Anti-DDoS Premium instances.
ProductType Integer Yes 1

The type of the instance that you want to query. Valid values:

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

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

Parameter Type Example Description
InstanceId String ddoscoo-cn-6ja1y6p5****

The ID of the instance.

InstanceStatus Integer 1

The status of the instance. Valid values:

  • 1: normal
  • 2: expired
  • 3: overdue
  • 4: released
RequestId String 112777CC-2AD6-46FC-A263-00B931406FCD

The ID of the request.

Examples

Sample request

http(s)://[Endpoint]/? Action=DescribeInstanceStatus
&InstanceId=ddoscoo-cn-6ja1y6p5****
&ProductType=1
&<Common request parameters>

Sample success responses

XML format

<DescribeInstanceStatusResponse>
	  <RequestId>112777CC-2AD6-46FC-A263-00B931406FCD</RequestId>
	  <InstanceId>ddoscoo-cn-6ja1y6p5****</InstanceId>
	  <InstanceStatus>1</InstanceStatus>
</DescribeInstanceStatusResponse>

JSON format

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

Error codes

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