文档首页/云桌面 Workspace/API参考/云应用API/服务器管理/查询服务器列表 - ListServers
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询服务器列表 - ListServers

功能介绍

查询服务器列表。

调试

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

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:server:list

    List

    server *

    -

    -

    -

URI

GET /v1/{project_id}/app-servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

查询的偏移量，默认值0。

limit

否

Integer

查询的数量，值区间[1-100]，默认值10。

server_group_id

否

String

服务器组唯一标识。

server_name

否

String

服务器名称，支持部分匹配。

machine_name

否

String

机器名称，支持部分匹配。

ip_addr

否

String

ip地址，支持部分匹配。

server_id

否

String

服务器唯一标识。

maintain_status

否

String

服务器维护状态：

  • true : 维护态的实例。

  • false: 非维护态的实例。

scaling_auto_create

否

String

是否是弹性创建：

true : 通过弹性伸缩创建。

false: 不是通过弹性伸缩创建。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数。

items

Array of AppServer objects

服务器列表返回列表条目数量上限为分页的最大上限值。

表5 AppServer

参数

参数类型

描述

id

String

aps实例的唯一标识。

name

String

服务器名称。

machine_name

String

计算机名称。

description

String

描述。

server_group_id

String

服务器组ID。

flavor

Flavor object

服务器规格详情。

status

String

实例的状态：

  • UNREGISTER - 未就绪

  • REGISTERED - 就绪状态

  • MAINTAINING - 维护中

  • FREEZE - 冻结

  • STOPPED - 停止

  • NONE - 异常状态

create_time

String

服务器创建时间。

update_time

String

更新时间。

image_id

String

镜像ID。

availability_zone

String

服务器可用分区。

domain

String

域。

ou_name

String

组织名称。

sid

String

实例的SID。

instance_id

String

实例的ID。

os_version

String

服务器系统版本。

os_type

String

操作系统类型，当前仅支持Windows：

  • Linux

  • Windows

  • Other

order_id

String

包周期产品的订单ID。

maintain_status

Boolean

是否维护状态。

scaling_auto_create

Boolean

配置弹性伸缩策略时，服务自动创建的实例。

  • true : 通过弹性伸缩创建。

  • false: 不是通过弹性伸缩创建。

job_id

String

上一次执行job的id。

job_type

String

上一次执行job的任务类型。

job_status

String

上一次执行job的执行结果。

job_time

String

上一次执行job的执行时间。

resource_pool_id

String

资源池ID。

resource_pool_type

String

资源池类型：

  • private：私有资源池。

  • public: 工作资源池。

host_id

String

云专属主机id。

server_group_name

String

服务器组名称。

product_info

ProductInfo object

产品信息。

metadata

Map<String,String>

