Updating or Binding an EIP to a Dedicated Gateway
Function
This API is used to bind an EIP to a dedicated gateway or update the EIP bound to a dedicated gateway (only supported for LVS instances).
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/apigw/instances/{instance_id}/eip
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Gateway ID, which can be obtained from the gateway information on the APIG console. |
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 a token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
eip_id |
No |
String |
EIP ID. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
eip_id |
String |
EIP ID. |
eip_address |
String |
EIP. |
eip_status |
String |
EIP status. |
eip_ipv6_address |
String |
EIP (IPv6). , This parameter is not used currently. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
Binding an EIP to a gateway
{ "eip_id" : "85392b45-685c-4f77-b19a-14ad875b8190" }
Example Responses
Status code: 200
OK
{ "eip_id" : "85392b45-685c-4f77-b19a-14ad875b8190", "eip_address" : "xxx.xxx.xxx.xxx", "eip_status" : "ACTIVE" }
Status code: 400
Bad Request
{ "error_code" : "APIC.7211", "error_msg" : "Parameter value does not match the rules, parameter name[eip_id]" }
Status code: 401
Unauthorized
{ "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method" }
Status code: 404
Not Found
{ "error_code" : "APIC.7302", "error_msg" : "Instance not found" }
Status code: 500
Internal Server Error
{ "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
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