DescribeCustomScenePolicies - 查询定制场景策略

查询定制场景策略配置。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:DescribeCustomScenePoliciesget
*全部资源
*

请求参数

名称类型必填描述示例值
PageSizeinteger

分页大小,默认值 10,可选值:5,10,20。

10
PageNumberinteger

页码。取值范围为:1~100000。

1
PolicyIdlong

策略 ID,可通过调用 ListWafRulesets 接口查询获取。

1234****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

85H66C7B-671A-4297-9187-2C4477247A74
TotalCountinteger

返回数据的总条数。

1
Quotainteger

配置额度。

10
PageNumberinteger

页码。

1
PageSizeinteger

分页大小。

10
DataModulearray<object>

定制场景策略配置信息列表。

Itemobject

定制场景策略配置信息。

Namestring

定制场景策略名称。

test
Templatestring

模板名称。取值:

  • promotion:重大活动
promotion
StartTimestring

策略生效开始时间。

日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-03-04T16:00:00Z
EndTimestring

策略生效结束时间。

日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-03-06T16:00:00Z
Statusstring

策略的生效状态,取值:

  • Disabled:已被禁用
  • Pending:等待生效
  • Running:运行生效
  • Expired:过期失效
Expired
Objectsarray

策略关联的站点 ID 列表。

objectstring

策略关联的站点 ID。

123456****
PolicyIdlong

策略 ID。

1234****

示例

正常返回示例

JSON格式

{
  "RequestId": "85H66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount": 1,
  "Quota": 10,
  "PageNumber": 1,
  "PageSize": 10,
  "DataModule": [
    {
      "Name": "test",
      "Template": "promotion",
      "StartTime": "2023-03-04T16:00:00Z",
      "EndTime": "2023-03-06T16:00:00Z\n",
      "Status": "Expired",
      "Objects": [
        "123456****"
      ],
      "PolicyId": 0
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
500InternalErrorFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。

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