DescribeOnDemandInstance - 查询代播实例的详细信息-阿里云帮助中心

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

接口说明

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

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
PageNo	integer	是	分页查询时，设置当前页面的页码。	1
PageSize	integer	是	分页查询时，设置每页包含实例的数量。最大值为50。	10
RegionId	string	否	要查询的代播实例的地域ID。说明您可以调用DescribeRegions查询DDoS原生防护支持的所有地域ID。	cn-hangzhou

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

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

返回参数

名称	类型	描述	示例值
	object
Total	string	查询到的代播实例的总数量。	1
RequestId	string	本次请求的ID。	CF33B4C3-196E-4015-AADD-5CAD00057B80
Instances	object []	代播实例的详情。
DefenseStatus	string	代播实例的防护状态。取值： Defense：代播防护已开启，代播IP为资产流量提供牵引和防护。 UnDefense：代播防护已关闭。	Defense
InstanceId	string	代播实例的ID。	ddosbgp-cn-z2q1qzxb****
Remark	string	代播实例的备注信息。	doc-test
RegionId	string	代播实例的地域ID。	cn-hangzhou

示例

正常返回示例

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

错误码

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