API说明
API名称: QuickApplyCertificate
API域名:open.volcengineapi.com
API描述:调用本接口创建一个SSL证书订单,并向CA机构提交SSL证书请求。
请求方法
POST
使用限制
QPS限制:同一个租户每秒最多允许请求20次。
公共参数
下方表格中的公共参数必须包含在请求头(header)中。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
---|
Region | string | 是 | 服务地区。该参数的取值是cn-north-1 。 |
ServiceName | string | 是 | 服务名称。该参数的取值是certificate_service 。 |
下方表格中的公共参数必须包含在查询字符串(query string)中。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
---|
Action | string | 是 | API名称。该参数的取值是QuickApplyCertificate 。 |
Version | string | 是 | API版本。该参数的取值是2021-06-01 。 |
请求参数
下方表格中参数的类型是请求正文参数。
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|
plan | string | 是 | 指定您希望订购的SSL证书的规格。
证书规格采用以下格式:<品牌>_<域名类型>_<证书类型> 。 <品牌> 有以下取值:geotrust 、digicert 、digicert_pro 、globalsign 、tianwei_sm 、wotrus_sm 、vtrus 、wotrus 、alpha 、digicert_ee 。
其中,tianwei_sm 和wotrus_sm 表示国密证书,其他品牌均为非国密证书。国密证书的密钥算法固定为SM2,非国密证书的密钥算法可设置为RSA或ECC。digicert_ee 表示测试证书,其他品牌均为正式证书。<域名类型> 有以下取值:
standard :表示单域名(FQDN)或IP地址。wildcard :表示泛域名。multi :表示多个域名。
<证书类型> 有以下取值:dv 、ov 、ev 。
该参数有以下取值: - geotrust_standard_dv
- geotrust_wildcard_dv
- geotrust_standard_ov
- geotrust_wildcard_ov
- geotrust_standard_ev
- digicert_standard_dv
- digicert_wildcard_dv
- digicert_standard_ov
- digicert_wildcard_ov
- digicert_standard_ev
- digicert_pro_standard_ev
- digicert_pro_standard_ov
- digicert_pro_wildcard_ov
- globalsign_standard_dv
- globalsign_wildcard_dv
- globalsign_standard_ov
- globalsign_wildcard_ov
- globalsign_multi_ov
- globalsign_standard_ev
- tianwei_sm_standard_ov
- tianwei_sm_wildcard_ov
- vtrus_standard_dv
- vtrus_wildcard_dv
- vtrus_standard_ov
- vtrus_wildcard_ov
- wotrus_standard_dv
- wotrus_wildcard_dv
- wotrus_sm_wildcard_dv
- wotrus_sm_standard_dv
- alpha_wildcard_dv
- alpha_standard_dv
- digicert_ee_standard_dv
关于不同规格SSL证书的定价,请参见SSL证书计费说明。 | digicert_standard_dv
|
common_name | string | 否 | 为您要申请的证书设置一个公用名称(CommonName,CN)。
证书的公用名称表示证书颁发给的域名。部分规格的证书允许使用一个IP地址作为公用名称,详情参见是否支持IP SSL证书。 说明 只要 common_name 不为空,就由系统自动生成CSR和私钥,并使用自动生成的CSR进行证书申请。此时,csr 参数不生效。如需使用您提供的CSR进行证书申请,则必须设置 csr ,同时确保 common_name 为空。 common_name 参数的要求如下:
- 如果
plan 的值包含_standard ,common_name 可以设置为一个单域名(FQDN),如example.com 、www.example.com 。 - 如果
plan 的值包含_wildcard ,common_name 可以设置为一个泛域名,如*.example.com 。 - 如果
plan 的值包含_standard 并且对应证书规格支持IP证书,common_name 设置为一个IP地址,如1.XX.XX.1 。
| www.example.com
|
organization_id | string | 是 | 指定用于证书申请的信息模板的ID。信息模板包含了证书申请所需信息,如联系人、组织信息等。 您可以调用CertificateGetOrganization接口获取所有信息模板的ID。
| org-4d954cd1fe8e487086e67f687f83****
|
project | string | 否 | 指定证书归属的火山引擎项目的名称。 如果不设置该参数,证书将归属到default 项目。
项目是火山引擎提供的一种资源管理工具。您可以使用项目对资源进行分组,然后基于项目设置访问控制策略或查询账单。更多信息,请参见项目概述。
| default
|
key_alg | string | 是 | 设置证书使用的密钥算法。该参数有以下取值: rsa :仅适用于非国密证书。ecc :仅适用于非国密证书。SM2 :仅适用于国密证书。
| rsa
|
tag | string | 否 | 为证书设置备注。 如果不设置该参数,证书备注将被自动设置为未命名证书 。
| doc-test
|
validation_type | string | 是 | 设置域名所有权的验证方式。该参数有以下取值: dns_cname :DNS验证(基于CNAME记录)。
要使用此方式,必须满足以下所有条件:
plan 的值中包含wotrus 。common_name 不是一个IP地址。
dns_txt :DNS验证(基于TXT记录)。
满足以下任一条件时,不能使用此方式:
plan 的值中包含wotrus 。common_name 是一个IP地址。
https :文件验证(基于HTTPS请求)。
如果plan 的值中包含_wildcard ,则不能使用此方式。http :文件验证(基于HTTP协议)。
如果plan 的值中包含_wildcard ,则不能使用此方式。
| dns_txt
|
csr | string | 否 | 手动生成的CSR(证书签名请求)。 说明 只要 common_name 不为空,就由系统自动生成CSR和私钥,并使用自动生成的CSR进行证书申请。此时,csr 参数不会生效。如需使用您提供的CSR进行证书申请,则必须设置 csr ,同时确保 common_name 为空。 CSR的要求如下: - CSR内容必须采用PEM格式。
- CSR内容与您选择的信息模板(由
organization_id 指定)内容必须匹配,否则证书请求无法提交。
| |
san | string[] | 否 | 证书颁发给的域名或IP列表。
只有当 plan 为 globalsign_multi_ov (即购买GlobalSign多域名证书)时,该参数才会生效。 | |
private_key | string | 否 | 手动生成的私钥。 - 只有当
csr 不为空时(使用手动生成的CSR申请证书),该参数才会生效。 - 如果只设置了
csr 而没有设置 private_key ,那么不会影响证书申请,但会导致签发后的证书无法通过证书中心直接部署到火山引擎云产品。这是因为,要部署证书到火山引擎云产品,必须提供证书对应的私钥。
| |
响应正文
参数名称 | 数据类型 | 参数说明 | 示例 |
---|
Result | string | 本次请求创建的证书实例的ID。 | cert-46d8415d27374dfc8ea6caab0141****
|
示例
请求示例
POST https://open.volcengineapi.com/?Action=QuickApplyCertificate&Version=2021-06-01&<其他公共请求参数>
{
"plan": "digicert_standard_dv",
"common_name": "www.example.com",
"organization_id": "org-4d954cd1fe8e487086e67f687f83****",
"project": "default",
"key_alg": "rsa",
"tag": "doc-test",
"validation_type":"dns_txt"
}
响应示例
{
"ResponseMetadata": {
"RequestId": "202310181514120D6AD8DCBB673D4445B5",
"Action": "QuickApplyCertificate",
"Version": "2021-06-01",
"Service": "certificate_service",
"Region": "cn-north-1"
},
"Result": "cert-46d8415d27374dfc8ea6caab0141****"
}
错误代码
如果响应正文的ResponseMetadata
字段中包含Error
字段,则表示API请求失败。关于更多错误码的信息,参见错误码说明。