[弹性云服务器元数据。

  1. charging_mode

  2. metering.order_id

  3. metering.product_id

  4. vpc_id

  5. EcmResStatus

  6. metering.image_id

  7. metering.imagetype

  8. metering.resourcespeccode

  9. image_name

  10. os_bit

  11. lockCheckEndpoint

  12. lockSource

  13. lockSourceId

  14. lockScene

  15. virtual_env_type

  16. metering.resourcetype

  17. os_type

  18. cascaded.instance_extrainfo

  19. __support_agent_list

  20. agency_name

云服务器的计费类型。

  • “0”：按需计费（即postPaid-后付费方式）。

  • “1”：按包年包月计费（即prePaid-预付费方式）。"2"：竞价实例计费

按“包年/包月”计费的云服务器对应的订单ID。

按“包年/包月”计费的云服务器对应的产品ID。

云服务器所属的虚拟私有云ID。

云服务器的冻结状态。

  • normal：云服务器正常状态（未被冻结）。

  • freeze：云服务器被冻结。

说明：
当云服务器被冻结或者解冻后，系统默认添加该字段，且该字段必选。virtual_env_type属性不允许用户增加、删除和修改。当云服务器被冻结或者解冻后，系统默认添加该字段，且该字段必选。virtual_env_type属性不允许用户增加、删除和修改。

云服务器操作系统对应的镜像ID

镜像类型，目前支持：

  • 公共镜像（gold）

  • 私有镜像（private）

  • 共享镜像（shared）

云服务器对应的资源规格。

云服务器操作系统对应的镜像名称。

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

回调URL，用于检查弹性云服务器的加锁是否有效。

  • 如果有效，则云服务器保持锁定状态。

  • 如果无效，解除锁定状态，删除失效的锁。

弹性云服务器来自哪个服务。订单加锁（ORDER）

弹性云服务器的加锁来自哪个ID。lockSource为“ORDER”时，lockSourceId为订单ID。

弹性云服务器的加锁类型。

  • 按需转包周期（TO_PERIOD_LOCK）

  • IOS镜像创建虚拟机，"virtual_env_type": "IsoImage" 属性；

  • 非IOS镜像创建虚拟机，在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性，而在此之前的版本创建的虚拟机可能会返回"virtual_env_type": "FusionCompute"属性 。

云服务器对应的资源类型。

操作系统类型，取值为：Linux、Windows。

系统内部虚拟机扩展信息。

云服务器是否支持企业主机安全、主机监控。

  • “hss”：企业主机安全

  • “ces”：主机监控

委托的名称。

委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为弹性云服务器提供访问云服务的临时凭证。](tag:HW)

[弹性云服务器元数据。

  1. vpc_id

  2. EcmResStatus

  3. metering.image_id

  4. metering.imagetype

  5. metering.resourcespeccode

  6. image_name

  7. os_bit

  8. lockCheckEndpoint

  9. lockSource

  10. lockSourceId

  11. lockScene

  12. virtual_env_type

  13. metering.resourcetype

  14. os_type

  15. cascaded.instance_extrainfo

  16. __support_agent_list

  17. agency_name

云服务器所属的虚拟私有云ID。

云服务器的冻结状态。

  • normal：云服务器正常状态（未被冻结）。

  • freeze：云服务器被冻结。

云服务器操作系统对应的镜像ID

镜像类型，目前支持：

  • 公共镜像（gold）

  • 私有镜像（private）

  • 共享镜像（shared）

云服务器对应的资源规格。

云服务器操作系统对应的镜像名称。

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

回调URL，用于检查弹性云服务器的加锁是否有效。

  • 如果有效，则云服务器保持锁定状态。

  • 如果无效，解除锁定状态，删除失效的锁。

弹性云服务器来自哪个服务。

弹性云服务器的加锁来自哪个ID。

弹性云服务器的加锁类型。

  • IOS镜像创建虚拟机，"virtual_env_type": "IsoImage" 属性；

  • 非IOS镜像创建虚拟机，在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性，而在此之前的版本创建的虚拟机可能会返回"virtual_env_type": "FusionCompute"属性 。

云服务器对应的资源类型。

操作系统类型，取值为：Linux、Windows。

系统内部虚拟机扩展信息。

云服务器是否支持企业主机安全、主机监控。

  • “hss”：企业主机安全

  • “ces”：主机监控

委托的名称。

委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为弹性云服务器提供访问云服务的临时凭证。](tag:HCS)

session_count

Integer

会话数量。

vm_status

String

服务器状态(如果当前是非稳态,存在任务进行中字段可能为null)。

task_status

String

服务器任务状态(如果当前是稳态,无任务进行中字段可能为null)。

freeze

Array of CbcFreezeInfo objects

冻结信息。

host_address

Array of EcsNetWork objects

vpc和子网信息。

enterprise_project_id

String

企业项目ID,仅企业项目会返回。

tags

Array of TmsTag objects

标签信息。

表6 Flavor

参数

参数类型

描述

id

String

服务器对应的规格ID。

links

Array of FlavorLink objects

服务器对应规格的相关标记快捷链接信息。

表7 FlavorLink

参数

参数类型

描述

rel

String

快捷链接标记名称。

hrel

String

对应快捷链接。

表8 ProductInfo

参数

参数类型

描述

product_id

String

