用于获取剧本的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 |
| TaskflowMd5 | string | 否 | 剧本配置的 MD5 值。 | 7a8f608dc64c242632aa578xxxxx |
| DebugFlag | integer | 否 | 线上版本与调试版本的标记，取值：
| 0 |
返回参数
示例
正常返回示例
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>",
"TaskflowType": "xml",
"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"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-03-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |