Help Center/ Workspace/ API Reference/ Workspace APIs/ Network/ Querying EIPs Bound to Desktops and Unbound EIPs

Updated on 2026-02-10 GMT+08:00

View PDF

Querying EIPs Bound to Desktops and Unbound EIPs

Function

Queries EIPs bound to desktops and unbound EIPs.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:networks:listEips	List	-	-	-	eip:publicIps:list eip:bandwidths:list

URI

GET /v2/{project_id}/eips

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID.
desktop_id	No	String	Desktop ID.
desktop_name	No	String	Desktop name.
user_name	No	String	User to whom the desktop belongs.
address	No	String	EIP.
offset	No	Integer	Start position for pagination query. The value starts from 0.
limit	No	Integer	Maximum number of desktops that can be returned in a pagination query. If this parameter is not specified, all records that meet the search criteria are returned.
state	No	String	Specifies the EIP binding status. bind: indicates a bound EIP. unbind: indicates an unbound EIP.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
eips	Array of Eips objects	Specifies the desktop EIP.
total_count	Integer	Total number.

**Table 4** Eips
Parameter	Type	Description
id	String	EIP ID.
address	String	EIP.
bandwidth_size	Integer	Bandwidth range.
eip_charge_mode	String	traffic (billed by traffic) and bandwidth (billed by bandwidth).
create_time	String	Creation time in the yyyy-MM-ddTHH:mm:ssZ format.
attached_desktop_id	String	Specifies the ID of the bound desktop.
attached_desktop_name	String	Specifies the name of the bound desktop.
enterprise_project_id	String	Enterprise project ID.

Status code: default

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

None

Example Responses

Status code: 200

Response to the request for querying the Internet access function.

{
  "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
}