文档首页/云桌面 Workspace/API参考/云应用API/服务器管理/查询服务器的HDA相关信息 - ListServerHdaDetails
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询服务器的HDA相关信息 - ListServerHdaDetails

功能介绍

查询服务器的HDA相关信息。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:server:listAccessAgentDetails

    List

    server *

    -

    -

    -

URI

GET /v1/{project_id}/app-servers/access-agent/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

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

limit

否

Integer

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

server_group_id

否

String

服务器组id。

server_name

否

String

服务器名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数。

items

Array of ServerHdaDetails objects

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

表5 ServerHdaDetails

参数

参数类型

描述

server_id

String

服务器id。

machine_name

String

机器名称。

maintain_status

Boolean

是否是维护状态。

server_name

String

服务器名称。

server_group_id

String

服务器组id。

server_group_name

String

服务器组名称。

sid

String

服务器的sid。

session_count

Integer

会话数量。

status

String

实例的状态：

  • UNREGISTER - 未就绪

  • REGISTERED - 就绪状态

  • MAINTAINING - 维护中

  • FREEZE - 冻结

  • STOPPED - 停止

  • NONE - 异常状态

current_version

String

当前的accessAgent版本。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：405

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：409

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：503

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码：200

成功响应。

{
  "count" : 0,
  "items" : [ {
    "server_id" : "489533790436196976",
    "machine_name" : "APS-DDP9KKUYTR",
    "maintain_status" : true,
    "server_name" : "APS-20221011032502-DL51DUK113",
    "server_group_id" : "489533790436196976",
    "server_group_name" : "测试使用服务器组",
    "sid" : "489533790436196976",
    "session_count" : 10,
    "status" : "UNREGISTER",
    "current_version" : "22.10.0.1020"
  } ]
}

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

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

409

请求存在冲突无法处理该请求。

500

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

503

服务不可用。

错误码

请参见错误码。

父主题：服务器管理

相关文档