DescribeCustomScenePolicies - 查询定制场景策略

更新时间:
复制为 MD 格式

查询定制场景策略配置。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:DescribeCustomScenePolicies

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

PageSize

integer

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

10

PageNumber

integer

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

1

PolicyId

integer

策略 ID。

1234****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

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

TotalCount

integer

返回数据的总条数。

1

Quota

integer

配置额度。

10

PageNumber

integer

页码。

1

PageSize

integer

分页大小。

10

DataModule

array<object>

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

object

定制场景策略配置信息。

Name

string

定制场景策略名称。

test

Template

string

模板名称。取值:

  • promotion:重大活动

promotion

StartTime

string

策略生效开始时间。

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

2023-03-04T16:00:00Z

EndTime

string

策略生效结束时间。

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

2023-03-06T16:00:00Z

Status

string

策略的生效状态,取值:

  • Disabled:已被禁用

  • Pending:等待生效

  • Running:运行生效

  • Expired:过期失效

Expired

Objects

array

关联的站点 ID 信息列表。

说明

该字段为待废弃字段,建议读取 SiteIds 字段内容。

string

策略关联的站点 ID。

123456****

PolicyId

integer

策略 ID。

1234****

SiteIds

string

关联的站点 ID,多个站点 ID 用逗号(",")分割。

123456****,123457****

示例

正常返回示例

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,
      "SiteIds": "123456****,123457****\n"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The specified parameter is invalid. 输入参数规范校验失败。
500 InternalError Failed to call the service. Try again later or contact technical support. 调用服务失败,请稍后重试或联系客服咨询详情。

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

变更历史

更多信息,参考变更详情