DescribeComponents - 获取应用创建部署时所需的组件版本

更新时间:
复制为 MD 格式

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

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>

支持的应用组件信息。

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不存在。

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

变更历史

更多信息,参考变更详情