Help Center/ Workspace/ API Reference/ Workspace APIs/ Network/ Binding an EIP to a Desktop

Updated on 2025-07-14 GMT+08:00

View PDF

Binding an EIP to a Desktop

Function

Bind an EIP to the desktop.

Debugging

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

URI

POST /v2/{project_id}/eips/binding

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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
eip_id	Yes	String	ID of the EIP bound to the desktop.
desktop_id	Yes	String	Desktop ID.

Response Parameters

Status code: 200

Response to the request for binding an EIP to a desktop.

Status code: default

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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

/v2/0e69423d4400f4a82f67c0059a1e4cc8/eips/binding

{
  "eip_id" : "450ca7d4-9603-48d0-a9bc-fb85cdaf3031",
  "desktop_id" : "90f05916-bc71-4e26-a534-d036188d96e3"
}