最近更新时间:2024.01.02 15:54:54
首次发布时间:2022.03.16 16:35:32
API名称:CertificateAddInstanceCertificate
。
API域名:open.volcengineapi.com
。
API描述:调用本接口向证书中心上传一本SSL证书。
注意
本接口已经废弃,虽然现在仍可调用,但可能不再接受更新或者支持,因此我们不建议您使用本接口。
证书中心提供了一个新的上传证书接口:ImportCertificate。ImportCertificate接口支持更多的设置选项,例如允许您上传重复的证书。强烈推荐您使用ImportCertificate接口来上传证书。
POST
下方表格中的公共参数必须包含在请求头(header)中。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
---|---|---|---|
Region | String | 是 | 服务地区。该参数的取值是 |
ServiceName | String | 是 | 服务名称。该参数的取值是 |
下方表格中的公共参数必须包含在查询字符串(query string)中。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
---|---|---|---|
Action | String | 是 | API名称。该参数的取值是 |
Version | String | 是 | API版本。该参数的取值是 |
下方表格中参数的类型是请求正文参数。
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
chain_id | String | 否 | 如果您希望上传的证书与证书中心已有的证书处于同一个证书关系链,您可以将该参数设置为已有证书的证书关系链 ID。 您可以调用 CertificateGetInstance 查询已有证书的证书关系链 ID。 | cert-6c2d6f3c4e0747549d12d875cf2f**** |
tag | String | 否 | 为证书设置一个标签。允许使用任意字符,无长度限制。 | 上传证书 |
purpose | String | 是 | 设置证书的用途。该参数的取值是 ssl 。 | ssl |
type | String | 否 | 设置证书的类型。该参数有以下取值:
| dv |
is_sm | Boolean | 否 | 证书是否为国密证书。该参数有以下取值:
| false |
user_defined_chain | Boolean | 否 | 是否跳过证书合法性校验。该参数有以下取值:
true ,请务必先咨询证书中心技术团队,我们将帮助您分析业务可能受到的影响。 | false |
ssl | Object | 是 | 要上传的SSL证书的详情。 |
参数名称 | 数据类型 | 参数说明 | 示例 |
---|---|---|---|
Result | String | 证书中心为该证书生成的实例ID。 | cert-d51b11c79f2149bf9b8e65e8b7c1**** |
POST https://open.volcengineapi.com/?Action=CertificateAddInstanceCertificate&Version=2021-06-01&<其他公共请求参数> { "tag":"上传证书", "purpose":"ssl", "ssl":{ "certificate":{ "private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIE......kt4=\n-----END RSA PRIVATE KEY-----\n", "chain":[ "-----BEGIN CERTIFICATE-----\nMIIE......CA==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIE......lg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIID......bd4=\n-----END CERTIFICATE-----\n" ] } } }
{ "ResponseMetadata": { "RequestId": "2023011818525862987CA4D7FB7503D0F7", "Action": "CertificateAddInstanceCertificate", "Version": "2021-06-01", "Service": "certificate_service", "Region": "cn-north-1" }, "Result": "cert-6e2ce9d68e454ba4b258d62e5450****" }
如果响应正文的ResponseMetadata
字段中包含Error
字段,则表示API请求失败。关于更多错误码的信息,参见错误码说明。