文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 云办公主机/ 导出云办公主机列表 - ExportHostsDetail
更新时间：2026-07-24 GMT+08:00
查看PDF
分享

导出云办公主机列表 - ExportHostsDetail

功能介绍

导出云办公主机列表的详情

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:wdh:export

    List

    wdh *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

GET /v2/{project_id}/hosts/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

云办公主机名称。

availability_zone

否

String

云办公主机所属区域。

host_id

否

String

云办公主机的id。

enterprise_project_id

否

String

企业项目ID。

host_type

否

String

类型。

host_type_name

否

String

云办公主机类型名称。

state

否

String

云办公主机状态，available-可用的，fault-错误的，released-释放的。

limit

否

Integer

每页显示的数量。

offset

否

Integer

用于分页查询，查询的起始记录序号，从0开始。

marker

否

String

上一页显示的最后记录的id，与offset同时使用时不生效。

changes_since

否

String

过滤指定时间起状态变更的专属主机。

日期和时间戳的格式为ISO 8601：CCYY-MM-DDThh:mm:ss±hh:mm

如果包含“hh:mm”值，则将时区作为UTC的偏移量返回。例如，“2015-08-27T09:49:58-05:00”。如果您省略时区，则假定为UTC时区。

sort_field

否

String

排序字段名称，需要结合sort_type字段一起使用。

  • instance_total 云办公主机上的实例总数

  • available_vcpus 云办公主机可用的vCPU核数

  • available_memory 云办公主机可用的内存大小

sort_type

否

String

排序类型，默认升序，需要结合sort_field字段一起使用。

  • ASC 升序。

  • DESC 降序。

language

是

String

语言。

  • zh_CN：中文

  • en_US：英文

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

task_id

String

任务id。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

/v2/9c53a566cb3443ab910cf0daebca90c4/hosts?state=available

响应示例

状态码：200

返回task_id。

{
  "task_id" : "string"
}

状态码

状态码

描述

200

返回task_id。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务器内部错误。

错误码

请参见错误码。

父主题： 云办公主机