All Products
Search
Document Center

Serverless App Engine:DescribeComponents

Last Updated:Dec 17, 2025

Queries the version of the component that is required when you create and deploy an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringNo

The application ID.

d700e680-aa4d-4ec1-afc2-6566b5ff****
TypestringYes

The type of the supported components. Valid values:

  • TOMCAT
  • JDK
TOMCAT

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The message returned.

success
TraceIdstring

The ID of the trace. The ID is used to query the details of a request.

0a98a02315955564772843261e****
Dataarray<object>

The details of the supported components.

Dataobject

The details of the supported components.

Typestring

The type of the component.

JDK
ComponentKeystring

The component ID.

Open JDK 8
ComponentDescriptionstring

The description of the component.

Open JDK 8
Expiredboolean

Indicates whether the component is expired. Valid values:

  • true: The component is expired.
  • false: The component is not expired.
false
ErrorCodestring

The status code. Valid values:

  • If the request was successful, ErrorCode is not returned.
  • If the request failed, ErrorCode is returned. For more information, see Error codes section of this topic.
Codestring

The HTTP status code. Valid values:

  • 2xx: The request was successful.
  • 3xx: The request was redirected.
  • 4xx: The request failed.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the component version was obtained. Valid values:

  • true: The applications were obtained.
  • false: The applications failed to be queried.
true

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidComponentType.NotFoundThe specified Type does not exist.The specified Type does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history