DescribeImageComponents - 查询一个或多个镜像组件的详细信息 - 云服务器 ECS

调用DescribeImageComponents查询一个或多个镜像组件的详细信息。

接口说明

您可以设置NextToken查询凭证（Token），其取值是上一次调用 DescribeImageComponents 返回的NextToken参数值，再通过MaxResults设置单页查询的最大条目数进行查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribeImageComponents	get	ImageComponent `acs:ecs:{#regionId}:{#accountId}:imagecomponent/` *ImageComponent `acs:ecs:{#regionId}:{#accountId}:imagecomponent/{#imagecomponentId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
ResourceGroupId	string	否	资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。说明不支持默认资源组过滤。	rg-bp67acfmxazb4p****
Tag	array<object>	否	标签列表。
	object	否
Key	string	否	标签键。N 的取值范围：1~20	TestKey
Value	string	否	标签值。N 的取值范围：1~20	TestValue
Name	string	否	镜像组件名称。仅支持精确查找。	testComponent
NextToken	string	否	查询凭证（Token）。取值为上一次调用该接口返回的`NextToken`参数值，初次调用接口时无需设置该参数。	AAAAAdDWBF2****
MaxResults	integer	否	分页查询时每页行数。取值范围：1~500 默认值：50。	50
Owner	string	否	镜像组件类型。取值范围： SELF：您创建的自定义镜像组件。 ALIYUN：阿里云提供的系统组件。	SELF
ImageComponentId	array	否	待查询的镜像组件 ID。N 取值范围：1~20
	string	否	待查询的镜像组件 ID。N 取值范围：1~20	ic-bp67acfmxazb4p****
ComponentType	string	否	组件类型。取值范围： Build Test	Build
SystemType	string	否	组件支持的操作系统。取值范围： Linux Windows	Linux
ComponentVersion	string	否	组件版本号，格式为 major.minor.patch，均为非负整数，也支持使用通配符“*”来替代其中一位进行模糊匹配版本。说明仅当指定 Name 时该参数生效。	1.0.*

返回参数

名称	类型	描述	示例值
	object
NextToken	string	本次调用返回的查询凭证（Token）。具体使用方式请参见接口说明。	AAAAAdDWBF2****
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返回的镜像组件数量。	1
MaxResults	integer	分页查询时每页行数。	50
ImageComponent	array<object>	镜像组件的详细信息组成的列表。
ImageComponentSet	object
CreationTime	string	组件创建时间。	2020-11-24T06:00:00Z
Description	string	描述信息。	This is description.
SystemType	string	组件支持的操作系统。	Linux
ImageComponentId	string	镜像组件 ID。	ic-bp67acfmxazb4p****
ComponentType	string	组件类型。	Build
ResourceGroupId	string	资源组 ID。	rg-bp67acfmxazb4p****
Name	string	组件名称。	testComponent
Content	string	组件内容。	Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world
Owner	string	镜像组件类型。可能值： SELF：您创建的自定义镜像组件。 ALIYUN：阿里云提供的系统组件。	SELF
Tags	array<object>	标签键值对列表。
Tag	object
TagValue	string	标签值。	TestValue
TagKey	string	标签键。	TestKey
ComponentVersion	string	组件版本号。	1.0.0
Parameters	array<object>	镜像组件包含的参数列表。
Parameter	object
Name	string	参数名称。	paramName
Type	string	参数类型。取值范围： String Number Boolean	String
DefaultValue	string	参数默认值。	paramDefaultValue

示例

正常返回示例

JSON格式

{
  "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": "Tasks:\n  - Name: HelloWorld\n    Action: RunShellCommand\n    Properties:\n      commandContent: echo hello world\n",
        "Owner": "SELF",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ComponentVersion": "1.0.0",
        "Parameters": {
          "Parameter": [
            {
              "Name": "paramName",
              "Type": "String",
              "DefaultValue": "paramDefaultValue"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.Owner	The specified parameter \"Owner\" is not valid.	-
400	InvalidImageComponentIdSize.ExceededMaxNumber	%s	指定的参数值有误，具体信息请参见错误信息%s占位符的实际返回结果。
400	InvalidSystemType.NotSupportedValue	%s.	指定的系统类型无效。
400	InvalidComponentType.NotSupportedValue	%s.	指定的组件类型无效。
400	InvalidParameter.ComponentVersion	The specified ComponentVersion is invalid.	指定的组件版本无效。
403	Invalid.NextToken	The specified NextToken is not valid.	-

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-12-17	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2024-10-10	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-08	OpenAPI 错误码发生变更	查看变更详情