文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 网络/ 查询已绑定桌面和未绑定的Eip
更新时间:2024-12-12 GMT+08:00

查询已绑定桌面和未绑定的Eip

功能介绍

查询已绑定桌面和未绑定的Eip。

调试

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

URI

GET /v2/{project_id}/eips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID

desktop_id

String

桌面ID。

desktop_name

String

桌面名称。

user_name

String

桌面所属用户。

address

String

EIP地址。

offset

Integer

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

limit

Integer

用于分页查询,返回桌面数量限制。如果不指定,则返回所有符合条件的记录。

state

String

EIP绑定状态。

  • bind:表示已绑定的EIP。

  • unbind:表示未绑定的EIP。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

Content-Type

String

发送的实体的MIME类型。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

eips

Array of Eips objects

桌面EIP。

total_count

Integer

总数。

表5 Eips

参数

参数类型

描述

id

String

EIP的id。

address

String

Eip地址。

bandwidth_size

Integer

带宽大小。

eip_charge_mode

String

traffic(按流量计费),bandwidth(按带宽计费)。

create_time

String

创建时间,格式为:yyyy-MM-ddTHH:mm:ssZ。

attached_desktop_id

String

绑定的桌面id。

attached_desktop_name

String

绑定的桌面名称。

enterprise_project_id

String

企业项目ID

状态码: default

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

请求示例

响应示例

状态码

状态码

描述

200

查询上网功能响应。

default

默认响应

错误码

请参见错误码