DescribeImageComponents - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the information about one or more image components.

Operation description

You can use NextToken to configure the query token. Set the value to the NextToken value that is returned in the previous call to the DescribeImageComponents operation. Then, use MaxResults to specify the maximum number of entries to return on each page.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the image component. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response. Note Resources in the default resource group are displayed in the response regardless of how this parameter is set.	rg-bp67acfmxazb4p****
Tag	array<object>	No	The tags of the image component.
	object	No
Key	string	No	The key of tag N. Valid values of N: 1 to 20.	TestKey
Value	string	No	The value of tag N. Valid values of N: 1 to 20.	TestValue
Name	string	No	The name of the image component. You must specify an exact name to search for the image component.	testComponent
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.	AAAAAdDWBF2****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 500. Default value: 50.	50
Owner	string	No	The type of the image component. Valid values: SELF: the custom component that you created. ALIYUN: the system component provided by Alibaba Cloud.	SELF
ImageComponentId	array	No	The IDs of image components. Valid values of N: 1 to 20.
	string	No	The ID of image component N. Valid values of N: 1 to 20.	ic-bp67acfmxazb4p****

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. For information about how to use the returned value, see the "Usage notes" section of this topic.	AAAAAdDWBF2****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of image components returned.	1
MaxResults	integer	The number of entries per page.	50
ImageComponent	array<object>	Details about the image components.
	object
CreationTime	string	The time when the image component was created.	2020-11-24T06:00:00Z
Description	string	The description of the image component.	This is description.
SystemType	string	The type of the operating system supported by the image component.	Linux
ImageComponentId	string	The ID of the image component.	ic-bp67acfmxazb4p****
ComponentType	string	The type of the image component.	Build
ResourceGroupId	string	The ID of the resource group to which the image component belongs.	rg-bp67acfmxazb4p****
Name	string	The name of the image component.	testComponent
Content	string	The content of the image component.	RESTART
Owner	string	The type of the image component. Valid values: SELF: the custom component that you created. ALIYUN: the system component provided by Alibaba Cloud.	SELF
Tags	array<object>	The tags of the image component.
	object
TagValue	string	The value of the tag.	TestValue
TagKey	string	The key of the tag.	TestKey

Examples

Sample success responses

JSONformat

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImageComponent": {
    "ImageComponentSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "Description": "This is description.",
        "SystemType": "Linux",
        "ImageComponentId": "ic-bp67acfmxazb4p****",
        "ComponentType": "Build",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Name": "testComponent",
        "Content": "RESTART",
        "Owner": "SELF",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.Owner	The specified parameter \"Owner\" is not valid.
400	InvalidImageComponentIdSize.ExceededMaxNumber	%s
403	Invalid.NextToken	The specified NextToken is not valid.

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

Change history

Change time	Summary of changes	Operation

No change history