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
Authorization information
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 | object [] | No | The tags | |
Key | string | No | The key of tag N of the image component. Valid values of N: 1 to 20. | TestKey |
Value | string | No | The value of tag N of the image component. 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 query token. Set the value to the | AAAAAdDWBF2**** |
MaxResults | integer | No | The maximum number of entries to return on each page. Valid values: 1 to 500. Default value: 50. | 50 |
Owner | string | No | The type of the image component. Valid values:
| SELF |
ImageComponentId | array | No | The IDs of the image components. You can specify up to 20 image components. | |
string | No | The ID of image component. | ic-bp67acfmxazb4p**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 |
---|