Querying Bound Desktops and Unbound EIPs
Function
Query bound 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.
URI
GET /v2/{project_id}/eips
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
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.
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
eips |
Array of Eips objects |
Specifies the desktop EIP. |
total_count |
Integer |
Total number. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
EIP ID. |
address |
String |
Indicates the EIP address. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for querying the Internet access function. |
default |
Default response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot