DescribePlaybook - 获取剧本配置_云安全中心(Security Center)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
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 配置。	<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>
Creator	string	创建剧本的阿里云账户 ID。	124xxxxx3435
OwnType	string	剧本的类型，取值： preset：预定义剧本。 user：自定义剧本。	preset
SuccessExeNum	integer	剧本成功运行次数。	100
FailExeNum	integer	剧本失败运行次数。	1
LastExeTime	long	剧本的最后运行时间，格式：13 位的时间戳。	1665288858000
Modifier	string	修改剧本的阿里云账户 ID。	124xxxxx3435
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": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><bpmn:definitions xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:bpmn=\"http://www.omg.org/spec/BPMN/20100524/MODEL\" xmlns:bpmndi=\"http://www.omg.org/spec/BPMN/20100524/DI\" xmlns:dc=\"http://www.omg.org/spec/DD/20100524/DC\" targetNamespace=\"http://bpmn.io/schema/bpmn\" id=\"Definitions_1\"><bpmn:process id=\"Process_1\" isExecutable=\"false\"><bpmn:startEvent id=\"StartEvent_1\"/></bpmn:process><bpmndi:BPMNDiagram id=\"BPMNDiagram_1\"><bpmndi:BPMNPlane id=\"BPMNPlane_1\" bpmnElement=\"Process_1\"><bpmndi:BPMNShape id=\"_BPMNShape_StartEvent_2\" bpmnElement=\"StartEvent_1\"><dc:Bounds height=\"36.0\" width=\"36.0\" x=\"173.0\" y=\"102.0\"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>",
    "Creator": "124xxxxx3435",
    "OwnType": "preset",
    "SuccessExeNum": 100,
    "FailExeNum": 1,
    "LastExeTime": 1665288858000,
    "Modifier": "124xxxxx3435",
    "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"
  }
}

错误码

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