GetPlaybook - 获取剧本详情信息-云安全中心(Security Center)-阿里云帮助中心

获取剧本详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:GetPlaybook	get	*Playbook `acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}`	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求和接收消息的语言类型。 zh（默认）：中文 en：英文	zh
RoleFor	long	否	管理员切换成其他成员视角的用户 ID。	13760*****718726
PlaybookUuid	string	是	剧本的 UUID。	e99dab31-499b-4307-9248-xxxxxx
PlaybookVersionType	string	否	剧本对应的版本类型，取值如下： Draft ：编辑态。 Online：线上版本。 History：历史版本。	History
PlaybookVersion	string	否	剧本的版本 ID，仅在 PlayboookVersionType 为 History 时生效。	36c9dcd6-**-4262-**-d508464ebd21

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F
Playbook	object	剧本的配置信息。
PlaybookUuid	string	剧本 UUID。	8db257d3-e2b2-44fd-b2cc-xxxxx
PlaybookName	string	剧本的名称，不包含特殊字符。	waftest
PlaybookDescription	string	剧本描述。	waf ip blocked
PlaybookParamType	string	剧本的参数类型，取值如下： template-ip：IP 实体。 template-file：文件实体。 template-process：进程实体。 template-host：主机实体。 template-domain：域名实体。 template-container：容器实体。 template-incident：安全事件。 template-alert：安全告警。 custom：自定义。	template-ip
PlaybookExtension	string	剧本扩展信息。	{"opCode":1}
PlaybookStatus	integer	剧本的发布状态，取值如下： 0：未发布。 1：已发布。	1
PlaybookTaskFlow	string	剧本的工作流。	[]
PlaybookVersion	string	剧本的版本号。	36c9dcd6-**-4262-**-d508464ebd21
PlaybookTaskFlowUuid	string	剧本工作流的 UUID。	8ea81047-**-4481-**-fcd8557bf242
PlaybookParamsExample	string	剧本的输入示例。	{"ip":"1...1"}
CreateTime	long	创建时间（毫秒级时间戳）。	1731378251000
UpdateTime	long	创建时间（毫秒级时间戳）。	1731378251000
PlaybookInputConfigs	array	剧本的输入参数配置列表。
playbookInputConfigs	FieldInputConfig	剧本的输入参数配置。
PlaybookOutputConfigs	array	剧本的输出参数配置列表。
playbookOutputConfigs	FieldOutputConfig	剧本的输出参数配置。
PlaybookType	string	剧本类型，取值如下： preset：预定义剧本。 user：自定义剧本。 component：安全处置组件。	x6

示例

正常返回示例

JSON格式

{
  "RequestId": "BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F",
  "Playbook": {
    "PlaybookUuid": "8db257d3-e2b2-44fd-b2cc-xxxxx",
    "PlaybookName": "waftest",
    "PlaybookDescription": "waf ip blocked",
    "PlaybookParamType": "template-ip",
    "PlaybookExtension": {
      "opCode": 1
    },
    "PlaybookStatus": 1,
    "PlaybookTaskFlow": [],
    "PlaybookVersion": "36c9dcd6-****-4262-****-d508464ebd21",
    "PlaybookTaskFlowUuid": "8ea81047-****-4481-****-fcd8557bf242",
    "PlaybookParamsExample": {
      "ip": "1.*.*.1"
    },
    "CreateTime": 1731378251000,
    "UpdateTime": 1731378251000,
    "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"
      }
    ],
    "PlaybookType": "x6"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2025-11-24	OpenAPI 返回结构发生变更	查看变更详情
2025-10-27	新增 OpenAPI	查看变更详情