调用DescribeOnDemandInstance查询代播实例的详细信息。

使用说明

本接口用于查询代播实例的详细信息,例如,是否已开启代播防护、代播网段等。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeOnDemandInstance

要执行的操作。取值:DescribeOnDemandInstance

PageNo Integer 1

分页查询时,设置当前页面的页码。

PageSize Integer 10

分页查询时,设置每页包含实例的数量。最大值为50

RegionId String cn-hangzhou

要查询的代播实例的地域ID。

说明 您可以调用DescribeRegions查询DDoS原生防护支持的所有地域ID。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
Total String 1

查询到的代播实例的总数量。

RequestId String CF33B4C3-196E-4015-AADD-5CAD00057B80

本次请求的ID。

Instances Array of Instance

代播实例的详情。

DefenseStatus String Defense

代播实例的防护状态。取值:

  • Defense:代播防护已开启,代播IP为资产流量提供牵引和防护。
  • UnDefense:代播防护已关闭。
InstanceId String ddosbgp-cn-z2q1qzxb****

代播实例的ID。

Remark String doc-test

代播实例的备注信息。

RegionId String cn-hangzhou

代播实例的地域ID。

Ipnet Array of String 47.XX.XX.0/24

代播网段。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeOnDemandInstance
&PageNo=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

访问错误中心查看更多错误码。