用于获取用户可使用的普通组件的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-sas:DescribeComponentList | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PlaybookUuid | string | 是 | 剧本的 UUID。 说明
调用 DescribePlaybooks 接口可以获取该参数。
| b724d2b0-3c3b-4223-9bfd-xxxxx |
| Lang | string | 否 | 请求和接收消息的语言类型。取值：
| zh |
返回参数
Components 参数为 JSON 格式，包含字段如下：
-
actions：组件的可执行动作，为 JSONArray 格式，说明如下：
- description：动作的描述
- name：动作的名称
- parameters：动作的入参，JSONObject 格式，包含字段：
- description：入参的描述
- name：入参的名称
- required：入参是否必填，true 为必填，false 为非必填
-
basic：组件的基础信息，包含字段：
-
description：组件的描述信息
-
logo：组件 logo 的地址信息
-
name：组件的名称
示例
正常返回示例
JSON格式
{
"RequestId": "B0A255B3-495C-56FB-8B6B-DB073F80388A",
"Components": "[\n {\n \"actions\": [\n {\n \"description\": \"mysql component\",\n \"name\": \"storeIdb\",\n \"parameters\": [\n {\n \"description\": \"update the mysql db\",\n \"name\": \"updateSql\",\n \"required\": false\n }\n ]\n }\n ],\n \"basic\": {\n \"description\": \"mysq sql component for 5.6\",\n \"logo\": \"https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg\",\n \"name\": \"Mysql\"\n }\n }\n]"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史