ListPlaybooks - 查询剧本列表-云安全中心(Security Center)-阿里云帮助中心

查询剧本列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求和接收消息的语言类型。 zh（默认）：中文 en：英文	zh
RoleFor	long	否	管理员切换成其他成员视角的用户 ID。	13760*****718726
PageNumber	integer	否	分页查询时的页码，默认值为 1。	1
PageSize	integer	否	分页查询时设置的每页行数。取值范围：1~100。	10
MaxResults	integer	否	单次请求返回结果的最大条数。取值范围：1~100。	100
NextToken	string	否	下一个查询开始的 Token。	7fbb1c****07c1f79a740f039a8dcfda
PlaybookStatus	integer	否	剧本的发布状态，取值如下： 0：未发布。 1：已发布。	1
PlaybookUuids	array	否	剧本的 UUID 的集合。
	string	否	剧本的 UUID。	8baa6cff-319e-4ede-97bc-1xxxxxx
PlaybookName	string	否	剧本的名称，支持模糊搜索。	demo_test
PlaybookParamTypes	array	否	剧本输入参数类型集合。
	string	否	剧本的参数类型，取值如下： template-ip：IP 实体。 template-file：文件实体。 template-process：进程实体。 template-host：主机实体。 template-domain：域名实体。 template-container：容器实体。 template-incident：安全事件。 template-alert：安全告警。 custom：自定义。	template-ip
PlaybookExecutionStartTime	long	否	剧本最新执行的开始时间。	1731378251000
PlaybookExecutionEndTime	long	否	剧本最新执行的结束时间。	1731379251000
OrderField	string	否	排序字段。取值： UpdateTime：按更新时间排序。 ExecutionTime：按最新执行时间排序。	UpdateTime
Order	string	否	排序逻辑，默认为 desc，取值： desc ：降序排序。 asc：升序排序。	desc
PlaybookType	string	否	剧本类型，取值如下： preset：预定义剧本。 user：自定义剧本。 component：安全处置组件。	preset

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	567D3D0B-2153-5860-BF9A-F9DEED55FB73
Playbooks	array<object>	剧本列表。
data	object	剧本的信息。
PlaybookUuid	string	剧本的 UUID。	bb5a8640-a14f-44ef-8376-cxxxxx
PlaybookName	string	剧本的名称。	system_aliyun_alb_process_book
PlaybookDescription	string	剧本描述。	alb block
PlaybookType	string	剧本类型，取值如下： preset：预定义剧本。 user：自定义剧本。 component：安全处置组件。	user
PlaybookParamType	string	剧本的参数类型，取值如下： template-ip：IP 实体。 template-file：文件实体。 template-process：进程实体。 template-host：主机实体。 template-domain：域名实体。 template-container：容器实体。 template-incident：安全事件。 template-alert：安全告警。 custom：自定义。	template-ip
PlaybookExtension	string	剧本扩展信息。	{}
PlaybookStatus	integer	剧本的发布状态，取值如下： 0：未发布。 1：已发布。	1
PlaybookInputConfigs	array	剧本的输入参数配置列表。
playbookInputConfigs	FieldInputConfig	剧本的输入参数配置。
PlaybookOutputConfigs	array	剧本的输出参数配置列表。
playbookOutputConfigs	FieldOutputConfig	剧本的输出参数配置。
CreateTime	long	创建时间（毫秒级时间戳）。	1667792399000
UpdateTime	long	创建时间（毫秒级时间戳）。	1731378251000
TotalCount	integer	查询到的总数。	100
PageNumber	integer	当前分页的页码数。默认值为 1。	1
PageSize	integer	分页查询，每页显示的条数。	10
MaxResults	integer	允许返回的最大结果数目。取值范围：0~100 个。	50
NextToken	string	下一页查询开始的 Token。	7fbb1c****07c1f79a740f039a8dcfda

示例

正常返回示例

JSON格式

{
  "RequestId": "567D3D0B-2153-5860-BF9A-F9DEED55FB73",
  "Playbooks": [
    {
      "PlaybookUuid": "bb5a8640-a14f-44ef-8376-cxxxxx",
      "PlaybookName": "system_aliyun_alb_process_book",
      "PlaybookDescription": "alb block",
      "PlaybookType": "user",
      "PlaybookParamType": "template-ip",
      "PlaybookExtension": {},
      "PlaybookStatus": 1,
      "PlaybookInputConfigs": [
        {
          "FieldName": "appName",
          "FieldType": "String",
          "DefaultValue": "test",
          "Required": false,
          "Arrayed": false,
          "FieldPath": "xx.appName",
          "FieldCheckRegex": "[a-zA-Z0-9\\u4e00-\\u9fa5_-]{2,128}",
          "FieldExample": "test",
          "FieldClass": "normal",
          "FieldDescription": "app name",
          "FieldConfigs": [
            {
              "FieldName": "appName",
              "FieldType": "String",
              "DefaultValue": "test",
              "Required": false,
              "Arrayed": false,
              "FieldPath": "xx.appName",
              "FieldCheckRegex": "[a-zA-Z0-9\\u4e00-\\u9fa5_-]{2,128}",
              "FieldExample": "test",
              "FieldClass": "normal",
              "FieldDescription": "app name",
              "FieldConfigs": [
                {
                  "FieldName": "appName",
                  "FieldType": "String",
                  "DefaultValue": "test",
                  "Required": false,
                  "Arrayed": false,
                  "FieldPath": "xx.appName",
                  "FieldCheckRegex": "[a-zA-Z0-9\\u4e00-\\u9fa5_-]{2,128}",
                  "FieldExample": "test",
                  "FieldClass": "normal",
                  "FieldDescription": "app name",
                  "FieldConfigs": []
                }
              ]
            }
          ]
        }
      ],
      "PlaybookOutputConfigs": [
        {
          "FieldName": "ip",
          "FieldType": "String",
          "FieldDescription": "Single IP to be blocked",
          "DefaultValue": "11.**.*.11",
          "FieldExample": "2.*.*.2"
        }
      ],
      "CreateTime": 1667792399000,
      "UpdateTime": 1731378251000
    }
  ],
  "TotalCount": 100,
  "PageNumber": 1,
  "PageSize": 10,
  "MaxResults": 50,
  "NextToken": "7fbb1c****07c1f79a740f039a8dcfda"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2025-10-27	新增 OpenAPI	查看变更详情