DescribePlaybooks - 获取剧本列表_云安全中心(Security Center)-阿里云帮助中心

用于获取剧本列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Active	integer	否	剧本的启用状态，取值： 1：表示剧本已启用。 0：表示剧本未启用	1
OwnType	string	否	剧本的类型，取值： preset：预定义剧本。 user：自定义剧本。	user
StartMillis	long	否	查询的开始时间，格式：13 位的时间戳。	1683526277415
EndMillis	long	否	查询的结束时间，格式：13 位的时间戳。	1683858064361
PlaybookUuid	string	否	剧本的 UUID。说明通过 UUID 可查询某一具体的剧本信息。调用 DescribePlaybooks 接口可以获取该参数。	8baa6cff-319e-4ede-97bc-1xxxxxx
Name	string	否	剧本的名称。	demo_playbook
Lang	string	否	指定请求和接收消息的语言类型，默认为 zh。取值： zh：中文 en：英文	zh
PageSize	string	否	指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 10 条数据。说明建议 PageSize 取值不要为空。	10
PageNumber	string	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	138B5AB7-7F2B-5814-87A3-E3ECFE1F207E
Playbooks	object []	剧本的列表。
DisplayName	string	剧本的展示名称。	demo_playbook
PlaybookUuid	string	剧本的 UUID。	bb5a8640-a14f-44ef-8376-cxxxxx
OwnType	string	剧本的类型，取值： preset：预定义剧本。 user：自定义剧本。	user
Active	integer	剧本的状态标识。取值： 1：表示启动剧本。 0：表示停止剧本。	1
LastRuntime	long	剧本的最后执行时间，格式：13 位的时间戳。	1683526277415
GmtCreate	long	剧本创建时间，格式：13 位的时间戳。	1683526277415
Page	object	分页查询信息。
TotalCount	integer	查询到的信息总数量。	100
PageNumber	integer	分页查询时，当前页的页码。	1
PageSize	integer	分页查询时，每页显示的条目数量。	10

示例

正常返回示例

JSON格式

{
  "RequestId": "138B5AB7-7F2B-5814-87A3-E3ECFE1F207E",
  "Playbooks": [
    {
      "DisplayName": "demo_playbook",
      "PlaybookUuid": "bb5a8640-a14f-44ef-8376-cxxxxx",
      "OwnType": "user",
      "Active": 1,
      "LastRuntime": 1683526277415,
      "GmtCreate": 1683526277415
    }
  ],
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

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