All Products
Search
Document Center

:DescribeOnDemandInstance

Last Updated:Jun 09, 2023

Queries the information about on-demand instances.

Operation Description

Queries the information about on-demand instances, such as whether an on-demand instance is enabled and the CIDR block of each on-demand instance.

Limits

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNointegerYes

The page number of the page to return.

1
PageSizeintegerYes

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

10
RegionIdstringNo

The region ID of the on-demand instance that you want to query.

NoteYou can call the DescribeRegions operation to query the most recent region list.
cn-zhangjiakou

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

ParameterTypeDescriptionExample
object
Totalstring

The number of entries that were returned.

1
RequestIdstring

The ID of the request.

CF33B4C3-196E-4015-AADD-5CAD00057B80
Instancesobject []

The details of the on-demand instance.

DefenseStatusstring

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.
Defense
InstanceIdstring

The ID of the on-demand instance.

ddosbgp-cn-z2q1qzxb****
Remarkstring

The description of the on-demand instance.

123
RegionIdstring

The region ID of the on-demand instance.

cn-zhangjiakou
Ipnetarray

The CIDR block of the on-demand instance.

string
47.***.***.0/24

Examples

Sample success responses

JSONformat

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

Error codes

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