DescribeComponents - - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:DescribeComponents	get	All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	TOMCAT	d700e680-aa4d-4ec1-afc2-6566b5ff****
Type	string	Yes	The ID of the request.	TOMCAT

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The returned message.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The ID of the trace. It is used to query the details of a request.	success
TraceId	string	The details of the component.	0a98a02315955564772843261e****
Data	array<object>	The component type.
Data	object
Type	string	The ID of the component.	JDK
ComponentKey	string	The description of the component.	Open JDK 8
ComponentDescription	string	Indicates whether the component is expired. Valid values: true: The component is expired. false: The component is not expired.	Open JDK 8
Expired	boolean	The error code. The ErrorCode parameter is not returned when the request succeeds. The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.	false
ErrorCode	string	The HTTP status code. Valid values: 2xx: indicates that the request was successful. 3xx: indicates that the request was redirected. 4xx: indicates that the request was invalid. 5xx: indicates that a server error occurred.
Code	string	Indicates whether the component version was obtained. Valid values: true: indicates that the component version was obtained. false: indicates that the component version could not be obtained.	200

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 code	Error code	Error message	Description
400	InvalidComponentType.NotFound	The 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 time	Summary of changes	Operation

No change history