# 查询云办公主机列表 - ListHostsDetail #### 功能介绍 展示云办公主机列表的详情。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListHostsDetail)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:wdh:get | Read | wdh \* | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/hosts 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 降序。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dedicated_hosts | Array of [dedicated_hosts] objects | 云办公主机列表。 | | total | Integer | 总共条数。 | 表4dedicated_hosts | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dedicated_host_id | String | 云办公主机ID。 | | name | String | 云办公主机的名称。 | | auto_placement | String | 在创建云服务器时（未指定专属主机ID），是否允许云服务器自动分配在一台可用的云办公主机上。取值范围："on"或"off"。 | | availability_zone | String | 云办公主机的区域。 | | host_properties | [host_properties] object | 云办公主机的属性。 | | product_id | String | 云办公主机的产品id。 | | order_id | String | 云办公主机的订单id。 | | resource_type | String | 云服务资源类型。 | | state | String | 云办公主机状态，该参数取值可以为："available"、"fault"或"released"。 | | available_vcpus | Integer | 云办公主机可用的vCPU核数。 | | available_memory | Integer | 云办公主机可用的内存大小。 | | instance_total | Integer | 云办公主机上的实例总数。 | | allocated_at | String | 云办公主机的分配时间。 | | released_at | String | 云办公主机的释放时间。 | | instance_uuids | Array of strings | 专属主机上的实例UUID。 | | enterprise_project_id | String | 企业项目ID。 | | project_id | String | 项目ID。 | 表5host_properties | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vcpus | Integer | 云办公主机的vCPUs个数。 | | cores | Integer | 云办公主机的物理核数。 | | sockets | Integer | 云办公主机的物理套接字数量。 | | memory | Integer | 云办公主机的物理内存大小。 | | host_type | String | 云办公主机类型。 | | host_type_name | String | 云办公主机类型名称。 | | available_instance_capacities | Array of [available_instance_capacities] objects | 可以创建的规格。 | 表6available_instance_capacities | 参数 | 参数类型 | 描述 | |:---|:---|:---| | flavor | String | 规格id。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：404** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` /v2/9c53a566cb3443ab910cf0daebca90c4/hosts?state=available ``` #### 响应示例 **状态码：200** 云办公主机列表响应体。 ``` { "dedicated_hosts" : [ { "dedicated_host_id" : "ab910cf0daebca90c4001", "name" : "high performance servers1", "auto_placement" : "off", "host_properties" : { "vcpus" : 36, "cores" : 12, "sockets" : 2, "memory" : 1073741824, "host_type" : "h1", "host_type_name" : "High performance", "available_instance_capacities" : [ { "flavor" : "h1.large" }, { "flavor" : "h1.2large" }, { "flavor" : "h1.4large" }, { "flavor" : "h1.8large" } ] }, "product_id" : "workspace.wdh.dg1.p02", "state" : "available", "project_id" : "9c53a566cb3443ab910cf0daebca90c4", "available_vcpus" : 20, "available_memory" : 1073201821, "instance_total" : 2, "allocated_at" : "2016-10-10T14:35:47Z", "released_at" : null }, { "dedicated_host_id" : "ab910cf0daebca90c4002", "name" : "high performance servers2", "auto_placement" : "off", "host_properties" : { "vcpus" : 36, "cores" : 12, "sockets" : 2, "memory" : 1073741824, "host_type" : "h1", "host_type_name" : "High performance", "available_instance_capacities" : [ { "flavor" : "h1.large" }, { "flavor" : "h1.2large" }, { "flavor" : "h1.4large" }, { "flavor" : "h1.8large" } ] }, "product_id" : "workspace.wdh.dg1.p02", "state" : "available", "project_id" : "9c53a566cb3443ab910cf0daebca90c4", "available_vcpus" : 20, "available_memory" : 1073101821, "instance_total" : 3, "allocated_at" : "2016-10-10T14:35:47Z", "released_at" : null } ], "total" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 云办公主机列表响应体。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 500 | 服务器内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。