调用DescribePlaybook API获取剧本配置信息-云安全中心-阿里云-云安全中心(Security Center)-阿里云帮助中心

用于获取剧本的xml配置信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribePlaybook

get

*Playbook

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

无

请求参数

名称	类型	必填	描述	示例值
PlaybookUuid	string	是	剧本的 UUID。说明调用 DescribePlaybooks 接口可以获取该参数。	9030076b-6733-4842-b05a-xxxxx
Lang	string	否	设置请求和接收消息的语言类型，默认为 zh。取值： zh：中文 en：英文	zh
TaskflowMd5	string	否	剧本配置的 MD5 值。	7a8f608dc64c242632aa578xxxxx
DebugFlag	integer	否	线上版本与调试版本的标记，取值： 1：表示获取调试版本 0：表示获取线上发布版本	0

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	2989BC59-E9F0-5C83-B453-B368857649C8
Playbook	object	剧本的配置信息。
GmtCreate	string	剧本的创建时间，格式：13 位的时间戳。	1665288858000
GmtModified	string	剧本的修改时间，格式：13 位的时间戳。	1677482519000
PlaybookUuid	string	剧本 UUID。	8db257d3-e2b2-44fd-b2cc-xxxxx
Taskflow	string	剧本的 XML 配置。
TaskflowType	string	剧本的配置格式。 xml：XML 格式。 x6：JSON 格式。	xml
OwnType	string	剧本的类型，取值： preset：预定义剧本。 user：自定义剧本。	preset
SuccessExeNum	integer	剧本成功运行次数。	100
FailExeNum	integer	剧本失败运行次数。	1
LastExeTime	integer	剧本的最后运行时间，格式：13 位的时间戳。	1665288858000
DisplayName	string	剧本的展示名称。	demo_test
InputParams	string	剧本的入参配置，为 JSONArray 格式。说明参考 DescribePlaybookInputOutput 接口的格式说明。	[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
Description	string	剧本的描述信息。	demo playbook
OnlineActive	boolean	剧本的启停标记，取值： 0：表示剧本已停止 1：表示剧本已启用	0
OnlineReleaseTaskflowMd5	string	剧本最新发布版本的 MD5 值。	asdfsdfe232-e2b2-44fd-b2cc-xxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "2989BC59-E9F0-5C83-B453-B368857649C8",
  "Playbook": {
    "GmtCreate": "1665288858000",
    "GmtModified": "1677482519000",
    "PlaybookUuid": "8db257d3-e2b2-44fd-b2cc-xxxxx",
    "Taskflow": "",
    "TaskflowType": "xml",
    "OwnType": "preset",
    "SuccessExeNum": 100,
    "FailExeNum": 1,
    "LastExeTime": 1665288858000,
    "DisplayName": "demo_test",
    "InputParams": "[\n    {\n        \"typeName\": \"String\",\n        \"dataClass\": \"normal\",\n        \"dataType\": \"String\",\n        \"description\": \"period\",\n        \"example\": \"\",\n        \"name\": \"period\",\n        \"required\": false\n    }\n]",
    "Description": "demo playbook",
    "OnlineActive": true,
    "OnlineReleaseTaskflowMd5": "asdfsdfe232-e2b2-44fd-b2cc-xxxxx"
  }
}

错误码

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

变更历史

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