全部产品
Search

搜索本产品

    轻量应用服务器：ListCustomImages - 查询一个或多个自定义镜像信息

    文档中心

    轻量应用服务器：ListCustomImages - 查询一个或多个自定义镜像信息

    更新时间：Oct 30, 2024

    查询指定地域下一个或多个已创建的自定义镜像信息。

    调试

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

    授权信息

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

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

    请求参数

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

    指定的轻量应用服务器实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。

    		cn-hangzhou
    ClientTokenstring否

    保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。

    		123e4567-e89b-12d3-a456-426655440000
    ImageIdsstring否

    轻量应用服务器的镜像 ID。取值可以由多个实例 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。

    		["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]
    PageSizeinteger否

    分页查询时设置的每页行数。

    • 最大值：100。
    • 默认值：10。
    		10
    PageNumberinteger否

    快照列表的页码。 默认值：1。

    		1
    ImageNamesstring否

    轻量应用服务器的镜像名称。取值可以由多个实例 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。

    		["test1****", "test2****"]
    SystemSnapshotIdstring否

    系统盘快照 ID。

    		s-bp14m09pq8***0g6
    DataSnapshotIdstring否

    数据盘快照 ID。

    		s-acscasca****
    Tagarray<object>否

    自定义镜像的标签列表。

    object否

    标签。

    Keystring否

    自定义镜像的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。

    		TestKey
    Valuestring否

    自定义镜像的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。

    		TestValue
    ResourceGroupIdstring否

    资源组 ID。

    		rg-aek2bti7cf7yj2i
    Shareboolean否

    是否查询共享镜像。取值范围：

    • False：否。表示返回结果中不包括共享镜像。

    • True：是。表示只返回共享镜像。

    不填则默认返回所有镜像。

    		False
    InstanceIdstring否

    镜像的来源轻量应用服务器实例 ID。

    		ace0706b2ac4454d984295a94213****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		20758A-585D-4A41-A9B2-28DA8F4F534F
    CustomImagesarray<object>

    对象数组。

    CustomImageobject

    对象。

    CreationTimestring

    快照创建时间。时间格式以 ISO8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2022-10-09T02:28:06Z
    DataSnapshotNamestring

    数据盘快照名称。

    		数据盘快照
    SystemSnapshotIdstring

    系统盘快照 ID。

    		s-bp1h173hj21puxb***
    InShareboolean

    自定义镜像是否共享至 ECS。

    		false
    InShareUserboolean

    自定义镜像是否跨账号共享。

    		False
    InstanceIdstring

    镜像的来源轻量应用服务器的实例 ID。

    		2d06ee0520b44de1ae88d4be****
    DataSnapshotIdstring

    数据盘快照 ID。

    		s-bp19rn9u8eqzlfb***
    RegionIdstring

    地域 ID。

    		cn-hangzhou
    SystemSnapshotNamestring

    系统盘快照名称。

    		系统盘快照
    Descriptionstring

    描述信息。

    		自定义镜像-1
    Namestring

    自定义镜像名称。

    		test
    ImageIdstring

    自定义镜像 ID。

    		m-bp1e79zktg26n2b***
    Statusstring

    自定义镜像状态。取值范围：

    • 0：复制中。

    • 1：可用。

    • 2：不可用。

    • 3：创建失败。

    • 4：创建中。

    		1
    Tagsarray<object>

    自定义镜像的标签列表。

    tagobject

    标签。

    Keystring

    自定义镜像的标签键。

    		TestKey
    Valuestring

    自定义镜像的标签值。

    		TestValue
    InstanceNamestring

    轻量应用服务器实例名称。

    		swas-asdf23***
    ResourceGroupIdstring

    资源组 ID。

    		rg-acfm2h2lvp3ublq
    CreateInstancesarray

    使用镜像创建的实例信息。

    createInstancestring

    使用镜像创建的实例 ID。

    		9ffb716db6ae406ca78a476c0c81****
    UserIdlong

    镜像拥有者的阿里云主账号 ID。

    		180185828710****
    OsTypestring

    镜像的操作系统类型。

    		Linux
    RequiredSystemDiskSizeinteger

    镜像的系统盘大小，单位为 GiB。

    		20
    RequiredDataDiskSizeinteger

    镜像的数据盘大小，单位为 GiB。

    		20
    SourceImageNamestring

    源镜像名称。

    		CentOS
    SourceImageVersionstring

    源镜像版本。

    		8.0
    TotalCountstring

    总条数。

    		4
    PageSizestring

    分页查询时设置的每页行数。

    		10
    PageNumberstring

    页码。

    		1

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "CustomImages": [
    {
      "CreationTime": "2022-10-09T02:28:06Z",
      "DataSnapshotName": "数据盘快照",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InShareUser": true,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "系统盘快照",
      "Description": "自定义镜像-1",
      "Name": "test",
      "ImageId": "m-bp1e79zktg26n2b***",
      "Status": "1",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "swas-asdf23***",
      "ResourceGroupId": "rg-acfm2h2lvp3ublq",
      "CreateInstances": [
        "9ffb716db6ae406ca78a476c0c81****"
      ],
      "UserId": 0,
      "OsType": "Linux",
      "RequiredSystemDiskSize": 20,
      "RequiredDataDiskSize": 20,
      "SourceImageName": "CentOS",
      "SourceImageVersion": "8.0"
    }
  ],
  "TotalCount": "4",
  "PageSize": "10",
  "PageNumber": "1"
}

    错误码

    HTTP status code错误码错误信息描述
    500InternalErrorAn error occurred while processing your request.内部错误，请重试。如果多次尝试失败，请提交工单。

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

    变更历史

    变更时间变更内容概要操作
    2024-10-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-07-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-02-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情