Queries the information about on-demand instances.

Note On-demand instances protect servers in on-premises data centers deployed outside mainland China and cloud assets based on Classless Inter-Domain Routing (CIDR) blocks. You must contact sales personnel to purchase 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 DescribeOnDemandInstance

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

PageNo Integer Yes 1

The number of the page to return. Default value: 1.

PageSize Integer Yes 10

The number of entries to return on each page. Maximum value:50. Default value: 10.

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.
DefenseStatus String Defense

The protection status of the on-demand instance. Valid values:

  • Defense: The on-demand instance is protecting your assets, which indicates that traffic is routed to the on-demand instance.
  • UnDefense: The on-demand instance does not protect your assets.
InstanceId String ddosbgp-cn-z2q1qzxb****

The ID of the on-demand instance.
Ipnet List 47.***. ***.0/24

The CIDR block of the on-demand instance.
RegionId String cn-zhangjiakou

The region ID of the on-demand instance.
Remark String 123

The description of the on-demand instance.
RequestId String CF33B4C3-196E-4015-AADD-5CAD00057B80

The ID of the request.
Total String 1

The total number of the on-demand instances.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeOnDemandInstance
&PageNo=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format 

<DescribeOnDemandInstanceResponse>
      <RequestId>CF33B4C3-196E-4015-AADD-5CAD00057B80</RequestId>
      <Total>1</Total>
      <Instances>
            <InstanceId>ddosbgp-cn-z2q1qzxb****</InstanceId>
            <Ipnet>47. ***. ***.0/24</Ipnet>
            <Remark>123</Remark>
            <RegionId>cn-zhangjiakou</RegionId>
            <DefenseStatus>Defense</DefenseStatus>
      </Instances>
</DescribeOnDemandInstanceResponse>

JSON format 

{
    "RequestId": "CF33B4C3-196E-4015-AADD-5CAD00057B80",
    "Total": "1",
    "Instances": [
        {
            "InstanceId": "ddosbgp-cn-z2q1qzxb****",
            "Ipnet": [
                "47. ***. ***.0/24"
            ],
            "Remark": "123",
            "RegionId": "cn-zhangjiakou",
            "DefenseStatus": "Defense"
        }
    ]
}

Error codes

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