DescribeComponents - 获取应用创建部署时所需的组件版本_Serverless 应用引擎(SAE)-阿里云帮助中心

调用DescribeComponents接口获取应用创建部署时所需的组件版本。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
sae:DescribeComponents	get	全部资源 ``	无	无

请求语法

GET /pop/v1/sam/resource/components HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
AppId	string	否	应用 ID。	d700e680-aa4d-4ec1-afc2-6566b5ff****
Type	string	是	支持的组件类型。取值说明如下： TOMCAT JDK	TOMCAT

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	附加信息。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	0a98a02315955564772843261e****
Data	array<object>	支持的应用组件信息。
Data	object	支持的应用组件信息。
Type	string	组件类型。	JDK
ComponentKey	string	组件 ID。	Open JDK 8
ComponentDescription	string	组件描述。	Open JDK 8
Expired	boolean	组件是否过期。取值说明如下： true：组件已过期。 false：组件未过期。	false
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。	空
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	获取组件版本是否成功。取值说明如下： true：获取成功。 false：获取失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "Type": "JDK",
      "ComponentKey": "Open JDK 8",
      "ComponentDescription": "Open JDK 8",
      "Expired": false
    }
  ],
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidComponentType.NotFound	The specified Type does not exist.	指定的Type不存在。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史