Enabling Public Inbound Access¶
Function¶
This API is used to enable public inbound access for a gateway that uses ELB for load balancing.
Calling Method¶
For details, see Calling APIs.
URI¶
POST /v2/{project_id}/apigw/instances/{instance_id}/ingress-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 |
---|---|---|---|
bandwidth_size | No | Integer | Public inbound access bandwidth. Unit: Mbit/s |
bandwidth_charging_mode | No | String | Billing type of the public inbound access bandwidth.
Default: bandwidth Enumeration values:
|
Response Parameters¶
Status code: 202
Parameter | Type | Description |
---|---|---|
instance_id | String | Gateway ID. |
message | String | Public access address change task. |
job_id | String | Task ID. |
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¶
Enabling public inbound access for a gateway
{
"bandwidth_size" : 5,
"bandwidth_charging_mode" : "bandwidth"
}
Example Responses¶
Status code: 202
Accepted
{
"instance_id" : "6a7d71827fd54572b1f31aa9548fcc81",
"message" : "JOB_ASSIGNED_FOR_UPDATE_0077I:The job JOB-a7c1241c33334490a3fdcd11102bcbda is assigned to the instance 6a7d71827fd54572b1f31aa9548fcc81 for running updating",
"job_id" : "JOB-a7c1241c33334490a3fdcd11102bcbda"
}
Status code: 400
Bad Request
{
"error_code" : "APIC.9210",
"error_msg" : "create cloud nat eip failed"
}
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 |
---|---|
202 | Accepted |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.