调用ListCustomImages查询一个或多个自定义镜像信息_轻量应用服务器-阿里云帮助中心

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	指定的轻量应用服务器实例所属的地域ID。您可以调用ListRegions查看支持的阿里云地域列表。	cn-hangzhou
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-426655440000
ImageIds	string	否	轻量应用服务器的镜像ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。	["fe9c66133a9d4688872869726b52**", "794c230fd3e64ea19f83f4d7a0ad**"]
PageSize	integer	否	分页查询时设置的每页行数。最大值：100。默认值：10。	10
PageNumber	integer	否	快照列表的页码。默认值：1。	1
ImageNames	string	否	轻量应用服务器的镜像名称。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。	["test1**", "test2**"]
SystemSnapshotId	string	否	系统盘快照ID。	s-bp14m09pq8***0g6
DataSnapshotId	string	否	数据盘快照ID。	s-acscasca****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
CustomImages	object []	对象数组。
CreationTime	string	快照创建时间。时间格式以ISO8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。	2022-10-09T02:28:06Z
DataSnapshotName	string	数据盘快照名称。	数据盘快照
SystemSnapshotId	string	系统盘快照ID。	s-bp1h173hj21puxb***
InShare	boolean	自定义镜像是否共享至ECS。	false
InstanceId	string	指定的轻量应用服务器的实例ID。	2d06ee0520b44de1ae88d4be****
DataSnapshotId	string	数据盘快照ID。	s-bp19rn9u8eqzlfb***
RegionId	string	地域ID。	cn-hangzhou
SystemSnapshotName	string	系统盘快照名称。	系统盘快照
Description	string	描述信息。	自定义镜像-1
Name	string	自定义镜像名称。	test
ImageId	string	自定义镜像ID。	m-bp1e79zktg26n2b***
Status	string	自定义镜像状态。	1
InstanceName	string	轻量应用服务器实例名称。	swas-asdf23***
TotalCount	string	总条数。	4
PageSize	string	分页查询时设置的每页行数。	10
PageNumber	string	页码。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "CustomImages": [
    {
      "CreationTime": "2022-10-09T02:28:06Z",
      "DataSnapshotName": "数据盘快照",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "系统盘快照",
      "Description": "自定义镜像-1",
      "Name": "test",
      "ImageId": "m-bp1e79zktg26n2b***",
      "Status": "1",
      "InstanceName": "swas-asdf23***"
    }
  ],
  "TotalCount": "4",
  "PageSize": "10",
  "PageNumber": "1"
}

错误码

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

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