DescribePlaybooks - 获取剧本列表 - 云安全中心

用于获取剧本列表。

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribePlaybooks

get

*Playbook

acs:yundun-sas::{#accountId}:playbook/*

无

请求参数

名称	类型	必填	描述	示例值
Active	integer	否	剧本的启用状态，取值： 1：表示剧本已启用。 0：表示剧本未启用。	1
OwnType	string	否	剧本的类型，取值： preset：预定义剧本。 user：自定义剧本。	user
StartMillis	integer	否	查询的开始时间，格式：13 位的时间戳。	1683526277415
EndMillis	integer	否	查询的结束时间，格式：13 位的时间戳。	1683858064361
PlaybookUuid	string	否	剧本的 UUID。说明调用 CreatePlaybook 接口可以获取该参数。	8baa6cff-319e-4ede-97bc-1xxxxxx
Name	string	否	剧本的名称。	demo_playbook
Lang	string	否	指定请求和接收消息的语言类型，默认为 zh。取值： zh：中文。 en：英文。	zh
PageSize	integer	否	指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 10 条数据。说明建议 PageSize 取值不要为空。	10
PageNumber	integer	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1
Sort	integer	否	排序依据，默认为 1。取值： 1：上次修改时间。 2：最近执行时间。	1
Order	string	否	排序逻辑，默认为 desc，取值： desc ：降序排序。 asc：升序排序。	desc
ParamTypes	string	否	剧本触发方式，默认为查询所有。取值： template-incident：安全事件。 template-ip： IP 实体。 template-file：文件实体。 template-process：进程实体。 template-alert：安全告警。 template-domain：域名实体。 template-container：容器实体。 template-host：主机实体。 template-custom：自定义。	template-alert
PlaybookUuids	string	否	剧本的 UUID 的集合，最多支持 100 个，多个用逗号隔开。	8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	138B5AB7-**-5814-87A3-E3E**F207E
Playbooks	array<object>	剧本的列表。
	object	剧本的信息。
DisplayName	string	剧本的展示名称。	demo_playbook
PlaybookUuid	string	剧本的 UUID。	bb5a8640-a14f-44ef-8376-cxxxxx
OwnType	string	剧本的类型，取值： preset：预定义剧本。 user：自定义剧本。	user
Active	integer	剧本的状态标识。取值： 1：表示启动剧本。 0：表示停止剧本。	1
LastRuntime	integer	剧本的最后执行时间，格式：13 位的时间戳。	1683526277415
GmtCreate	integer	剧本创建时间，格式：13 位的时间戳。	1683526277415
GmtModified	string	剧本修改时间。	1681396398000
ParamType	string	剧本触发方式，默认为查询所有。取值： template-incident：安全事件。 template-ip：IP 实体。 template-file：文件实体。 template-process：进程实体。 template-alert：安全告警。 template-domain：域名实体。 template-container：容器实体。 template-host：主机实体。	template-alert
Description	string	剧本的描述信息。	aegis_kill_process
TenantId	string	剧本所属的用户 ID。	123456
Page	object	分页查询信息。
TotalCount	integer	查询到的信息总数量。	100
PageNumber	integer	分页查询时，当前页的页码。	1
PageSize	integer	分页查询时，每页显示的条目数量。	10

示例

正常返回示例

JSON格式

{
  "RequestId": "138B5AB7-****-5814-87A3-E3E****F207E",
  "Playbooks": [
    {
      "DisplayName": "demo_playbook",
      "PlaybookUuid": "bb5a8640-a14f-44ef-8376-cxxxxx",
      "OwnType": "user",
      "Active": 1,
      "LastRuntime": 1683526277415,
      "GmtCreate": 1683526277415,
      "GmtModified": "1681396398000",
      "ParamType": "template-alert",
      "Description": "aegis_kill_process",
      "TenantId": "123456"
    }
  ],
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

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

变更历史

更多信息，参考变更详情。