文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ 入网配置/ 修改入网域名后缀 - UpdateIngressConfig
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

修改入网域名后缀 - UpdateIngressConfig

功能介绍

修改入网域名后缀。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID。

ingress_config_id

是

String

域名后缀ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

  • 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

    • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

  • 创建环境时，环境会绑定企业项目ID。

  • 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

X-Environment-ID

是

String

环境ID。

  • 获取环境ID，通过获取环境列表来获取环境信息。

  • 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。
表3 请求Body参数

参数

是否必选

参数类型

描述

api_version

是

String

API版本，固定值“v1”，该值不可修改

kind

是

String

API类型，固定值“IngressConfig”，该值不可修改

spec

是

spec object
表4 spec

参数

是否必选

参数类型

描述

id

否

String

域名后缀ID，修改域名后缀时必传

domain_name

是

String

域名后缀，以*.开头

tls_cert_id

否

String

域名证书ID，需要使用自有域名证书时必填

redirect

否

Boolean

是否重定向，通过http访问时自动重定向到https，默认false，未选择域名证书时，必须传入false

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

api_version

String

API版本

kind

String

API类型

spec

spec object
表6 spec

参数

参数类型

描述

id

String

ID

domain_name

String

域名后缀

tls_cert_id

String

域名证书ID

redirect

Boolean

重定向

created_at

String

创建时间。

updated_at

String

更新时间。

请求示例

修改入网域名后缀。

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

响应示例

状态码：200

请求成功。

{
  "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"
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 入网配置

相关文档