DescribePlaybooks分页
用于获取剧本列表
服务地址:
公网
输入参数
只看必填
Active剧本的启用状态
OwnType剧本的类型
StartMillis查询的开始时间
EndMillis查询的结束时间
PlaybookUuid剧本的UUID
Name剧本的名称
Lang指定请求和接收消息的语言类型
Sort排序依据
Order排序逻辑
ParamTypes剧本触发方式
PlaybookUuids剧本的UUID的集合
分页参数
PageSize指定分页查询时
PageNumber设置从返回结果的第几页开始显示查询结果
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

请确保在使用该接口前,已充分了解响应编排产品的收费方式和价格

请求参数

字段名称字段详情
Activeinteger<int32>

剧本的启用状态,取值:展开详情

示例值:1
OwnTypestring

剧本的类型,取值:展开详情

示例值:user
StartMillisinteger<int64>

查询的开始时间,格式:13 位的时间戳。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1683526277415
EndMillisinteger<int64>

查询的结束时间,格式:13 位的时间戳。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1683858064361
PlaybookUuidstring

剧本的 UUID。展开详情

示例值:8baa6cff-319e-4ede-97bc-1xxxxxx参考取值来源:
    CopyPlaybook
    CreatePlaybook
Namestring

剧本的名称。

示例值:demo_playbook
Langstring

指定请求和接收消息的语言类型,默认为 zh。取值:展开详情

示例值:zh
PageSizeinteger<int32>

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 10 条数据。展开详情

示例值:10
PageNumberinteger<int64>

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
Sortinteger<int32>

排序依据,默认为 1。取值:展开详情

示例值:1
Orderstring

排序逻辑,默认为 desc,取值:展开详情

示例值:desc
ParamTypesstring

剧本触发方式,默认为查询所有。取值:展开详情

示例值:template-alert
PlaybookUuidsstring

剧本的 UUID 的集合,最多支持 100 个,多个用逗号隔开。

示例值:8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx参考取值来源:
    DescribePlaybook
    CopyPlaybook
    CreatePlaybook

返回参数

字段名称字段详情
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例值:138B5AB7-****-5814-87A3-E3E****F207E
Playbooksarray<object>

剧本的列表。

Pageobject

分页查询信息。

变更历史
变更时间变更内容概要操作
2025-04-10
变更返回参数
2025-04-08
变更请求参数Sort
2025-02-24
变更请求参数PageSize
2025-02-14
新增请求参数PlaybookUuids
2025-01-22
变更请求参数PageNumber
2024-11-01
新增请求参数ParamTypes
变更返回参数