DescribeComponentAssetForm - 获取组件资产元信息

用于获取组件的资产元信息,即资产信息是由哪些字段组成的。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeComponentAssetFormget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ComponentNamestring

组件的名称。

python3
Langstring

接收消息的语言类型。取值:

  • zh(默认):中文。
  • en:英文。
zh

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

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

9D1651AC-31CC-5CC4-A14E-626B3FCC1022
ComponentAssetFormstring

组件资产的配置元信息,为 JSONArray 格式,包含字段:

  • name:参数的名称
  • defaultValue:参数的默认值
  • description:参数描述信息
  • required:参数是否必填,true 表示必填,false 表示非必填
[ { "defaultValue": "", "description": "assetname", "name": "assetname", "required": true } ]

示例

正常返回示例

JSON格式

{
  "RequestId": "9D1651AC-31CC-5CC4-A14E-626B3FCC1022",
  "ComponentAssetForm": "[\n    {\n        \"defaultValue\": \"\",\n        \"description\": \"assetname\",\n        \"name\": \"assetname\",\n        \"required\": true\n    }\n]"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史