Queries the information about on-demand instances.

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 DescribeOnDemandInstanceStatus

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

InstanceIdList.N RepeatList Yes ddosbgp-cn-z2q1qzxb****

The ID of on-demand instance N.

Note You can call the DescribeOnDemandInstance operation to query the IDs of all on-demand instances.
RegionId String No cn-zhangjiakou

The region ID of the on-demand instance.

Note You can call the DescribeRegions operation to query all regions supported by Anti-DDoS Origin.

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
Instances Array of instance

The details of the on-demand instance.

Declared String [{\"region\":\"oe24\",\"declared\":0},{\"region\":\"oe26\",\"declared\":0},{\"region\":\"oe28\",\"declared\":0},{\"region\":\"oi39\",\"declared\":0},{\"region\":\"us50\",\"declared\":0},{\"region\":\"jp141\",\"declared\":0}]

The details of route advertisement for data centers outside mainland China. This parameter is a JSON string. The following fields are included in the value:

  • region: The code of the data center outside mainland China. The value is of the STRING type. For more information, see Codes of data centers outside mainland China.
  • 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.
Desc String test

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.
InstanceId String ddosbgp-cn-z2q1qzxb****

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.
Mode String netflow-auto

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.
Net String 47.***. ***.0/24

The CIDR block of the on-demand instance.

RegistedAs String 0

The number of the autonomous system (AS). Set the value to 0, which indicates that AS is disabled.

UserId String 171986973287****

The ID of the Alibaba Cloud account.

RequestId String CC49FF51-612F-429B-AB1E-374B3F115396

The ID of the request.

Codes of data centers outside mainland China

The following table lists the codes of data centers outside mainland China in which on-demand instances are deployed.

Region

Code

US (Silicon Valley)

oe24, oe25, oc27, and ot7

US (Virginia)

us44-a, us44-b, us68, us50, and us51

China (Hong Kong)

meg, oe26, hk45, and hk71

Singapore (Singapore)

oe28, og37, os30, sg94, sg52, and sg113

Australia (Sydney)

au49, au67, au57, and au58

Germany (Frankfurt)

de46, de81, oe38, and oi39

Russia (Moscow)

ol31, ru85, and ru66

UK (London)

gb82, gb83, gb33, and gb124

India (Mumbai)

in74, in75, in73, and in123

Japan (Tokyo)

jp59, jp42, jp43, jp138, and jp141

Malaysia (Kuala Lumpur)

my86, my87, my88, and my115

Indonesia (Jakarta)

id56, id55, id35, and id90

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeOnDemandInstanceStatus
&InstanceIdList.1=ddosbgp-cn-z2q1qzxb****
&<Common request parameters>

Sample success responses

XML format

<DescribeOnDemandInstanceStatusResponse>
      <Instances>
            <UserId>171986973287****</UserId>
            <Mode>netflow-auto</Mode>
            <RegistedAs>0</RegistedAs>
            <Net>47. ***. ***.0/24</Net>
            <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}]</Declared>
      </Instances>
      <RequestId>CC49FF51-612F-429B-AB1E-374B3F115396</RequestId>
  </DescribeOnDemandInstanceStatusResponse>

JSON format

{
    "Instances": [
        {
            "UserId": "171986973287****",
            "Mode": "netflow-auto",
            "RegistedAs": "0",
            "Net": "47. ***. ***.0/24",
            "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}]"
        }
    ],
    "RequestId": "CC49FF51-612F-429B-AB1E-374B3F115396"
}

Error codes

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