文档首页/ API网关 APIG/ API参考/ 专享版API（V1）（待下线）/ 域名管理（待下线）/ 绑定域名
更新时间：2022-08-30 GMT+08:00
查看PDF
分享

绑定域名

功能介绍

用户自定义的域名，需要CNAME到API分组的子域名上才能生效，具体方法请参见增加A类型记录集。

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

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

POST

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

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

project_id

是

String

项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。

instance_id

是

String

实例ID，可从API网关控制台的专享版实例信息中获取。

group_id

是

String

分组的编号

请求消息

表3 参数说明

参数

是否必选

类型

说明

url_domain

是

String

自定义域名。

长度为0-255位的字符串，需要符合域名规范。

请求消息样例：

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

响应消息

表4 参数说明

名称

类型

说明

id

String

域名的编号

url_domain

String

自定义域名

status

Integer

CNAME解析状态

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

响应消息样例：

{
	"id": "c5e0d5ba62a34d26ad5c709ae22c1a17",
	"url_domain": "www.MyCompany.com",
	"status": 3
}

状态码

表5 返回消息说明

状态码

说明

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error

相关文档