Query Bound EIPs

Function

This API is used to obtain the information about the EIP bound to the Lite Server. It is used when you need to view the EIP bound to the Lite Server and the detailed information. Before using this API, ensure that you have logged in to the system and have the permission to query the EIP, and the specified Lite Server exists. After the query, the API returns the details of the EIP bound to the Lite Server, including the EIP address, binding time, and status. If the Lite Server does not exist, the EIP is not bound to the Lite Server, or you do not have the required permission, the API returns an error message.

Constraints

Only for A3.

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, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/dev-servers/{id}/publicips

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Definition: Lite Server ID. Constraints: Mandatory. Range: 1 to 64 characters. Default Value: N/A
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 3** Response body parameters
Parameter	Type	Description
public_ips	Array of ServerPublicIp objects	Definition: Array of EIP information.

**Table 4** ServerPublicIp
Parameter	Type	Description
id	String	Definition: EIP ID. Constraints: Mandatory Range: 1 to 64 characters Default Value: N/A
address	String	Definition: EIP IP address. Constraints: Mandatory Range: 1 to 64 characters in standard IPv4 format. Default Value: N/A

Example Requests

GET https://{endpoint}/v1/{project_id}/dev-servers/{id}/publicips

Example Responses

None

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Parent topic: Lite Server Management

Previous topic: Binding an EIP to a Lite Server

Next topic: Querying the Specification List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot