文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 镜像/ 获取云市场镜像列表
更新时间:2024-12-27 GMT+08:00
分享

获取云市场镜像列表

功能介绍

获取云市场镜像列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/market-images

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

image_ids

Array of strings

镜像id,支持传1到100个。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

images

Array of Image objects

镜像信息列表。

表5 Image

参数

参数类型

描述

image_id

String

镜像id。

min_disk

Integer

镜像运行需要的最小磁盘容量,单位为GB。取值为40~1024GB。

created_at

String

创建时间,格式为UTC时间,yyyy-MM-ddTHH:mm:ssZ。

image_size

String

镜像文件的大小,单位为字节。

updated_at

String

更新时间,格式为UTC时间,yyyy-MM-ddTHH:mm:ssZ。

product_code

String

市场镜像的产品ID。

max_ram

String

镜像支持的最大内存,单位为MB。取值可以参考云服务器规格限制,一般不设置。

market_resource_type_code

String

云市场资源类型编码。

min_ram

Integer

镜像运行需要的最小内存,单位为MB。参数取值依据弹性云服务器的规格限制,默认设置为0。

os_type

String

操作系统类型,目前取值Linux, Windows,Other。

image_type

String

镜像类型,目前支持以下类型: 公共镜像:gold 私有镜像:private 共享镜像:shared。

tags

Array of strings

镜像标签列表。

platform

String

镜像平台分类。

os_bit

String

操作系统位数,一般取值为“32”或者“64”。

os_version

String

操作系统具体版本。

name

String

镜像名称。

market_service_type_code

String

云市场服务类型编码。

status

String

镜像状态。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

响应示例

状态码: 200

获取云市场镜像列表响应。

{
  "images" : [ {
    "image_id" : "string",
    "min_disk" : 0,
    "created_at" : "2023-09-21T01:12:11Z",
    "image_size" : "string",
    "updated_at" : "2023-09-21T12:00:44Z",
    "product_code" : "string",
    "max_ram" : "string",
    "market_resource_type_code" : "string",
    "min_ram" : 0,
    "os_type" : "string",
    "image_type" : "string",
    "tags" : [ "string" ],
    "platform" : "string",
    "os_bit" : "string",
    "os_version" : "string",
    "name" : "string",
    "market_service_type_code" : "string",
    "status" : "string"
  } ]
}

状态码

状态码

描述

200

获取云市场镜像列表响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

500

服务器内部错误。

错误码

请参见错误码

相关文档