Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Gateway Custom Inbound Port Management/ Querying the Domain Name Bound to a Custom Inbound Port
Updated on 2025-12-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Domain Name Bound to a Custom Inbound Port

Function

This API is used to query the domain name bound to a custom inbound port.

Calling Method

For details, see Calling APIs.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    apig:instance:listCustomIngressPortDomain

    List

    instance *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -
    • apig:instance:get
    • apig:apiGroup:get
    • apig:instance:listCustomIngressPort

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports/{ingress_port_id}/domains

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.

ingress_port_id

Yes

String

Gateway inbound port ID.
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

domain_name

No

String

The domain name of the inbound port.

Minimum: 0

Maximum: 255

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.

domain_infos

Array of PortBindingDomainInfo objects

Information list of domain names bound to the inbound port.
Table 5 PortBindingDomainInfo

Parameter

Type

Description

group_id

String

ID of the API group to which the inbound port is bound.

Minimum: 0

Maximum: 64

group_name

String

Name of the API group to which the inbound port is bound.

Minimum: 3

Maximum: 255

domain_name

String

Domain names bound to the inbound port.

Minimum: 0

Maximum: 255

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

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

None

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "size" : 1,
  "domain_infos" : [ {
    "group_id" : "73c58022f20d495aa18885d718647f09",
    "group_name" : "group_01",
    "domain_name" : "test.com"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:ingress_port_id. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Error Codes

See Error Codes.