DescribeComponentList
用于获取用户可使用的普通组件的列表
服务地址：
公网
输入参数
只看必填
PlaybookUuid剧本的UUID
Lang请求和接收消息的语言类型
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求参数

字段名称字段详情
PlaybookUuidstring

剧本的 UUID。展开详情

示例值:b724d2b0-3c3b-4223-9bfd-xxxxx参考取值来源:
    CopyPlaybook
    DescribePlaybooks
    CreatePlaybook
Langstring

请求和接收消息的语言类型。取值：展开详情

示例值:zh

返回参数

字段名称字段详情
RequestIdstring

本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

示例值:B0A255B3-495C-56FB-8B6B-DB073F80388A
Componentsstring

组件信息，为 JSONArray 格式。

示例值:[ { "actions": [ { "description": "mysql component", "name": "storeIdb", "parameters": [ { "description": "update the mysql db", "name": "updateSql", "required": false } ] } ], "basic": { "description": "mysq sql component for 5.6", "logo": "https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg", "name": "Mysql" } } ]

返回说明

Components 参数为 JSON 格式，包含字段如下：

  • actions：组件的可执行动作，为 JSONArray 格式，说明如下：

    • description：动作的描述
    • name：动作的名称
    • parameters：动作的入参，JSONObject 格式，包含字段：
      • description：入参的描述
      • name：入参的名称
      • required：入参是否必填，true 为必填，false 为非必填

  • basic：组件的基础信息，包含字段：

  • description：组件的描述信息

  • logo：组件 logo 的地址信息

  • name：组件的名称

变更历史
暂无变更历史