Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V2)> Gateway Custom Inbound Port Management> Adding an Inbound Port for a Gateway
Updated on 2024-06-27 GMT+08:00
Online Debugging
CLI Examples
View PDF

Adding an Inbound Port for a Gateway

Function

This API is used to add an inbound port for a gateway. In the same gateway, a port can only support one protocol.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports

Table 1 Path Parameters

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

Table 2 Request header 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

protocol

Yes

String

Custom inbound port protocol.

  • HTTP: The inbound port uses HTTP.

  • HTTPS: The inbound port uses HTTPS.

Enumeration values:

  • HTTP

  • HTTPS

ingress_port

Yes

Integer

Inbound port number. The value ranges from 1024 to 49151.

Minimum: 1024

Maximum: 49151

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

protocol

String

Custom inbound port protocol.

  • HTTP: The inbound port uses HTTP.

  • HTTPS: The inbound port uses HTTPS.

Enumeration values:

  • HTTP

  • HTTPS

ingress_port

Integer

Inbound port number. The value ranges from 1024 to 49151.

Minimum: 1024

Maximum: 49151

ingress_port_id

String

Inbound port ID.

Minimum: 32

Maximum: 36

status

String

The status of the custom inbound port.

  • normal: The inbound port is normal.

  • abnormal: The inbound port is abnormal and cannot be used.

Enumeration values:

  • normal

  • abnormal

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Adding an inbound port for a gateway

{
  "protocol" : "HTTP",
  "ingress_port" : 8080
}

Example Responses

Status code: 201

Created

{
  "protocol" : "HTTP",
  "ingress_port" : 8080,
  "ingress_port_id" : "0ae98839d78043d8a6dff54d7cb096dc",
  "status" : "normal"
}

Status code: 400

Bad Request

{
  "error_code" : "APIC.7211",
  "error_msg" : "Parameter value does not match the rules, parameter name[protocol]"
}

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

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.