文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-域名管理/ 绑定域名
更新时间：2024-11-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

绑定域名

功能介绍

用户自定义的域名，需要增加A记录才能生效，具体方法请参见《云解析服务用户指南》的“添加A类型记录集”章节。

每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

group_id

是

String

分组的编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

min_ssl_version

否

String

最小ssl协议版本号。支持TLSv1.1或TLSv1.2

缺省值：TLSv1.1

is_http_redirect_to_https

否

Boolean

是否开启http到https的重定向，false为关闭，true为开启，默认为false

缺省值：false

ingress_http_port

否

Integer

访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。

当创建域名时，该参数未填表示用默认80端口；如果填写该参数，则必须同时填写https_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。

当修改域名时，该参数未填表示不修改该端口。

最小值：-1

最大值：49151

ingress_https_port

否

Integer

访问该域名绑定的https协议入方向端口，-1表示无端口且协议不支持，可使用443默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTPS协议的自定义入方向端口。

当创建域名时，该参数未填表示用默认443端口；如果填写该参数，则必须同时填写http_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。

当修改域名时，该参数未填表示不修改该端口。

最小值：-1

最大值：49151

url_domain

是

String

自定义域名。长度为0-255位的字符串，需要符合域名规范（即符合正则'^(a-zA-Z0-9?.){1,7}[a-zA-Z]{2,64}.?$'或者符合正则'^*{1,6}.[a-zA-Z]{2,64}.?$'）。

最小长度：0

最大长度：255

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

url_domain

String

自定义域名

id

String

自定义域名的编号

status

Integer

CNAME解析状态

  • 1: 未解析
  • 2: 解析中
  • 3: 解析成功
  • 4: 解析失败

min_ssl_version

String

支持的最小SSL版本

is_http_redirect_to_https

Boolean

是否开启http到https的重定向，false为关闭，true为开启，默认为false

缺省值：false

verified_client_certificate_enabled

Boolean

是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。

缺省值：false

ingress_http_port

Integer

访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。

当创建域名时，该参数未填表示用默认80端口；如果填写该参数，则必须同时填写https_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。

当修改域名时，该参数未填表示不修改该端口。

最小值：-1

最大值：49151

ingress_https_port

Integer

访问该域名绑定的https协议入方向端口，-1表示无端口且协议不支持，可使用443默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTPS协议的自定义入方向端口。

当创建域名时，该参数未填表示用默认443端口；如果填写该参数，则必须同时填写http_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。

当修改域名时，该参数未填表示不修改该端口。

最小值：-1

最大值：49151

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

为API分组绑定域名

{
  "url_domain" : "www.company.com"
}

响应示例

状态码： 201

Created

{
  "url_domain" : "www.company.com",
  "id" : "c5e0d5ba62a34d26ad5c709ae22c1a17",
  "status" : 3,
  "min_ssl_version" : "TLSv1.1",
  "is_http_redirect_to_https" : false,
  "verified_client_certificate_enabled" : false
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2024",
  "error_msg" : "Invalid URL domain name"
}

状态码： 401

Unauthorized

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

状态码： 403

Forbidden

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

状态码： 404

Not Found

{
  "error_code" : "APIG.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}

状态码： 500

Internal Server Error

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

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 专享版-域名管理