全部产品
Search
文档中心

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

更新时间:Feb 04, 2024

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeImageComponentsREAD
  • ImageComponent
    acs:ecs:{#regionId}:{#accountId}:imagecomponent/*
  • ImageComponent
    acs:ecs:{#regionId}:{#accountId}:imagecomponent/{#imagecomponentId}
  • ecs:tag

请求参数

名称类型必填描述示例值
RegionIdstring

所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ResourceGroupIdstring

资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。

说明 不支持默认资源组过滤。
rg-bp67acfmxazb4p****
Tagobject []

标签列表。

Keystring

标签键。N 的取值范围:1~20

TestKey
Valuestring

标签值。N 的取值范围:1~20

TestValue
Namestring

镜像组件名称。仅支持精确查找。

testComponent
NextTokenstring

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

AAAAAdDWBF2****
MaxResultsinteger

分页查询时每页行数。取值范围:1~500

默认值:50。

50
Ownerstring

镜像组件类型。取值范围:

  • SELF:您创建的自定义镜像组件。
  • ALIYUN:阿里云提供的系统组件。
SELF
ImageComponentIdarray

待查询的镜像组件 ID。N 取值范围:1~20

string

待查询的镜像组件 ID。N 取值范围:1~20

ic-bp67acfmxazb4p****

返回参数

名称类型描述示例值
object
NextTokenstring

本次调用返回的查询凭证(Token)。具体使用方式请参见接口说明。

AAAAAdDWBF2****
RequestIdstring

请求 ID。

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

返回的镜像组件数量。

1
MaxResultsinteger

分页查询时每页行数。

50
ImageComponentobject []

镜像组件的详细信息组成的列表。

CreationTimestring

组件创建时间。

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

描述信息。

This is description.
SystemTypestring

组件支持的操作系统。

Linux
ImageComponentIdstring

镜像组件 ID。

ic-bp67acfmxazb4p****
ComponentTypestring

组件类型。

Build
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4p****
Namestring

组件名称。

testComponent
Contentstring

组件内容。

RESTART
Ownerstring

镜像组件类型。可能值:

  • SELF:您创建的自定义镜像组件。
  • ALIYUN:阿里云提供的系统组件。
SELF
Tagsobject []

标签键值对列表。

TagValuestring

标签值。

TestValue
TagKeystring

标签键。

TestKey

示例

正常返回示例

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": "RESTART",
        "Owner": "SELF",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.OwnerThe specified parameter \"Owner\" is not valid.-
400InvalidImageComponentIdSize.ExceededMaxNumber%s指定的参数值有误,具体信息请参见错误信息%s占位符的实际返回结果。
403Invalid.NextTokenThe specified NextToken is not valid.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史