查询已绑定桌面和未绑定的EIP - ListDesktopsEips
功能介绍
查询已绑定桌面和未绑定的EIP。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/eips
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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绑定状态。 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| eips | Array of Eips objects | 桌面EIP。 |
| total_count | Integer | 总数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码，失败时返回。 |
| error_msg | String | 错误描述。 |
| error_detail | String | 错误详情。 |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
无
响应示例
状态码：200
查询上网功能响应。
{
"eips" : [ {
"id" : "string",
"address" : "string",
"bandwidth_size" : 2000,
"eip_charge_mode" : "string",
"create_time" : "string",
"attached_desktop_id" : "string",
"attached_desktop_name" : "string",
"enterprise_project_id" : "string"
} ],
"total_count" : 0
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询上网功能响应。 |
| default | 默认响应。 |
错误码
请参见错误码。
