Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Gateway Custom Inbound Port Management/ Querying the Custom Inbound Ports of a Gateway
Updated on 2024-11-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Custom Inbound Ports of a Gateway

Function

This API is used to query the custom inbound ports of a gateway.

Calling Method

For details, see Calling APIs.

URI

GET /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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

Minimum: 1

Maximum: 500

Default: 20

protocol

No

String

Request protocol of inbound ports.

  • HTTP: The inbound port uses HTTP.

  • HTTPS: The inbound port uses HTTPS.

ingress_port

No

Integer

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

Minimum: 1024

Maximum: 49151

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

ingress_port_infos

Array of IngressPortInfo objects

Custom inbound ports.
Table 5 IngressPortInfo

Parameter

Type

Description

protocol

String

Custom inbound port protocol.

  • HTTP: The inbound port uses HTTP.

  • HTTPS: The inbound port uses 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.

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: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "size" : 1,
  "ingress_port_infos" : [ {
    "protocol" : "HTTP",
    "ingress_port" : 8080,
    "ingress_port_id" : "0ae98839d78043d8a6dff54d7cb096dc",
    "status" : "normal"
  } ]
}

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: 500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

500

Internal Server Error

Error Codes

See Error Codes.