产品id。

flavor_id

String

规格ID。

type

String

产品类型：

  • BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。

  • ADVANCED：表示产品高级套餐，套餐镜像中包括了一些商业软件。

architecture

String

产品架构，当前仅支持x86。

  • x86

  • arm

cpu

String

CPU。

cpu_desc

String

CPU描述。

memory

String

内存大小，单位兆：M。

is_gpu

Boolean

是否是GPU类型的规格。

system_disk_type

String

系统盘类型。

system_disk_size

String

系统盘大小。

gpu_desc

String

GPU描述。

descriptions

String

产品描述。

charge_mode

String

套餐标识。

  • 1：表示包周期。

  • 0：表示按需。

contain_data_disk

Boolean

套餐计费是否包含了数据盘。

resource_type

String

资源类型。

cloud_service_type

String

云服务类型。

volume_product_type

String

磁盘产品类型。

sessions

Integer

套餐默认支持的最大会话数。

status

String

产品套餐在销售模式下的状态，取值自ECS的cond:operation:status。

不配置时等同于normal在售状态。

  • normal - 正常商用

  • abandon - 下线（即不显示）

  • sellout - 售罄

  • obt - 公测

  • obt_sellout - 公测售罄

  • promotion - 推荐(等同normal，也是商用)

cond_operation_az

String

产品套餐在可用区的状态，配套status使用。

说明：

  • 此参数是AZ级配置，优选取此参数的值，某个AZ没有在此参数中配置时默认使用status参数的取值。

  • 配置格式“az(xx)”。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。

  • 例如：套餐在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为：

    • “status”设置为：“abandon” 。

    • “cond_operation_az”设置为：“az0(normal), az1(sellout), az2(obt), az3(normal)”。

  • 说明：如果flavor在某个AZ下的状态与status配置状态不同，必须配置该参数。

sub_product_list

Array of strings

专属主机的子产品。

domain_ids

Array of strings

产品属于专有的domainId。

package_type

String

套餐类型：

  • general：表示产品通用套餐。

  • dedicated：表示产品专属主机套餐。

expire_time

String

产品套餐过期时间，产品将在该时间点后逐步下架。

support_gpu_type

String

产品套餐支持的GPU类型。

表9 CbcFreezeInfo

参数

参数类型

描述

effect

Integer

在冻结/解冻等操作下，云服务需要达到的主要效果：

  • 1：（实现/去除）冻结可释放。（资源冻结后，客户可以手动删除/释放云资源和云资源上数据。）

  • 2：（实现/去除）冻结不可释放。（资源冻结后，客户不能手动删除/释放云资源以及云资源上数据，相当于云服务被贴了封条，不能改变数据和资源。对应解冻后，就可以删除和修改客户数据了。）

  • 3：（实现/去除）冻结后不可续费。（资源冻结后，资源不能发起续费操作；解冻后，才可以发起续费操作。）

  • effect字段和上面status字段(1冻结、0解冻)配合使用，表示在发起冻结/解冻命令下，云服务达到的冻结效果。

  • 为空时，默认为effect=1（云服务需要能兼容处理，默认当做effect=1）。

  • 注：云服务是根据status和effect在真实限制云服务的操作/API等。不是使用下文的scene字段去做云服务操作/API的限制。下文的scene字段，主要用于Console页面的tips、API错误码等客户体验使用。

scene

String

更新云服务状态的业务场景，默认ARREAR。 * ARREAR - 欠费场景；为正常的运营业务场景，包括包周期资源到期、按需资源扣费失败。 * POLICE - 公安冻结场景。 * ILLEGAL - 违规冻结场景。 * VERIFY - 客户未实名认证冻结场景。 * PARTNER - 合作伙伴冻结（合作伙伴冻结子客户资源）。

表10 EcsNetWork

参数

参数类型

描述

addr

String

IP地址信息

version

Integer

IP地址类型：

4 - IPV4

6 - IPV6

OS-EXT-IPS-MAC:mac_addr

String

MAC地址。

OS-EXT-IPS:type

