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

绑定域名证书

功能介绍

如果创建API时，“定义API请求”使用HTTPS请求协议，那么在独立域名中需要添加SSL证书。

本章节主要介绍为特定域名绑定证书。

URI

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

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

请求方法

URI

POST

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

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

表2 参数说明

名称

是否必选

类型

说明

project_id

是

String

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

instance_id

是

String

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

group_id

是

String

分组的编号

domain_id

是

String

域名的编号

请求消息

表3 参数说明

参数

是否必选

类型

说明

name

是

String

证书名称。

长度为4 ~ 50位的字符串，字符串由中文、英文字母、数字、"_"组成，且只能以英文或中文开头。

说明：

中文字符必须为UTF-8或者unicode编码。

cert_content

是

String

证书内容。

private_key

是

String

私钥内容。

请求消息样例：

{
	"cert_content": "example",
	"name": "test_ssl",
	"private_key": "example"
}

响应消息

表4 参数说明

名称

类型

说明

id

String

自定义域名的编号

url_domain

String

自定义域名

status

Integer

解析状态值

ssl_id

String

证书的编号

ssl_name

String

证书的名称
响应消息样例： 
{
	"id": " b9be707660c5406394f8973e087bae20",
	"url_domain": "www.example.com",
	"status": 3,
	"ssl_id ": "0a515af69f4e4dcca84fbf85f68c0e27",
	"ssl_name": "证书"
}

状态码

表5 返回消息说明

状态码

说明

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error

相关文档