Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Ingress configurations./ Querying the Suffix List of Ingress Domain Names
Updated on 2025-12-19 GMT+08:00

Querying the Suffix List of Ingress Domain Names

Function

Query the suffix list of ingress domain names.

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, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/cae/ingress-configs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.

  • Enter 0 or up to 36 characters in UUID format with hyphens (-).

  • If this parameter is not specified or is set to 0, resources in the default enterprise project are queried.

NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version.

kind

String

API kind.

items

Array of IngressConfigItem objects

List data.

Table 4 IngressConfigItem

Parameter

Type

Description

id

String

ID

domain_name

String

Domain name suffix.

tls_cert_id

String

Domain name certificate ID.

redirect

Boolean

Redirection.

created_at

String

Creation time.

updated_at

String

Update time.

Example Requests

Query the suffix list of ingress domain names.

GET https://{endpoint}/v1/{project_id}/cae/ingress-configs

Example Responses

Status code: 200

OK

{
  "api_version" : "v1",
  "kind" : "IngressConfig",
  "items" : [ {
    "id" : "6adb5071-a18b-4b13-b795-eb4f5ac9d832",
    "domain_name" : "*.test.com",
    "tls_cert_id" : "760edb5e-8b8d-411a-9698-0f9b06f787f6",
    "redirect" : false,
    "created_at" : "2025-01-01T01:01:01.100000Z",
    "updated_at" : "2025-01-01T01:01:01.100000Z"
  } ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.