查询镜像实例列表 - ListImageServers

功能介绍

查询镜像实例列表。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:imageServer:list
List
imageServer *
-
-
-
-
g:EnterpriseProjectId

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:imageServer:list	List	imageServer *	-	-	-
-	g:EnterpriseProjectId

URI

GET /v1/{project_id}/image-servers

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目唯一标识。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	查询的偏移量，默认值0。
limit	否	Integer	查询的数量，值区间[1-100]，默认值10。
server_name	否	String	镜像实例名称，支持部分匹配。
server_id	否	String	镜像实例唯一标识。
enterprise_project_id	否	String	企业项目ID(字段为空或者0表示使用默认default企业项目)。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
count	Integer	总数。
items	Array of ImageServer objects	镜像实例列表返回列表条目数量上限为分页的最大上限值。

表5 ImageServer
参数	参数类型	描述
id	String	实例的唯一标识。
name	String	镜像实例名称。
description	String	描述。
image_ref	ImageRef object	镜像源信息。
server_group_id	String	APS服务器组ID。
app_group_id	String	应用组ID。
server_id	String	APS实例ID。
instance_id	String	ECS服务器ID。
image_id	String	镜像产物唯一标识。
status	String	镜像实例的状态: 'CREATING' - 实例创建中 'ACTIVE' - 实例正常运行 'BUILDING' - 镜像创建中 'BUILT' - 镜像任务结束 'ERROR' - 实例处于异常 'DELETING' - 实例删除中 'NULL' - 未设置
authorize_accounts	Array of ImageAccountInfo objects	应用组授权用户，限制用户类型：'USER' - 用户
create_time	String	镜像实例创建时间。
update_time	String	更新时间。
enterprise_project_id	String	企业项目ID,仅企业项目需配置(字段为空或者0表示使用默认default企业项目)。

表6 ImageRef
参数	参数类型	描述
id	String	镜像源的唯一标识。
image_type	String	镜像源的镜像类型: gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他
spce_code	String	镜像源的规格编码，对于gold镜像类型，这个值是的必须项。
product_id	String	镜像源的产品ID，对于gold镜像类型，这个值是的必须项。

表7 ImageAccountInfo
参数	参数类型	描述
account	String	用户(组)。
account_type	String	用户类型： USER - 用户 USER_GROUP - 用户组
domain	String	域名称。

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：404

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：405

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：503

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

GET /v1/a4da8115c9d8464ead3a38309130523f/image-servers?limit=10&offset=0

响应示例

状态码：200

成功响应。

{
  "count" : 2,
  "items" : [ {
    "id" : "697612196993040384",
    "name" : "test_instance_1",
    "description" : "A test of creating an image instance.",
    "image_ref" : {
      "id" : "da02e5ca-c6ec-4685-8ecb-f116bb5bdd2c",
      "image_type" : "gold",
      "spce_code" : "90a6e84bb3e822fe54999b6be5bbae1e",
      "product_id" : ""
    },
    "server_group_id" : "dae99966-76c4-4995-adaf-e8e2ab36869a",
    "app_group_id" : "",
    "server_id" : "",
    "instance_id" : "",
    "image_id" : "",
    "status" : "CREATING",
    "authorize_accounts" : [ {
      "account" : "user0012",
      "account_type" : "USER"
    } ],
    "create_time" : "2024-05-07T07:54:21.009Z",
    "update_time" : "2024-05-07T07:54:22.329Z",
    "enterprise_project_id" : "0"
  }, {
    "id" : "627989489700044800",
    "name" : "test_instance_2",
    "description" : "",
    "image_ref" : {
      "id" : "da02e5ca-c6ec-4685-8ecb-f116bb5bdd2c",
      "image_type" : "gold",
      "spce_code" : "90a6e84bb3e822fe54999b6be5bbae1e",
      "product_id" : ""
    },
    "server_group_id" : "898dda82-4d61-4c3d-bff2-679e61cd34f3",
    "app_group_id" : "627991243116249088",
    "server_id" : "wksapp-08722b58-6900-4c03-bfc0-99e1a056b8ad",
    "instance_id" : "989e6391-43b5-49a7-a684-6c36e7ad714a",
    "image_id" : "",
    "status" : "ACTIVE",
    "authorize_accounts" : [ {
      "account" : "user001",
      "account_type" : "USER"
    } ],
    "create_time" : "2023-10-28T04:58:34.058Z",
    "update_time" : "2023-10-28T05:05:33.826Z",
    "enterprise_project_id" : "0"
  } ]
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。