调用DescribeSceneDefenseObjects查询定制场景策略的防护对象。

使用说明

本接口用于查询定制场景策略的防护对象。

调用本接口前,您必须已经调用CreateSceneDefensePolicy创建了定制场景策略。

QPS限制

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

调试

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

请求参数

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

要执行的操作。取值:DescribeSceneDefenseObjects

PolicyId String 47e07ebd-0ba5-4afc-957b-59d15b90****

要查询的策略ID。

说明 您可以调用DescribeSceneDefensePolicies查询所有策略ID。
RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,即DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,即DDoS高防(国际)实例。
ResourceGroupId String rg-acfm2pz25js****

DDoS高防实例在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

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

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

返回数据

名称 类型 示例值 描述
Success Boolean true

本次请求是否成功调用。取值:

  • true:表示调用成功。
  • false:表示调用失败。
RequestId String FE07E73F-F19E-4A51-B62F-AC59E3B962D8

本次请求的ID。

Objects Array of Object

定制场景策略的防护对象信息。

Domain String www.aliyundoc.com

策略防护的域名。

PolicyId String 47e07ebd-0ba5-4afc-957b-59d15b90****

定制场景策略的ID。

Vip String 203.XX.XX.119

策略防护的高防实例IP。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSceneDefenseObjects
&PolicyId=47e07ebd-0ba5-4afc-957b-59d15b90****
&公共请求参数

正常返回示例

XML格式

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

<DescribeSceneDefenseObjectsResponse>
    <Success>true</Success>
    <RequestId>FE07E73F-F19E-4A51-B62F-AC59E3B962D8</RequestId>
    <Objects>
        <Domain>www.aliyundoc.com</Domain>
        <PolicyId>47e07ebd-0ba5-4afc-957b-59d15b90****</PolicyId>
    </Objects>
</DescribeSceneDefenseObjectsResponse>

JSON格式

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

{
  "Success" : true,
  "RequestId" : "FE07E73F-F19E-4A51-B62F-AC59E3B962D8",
  "Objects" : [ {
    "Domain" : "www.aliyundoc.com",
    "PolicyId" : "47e07ebd-0ba5-4afc-957b-59d15b90****"
  } ]
}

错误码

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