DescribeComponents-阿里云帮助中心

Call the DescribeComponents API to retrieve the component versions required to create an application deployment.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The application ID.	d700e680-aa4d-4ec1-afc2-6566b5ff****
Type	string	Yes	The supported component type. Valid values: TOMCAT JDK	TOMCAT

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The additional information.	success
TraceId	string	The trace ID used to query call details.	0a98a02315955564772843261e****
Data	array<object>	An array of supported application components.
	object	Details of a single component.
Type	string	The component type.	JDK
ComponentKey	string	The component ID.	Open JDK 8
ComponentDescription	string	The component description.	Open JDK 8
Expired	boolean	Indicates whether the component is expired. Valid values: true: The component is expired. false: The component is not expired.	false
ErrorCode	string	The error code. If the request is successful, the ErrorCode parameter is empty. If the request fails, the ErrorCode parameter indicates an error code. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. 2xx: success 3xx: redirect 4xx: request error 5xx: server error	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidComponentType.NotFound	The specified Type does not exist.	The specified Type does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.