Updated on 2025-10-22 GMT+08:00

Modifying an Ingress Domain Name Suffix

Function

Modify an ingress domain name suffix.

URI

PUT /v1/{project_id}/cae/ingress-configs/{ingress_config_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

ingress_config_id

Yes

String

Domain name suffix ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

  • Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html).

  • The value of X-Subject-Token in the response header is the token value.

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

api_version

Yes

String

API version. Fixed value: v1.

kind

Yes

String

API type. Fixed value: IngressConfig.

spec

Yes

spec object

Table 4 spec

Parameter

Mandatory

Type

Description

id

No

String

Domain name suffix ID. This parameter is mandatory for modifying the domain name suffix.

domain_name

Yes

String

Domain name suffix, starting with *.

tls_cert_id

No

String

Domain name certificate ID. This parameter is mandatory when a self-owned domain name certificate is used.

redirect

No

Boolean

Whether to redirect. When HTTP is used for access, HTTPS is automatically redirected. The default value is false. If no domain name certificate is selected, false must be transferred.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

api_version

String

API version.

kind

String

API kind.

spec

spec object

Table 6 spec

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

Modify an ingress domain name suffix.

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

{
  "api_version" : "v1",
  "kind" : "IngressConfig",
  "spec" : {
    "id" : "74d858ef-c924-41cf-a1a9-19f63139e5d7",
    "domain_name" : "*.test.com",
    "tls_cert_id" : "2743d600-e2a6-7c4e-ca0d-0ab571653be6",
    "redirect" : false
  }
}

Example Responses

Status code: 200

OK

{
  "api_version" : "v1",
  "kind" : "IngressConfig",
  "spec" : {
    "id" : "74d858ef-c924-41cf-a1a9-19f63139e5d7",
    "domain_name" : "*.test.com",
    "tls_cert_id" : "2743d600-e2a6-7c4e-ca0d-0ab571653be6",
    "redirect" : false,
    "created_at" : "2025-01-01T01:01:01.100000Z",
    "updated_at" : "2025-01-01T01:01:03.100000Z"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.