All Products
Search
Document Center

Elastic Compute Service:DescribeImageComponents

Last Updated:Mar 19, 2024

Queries the details of 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 last 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the image component. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ResourceGroupIdstringNo

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****
Tagobject []No

The tags

KeystringNo

The key of tag N of the image component. Valid values of N: 1 to 20.

TestKey
ValuestringNo

The value of tag N of the image component. Valid values of N: 1 to 20.

TestValue
NamestringNo

The name of the image component. You must specify an exact name to search for the image component.

testComponent
NextTokenstringNo

The query token. Set the value to the NextToken value returned in the last call to the DescribeImageComponents operation. Leave this parameter empty the first time you call this operation.

AAAAAdDWBF2****
MaxResultsintegerNo

The maximum number of entries to return on each page. Valid values: 1 to 500.

Default value: 50.

50
OwnerstringNo

The type of the image component. Valid values:

  • SELF: the custom component that you created.
  • ALIYUN: the system component provided by Alibaba Cloud.
SELF
ImageComponentIdarrayNo

The IDs of the image components. You can specify up to 20 image components.

stringNo

The ID of image component.

ic-bp67acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The query token returned in this call. For information about how to use this return value, see the "Description" section in this topic.

AAAAAdDWBF2****
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

The total number of image components returned.

1
MaxResultsinteger

The maximum number of entries returned per page.

50
ImageComponentobject []

Details about the image components.

CreationTimestring

The time when the image component was created.

2020-11-24T06:00:00Z
Descriptionstring

The description of the image component.

This is description.
SystemTypestring

The operating system type supported by the image component.

Linux
ImageComponentIdstring

The ID of the image component.

ic-bp67acfmxazb4p****
ComponentTypestring

The type of the image component.

Build
ResourceGroupIdstring

The ID of the resource group.

rg-bp67acfmxazb4p****
Namestring

The name of the image component.

testComponent
Contentstring

The content of the image component.

RESTART
Ownerstring

The type of the image component. Valid values:

  • SELF: the custom component that you created.
  • ALIYUN: the system component provided by Alibaba Cloud.
SELF
Tagsobject []

The tags of the image component.

TagValuestring

The tag value of the image component.

TestValue
TagKeystring

The tag key of the image component.

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 codeError codeError message
400InvalidParameter.OwnerThe specified parameter \"Owner\" is not valid.
400InvalidImageComponentIdSize.ExceededMaxNumber%s
403Invalid.NextTokenThe specified NextToken is not valid.

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

Change history

Change timeSummary of changesOperation
No change history