DescribeInstanceStatus - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the status of a specified Anti-DDoS Proxy 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
yundun-ddoscoo:DescribeInstanceStatus	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Anti-DDoS Proxy instance to query. Note You can call the DescribeInstanceIds operation to query the IDs of all Anti-DDoS Proxy (Chinese Mainland) or Anti-DDoS Proxy (Outside Chinese Mainland) instances.	ddoscoo-cn-6ja1y6p5****
ProductType	integer	Yes	The type of the Anti-DDoS Proxy instance to query. Valid values: 1: an Anti-DDoS Proxy (Chinese Mainland) instance 2: an Anti-DDoS Proxy (Outside Chinese Mainland) 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

Parameter	Type	Description	Example
	object
InstanceStatus	integer	The status of the instance. Valid values: 1: normal 2: expired 3: overdue 4: released	1
RequestId	string	The ID of the request.	112777CC-2AD6-46FC-A263-00B931406FCD
InstanceId	string	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.