DescribeComponentPlaybook - 获取预定义组件列表_云安全中心(Security Center)-阿里云帮助中心

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeComponentPlaybook

get

*Playbook

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

无

请求参数

名称	类型	必填	描述	示例值
PlaybookUuid	string	是	剧本的 UUID。说明调用 DescribePlaybooks 接口可以获取该参数。	ac343acc-1a61-4084-9a1cxxxxx
Lang	string	否	请求和接收消息的语言类型。取值： zh（默认）：中文。 en：英文。	zh

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	C5F5D6C9-DF1A-5381-92B1-39676F777D20
Playbooks	array<object>	预定义组件列表。
	object	预定义剧本信息。
DisplayName	string	预定义组件的名称。	AegisKillQuara
InputParams	string	剧本的入参配置，为 JSONArray 格式。说明参考 DescribePlaybookInputOutput 接口的格式说明。	[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
Description	string	预定义组件的描述信息。	aegis_kill_process
ParamType	string		template-alert

示例

正常返回示例

JSON格式

{
  "RequestId": "C5F5D6C9-DF1A-5381-92B1-39676F777D20",
  "Playbooks": [
    {
      "DisplayName": "AegisKillQuara",
      "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": "aegis_kill_process",
      "ParamType": "template-alert"
    }
  ]
}

错误码

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

变更历史

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