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

说明 DDoS防护包的API接口目前仅对企业版DDoS防护包用户开放。

调试

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

请求参数

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

要执行的操作。取值:DescribeOnDemandInstance

PageNo Integer 1

列表的页码,默认值为1

PageSize Integer 10

分页查询时每页的行数,最大值为50,默认值为10

DdosRegionId String cn-hangzhou

要查询的地域ID。

说明 您可以调用 DescribeRegions 查询所有地域信息。

返回数据

名称 类型 示例值 描述
RequestId String CF33B4C3-196E-4015-AADD-5CAD00057B80

本次请求的ID。

Total String 1

代播实例的总数。

Instances Array

代播实例信息。

InstanceId String ddosbgp-xxx

实例ID。

Remark String 123

实例备注。

DefenseStatus String Defense

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

  • Defense:牵引中
  • UnDefense:未牵引
Ipnet List 1.1.1.0/24

代播实例的IP网段。

示例

请求示例

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

正常返回示例

XML 格式

<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 格式

{  
    "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"
    }
}

错误码

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