Queries the information of an on-demand instance.

Note Anti-DDoS Origin API operations are available only for Anti-DDoS Origin Enterprise users.

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.

DdosRegionId String No cn-hangzhou

The ID of the region that you want to query.

Note You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
RequestId String CF33B4C3-196E-4015-AADD-5CAD00057B80

The ID of the request.
Total String 1

The total number of on-demand instances.
Instances Array

Information of on-demand instances.
InstanceId String ddosbgp-xxx

The ID of the instance.
Remark String 123

The remark of the on-demand instance.
DefenseStatus String Defense

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

  • Defense: rerouting enabled
  • UnDefense: rerouting disabled
Ipnet List 1.1.1.0/24

The CIDR block of the on-demand instance.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeOnDemandInstanceResponse>
     <code>200</code>
     <data>
          <DefenseStatus>Defense</DefenseStatus>
          <InstanceId>ddosbgp-xxx</InstanceId>
          <Ipnet>
               <element>1.1.1.0/24</element>
          </Ipnet>
          <Remark>123</Remark>
     </data>
     <Total>1</Total>
     <requestId>CF33B4C3-196E-4015-AADD-5CAD00057B80</requestId>
     <success>true</success>
</DescribeOnDemandInstanceResponse>

JSON format 

{  
    "code": 200,
    "requestId": "CF33B4C3-196E-4015-AADD-5CAD00057B80",
    "Total":"1",
    "success": true,
    "data": {
            "InstanceId":"ddosbgp-xxx",
            "Ipnet": ["1.1.1.0/24"],
            "Remark": "123",
            "DefenseStatus": "Defense"    }
}

Error codes

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