DescribeOnDemandInstanceStatus - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the information about on-demand instances.

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.

debugging

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-antiddosbag:DescribeOnDemandInstanceStatus	Read	DdosBgp acs:yundun-antiddosbag:{#regionId}:{#accountId}:*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the on-demand instance. Note You can call the DescribeRegions operation to query all regions supported by Anti-DDoS Origin.	cn-zhangjiakou
InstanceIdList	array	Yes	The IDs of on-demand instances. Note You can call the DescribeOnDemandInstance operation to query the IDs of all on-demand instances.
	string	Yes	The ID of on-demand instance.	ddosbgp-cn-z2q1qzxb****

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
RequestId	string	The ID of the request.	CC49FF51-612F-429B-AB1E-374B3F115396
Instances	object []	The details of the on-demand instance.
UserId	string	The ID of the Alibaba Cloud account.	171986973287****
Mode	string	The mode used to start the on-demand instance. Valid values: manual: The instance is manually started. netflow-auto: The instance is automatically started by using NetFlow that monitors network traffic.	netflow-auto
InstanceId	string	The ID of the on-demand instance. Note The value of this parameter is returned only when the information about multiple on-demand instances is returned. The value of this parameter is not returned because the information about only one on-demand instance is returned.	ddosbgp-cn-z2q1qzxb****
Declared	string	The details of route advertisement for data centers outside the Chinese mainland. This parameter is a JSON string. The following fields are included in the value: region: The code of the data center outside the Chinese mainland. The value is of the STRING type. For more information, see Codes of data centers outside the Chinese mainland. declared: indicates whether the data center advertised the route. The value is of the STRING type. Valid values: 0 and 1. The value of 0 indicates that the data center did not advertise the route. The value of 1 indicates that the data center advertised the route.	[{\"region\":\"oe24\",\"declared\":0},{\"region\":\"oe26\",\"declared\":0},{\"region\":\"oe28\",\"declared\":0},{\"region\":\"oi39\",\"declared\":0},{\"region\":\"us50\",\"declared\":0},{\"region\":\"jp141\",\"declared\":0}]
RegistedAs	string	The number of the autonomous system (AS). Set the value to 0, which indicates that AS is disabled.	0
Net	string	The CIDR block of the on-demand instance.	47.*.*.0/24
Desc	string	The description of the on-demand instance. Note The value of this parameter is returned only when the information about multiple on-demand instances is returned. The value of this parameter is not returned because the information about only one on-demand instance is returned.	test

Examples

Sample success responses

JSONformat

{
  "RequestId": "CC49FF51-612F-429B-AB1E-374B3F115396",
  "Instances": [
    {
      "UserId": "171986973287****",
      "Mode": "netflow-auto",
      "InstanceId": "ddosbgp-cn-z2q1qzxb****",
      "Declared": "[{\\\"region\\\":\\\"oe24\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"oe26\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"oe28\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"oi39\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"us50\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"jp141\\\",\\\"declared\\\":0}]",
      "RegistedAs": "0",
      "Net": "47.***.***.0/24",
      "Desc": "test"
    }
  ]
}

Error codes

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