String

IP地址分配方式，字符串是大小写不敏感格式。

  • fixed - 代表私有IP地址。

  • floating - 代表浮动IP地址。

OS-EXT-IPS:port_id

String

IP地址对应的端口ID。

vpc_id

String

虚拟私有云ID。

subnet_id

String

子网id。

tenant_type

String

租户类别:

  • tenant: 租户

  • resource_tenant: 资源租户

表11 TmsTag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。

  1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : =+ - @。

  2. 两头不能有空白字符。

value

String

值。每个值最大长度255个unicode字符。

  1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : =+ - @。

状态码：400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：401

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：403

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：404

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：405

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：500

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：503

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

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

响应示例

状态码：200

成功响应。

{
  "count" : 1,
  "items" : [ {
    "id" : "573548db-9a6f-4b31-a5cb-d7aa40975466",
    "name" : "APS-20230509102837-IVTU6S27OY",
    "machine_name" : "APS-PR6KRMAL00",
    "description" : "",
    "server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e",
    "flavor" : {
      "id" : "s2.large.2",
      "links" : [ {
        "rel" : "self"
      }, {
        "rel" : "bookmark"
      } ]
    },
    "status" : "REGISTERED",
    "create_time" : "2023-05-09T10:28:38.755Z",
    "update_time" : "2023-05-09T10:39:03.484Z",
    "image_id" : "ca8be629-112e-4865-b4fb-bbbca257f1d9",
    "availability_zone" : "cn-north-7a",
    "domain" : "wksapp***.huawei.com",
    "ou_name" : "",
    "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1399",
    "instance_id" : "4fa75b74-56bc-4a6b-b965-f2f139e17b5e",
    "os_version" : "Windows Server 2019 Datacenter 64bit",
    "os_type" : "Windows",
    "order_id" : "",
    "maintain_status" : false,
    "scaling_auto_create" : false,
    "resource_pool_id" : "10dd1a4f-ff85-4953-aa0f-2a37f28b6beb",
    "resource_pool_type" : "private",
    "server_group_name" : "Nas",
    "product_info" : {
      "product_id" : "workspace.appstream.general.xlarge.2",
      "flavor_id" : "s2.large.2",
      "type" : "BASE",
      "architecture" : "x86",
      "cpu" : "2",
      "memory" : "4096",
      "is_gpu" : false,
      "system_disk_type" : "SAS",
      "system_disk_size" : "80",
      "descriptions" : "s2.large.2 云应用通用型|2核|4GB内存",
      "charge_mode" : "0",
      "contain_data_disk" : false,
      "resource_type" : "hws.resource.type.workspace.appstream",
      "cloud_service_type" : "hws.service.type.vdi",
      "volume_product_type" : "workspace",
      "sessions" : 1,
      "status" : "abandon"
    },
    "metadata" : {
      "charging_mode" : "0",
      "metering.resourcespeccode" : "s2.large.2.win",
      "metering.resourcetype" : "1"
    },
    "session_count" : 1,
    "vm_status" : "ACTIVE",
    "task_status" : "null",
    "freeze" : [ ],
    "host_address" : [ {
      "addr" : "192.*.*.145",
      "version" : 4,
      "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:75:06",
      "OS-EXT-IPS:type" : "FIXED",
      "OS-EXT-IPS:port_id" : "257f2ff5-fe85-4b9a-86c2-5dacb64ac78f",
      "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175",
      "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977",
      "tenant_type" : "tenant"
    }, {
      "addr" : "10.*.*.79",
      "version" : 4,
      "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:02:88",
      "OS-EXT-IPS:type" : "FIXED",
      "OS-EXT-IPS:port_id" : "c6fc6fcc-c99e-4604-b0e0-04e48246c7cd",
      "vpc_id" : "82f75215-9ae6-4e69-882c-fe4088324839",
      "subnet_id" : "e851a83c-8696-48ea-b078-466fe9d361ae",
      "tenant_type" : "resource_tenant"
    } ]
  } ]
}

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题：服务器管理

相关文档