最近更新时间:2023.09.22 16:31:33
首次发布时间:2022.03.16 16:35:32
API 名称:CertificateAddInstanceCertificate
。
API 域名:open.volcengineapi.com
。
API 描述:向证书中心上传一本SSL证书。
POST
在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下三个请求头(header)参数的取值说明如下:
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
Region | String | 是 | 服务的地区。该参数的取值是 cn-north-1。 | cn-north-1 |
ServiceName | String | 是 | 服务的名称。该参数的取值是 certificate_service。 | certificate_service |
X-Upstream | String | 是 | 上游服务的地址。该参数的取值是 volcano。 | volcano |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
Action | String | 是 | API 的名称。该参数的取值是 CertificateAddInstanceCertificate。 | CertificateAddInstanceCertificate |
Version | String | 是 | API 的版本。该参数的取值是 2021-06-01。 | 2021-06-01 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
chain_id | String | 否 | 如果您希望上传的证书与证书中心已有的证书处于同一个证书关系链,可以通过该参数设置已有证书的证书关系链 ID。 您可以调用 CertificateGetInstance 查询已有证书的证书关系链 ID。 | cert-6c2d6f3c4e0747549d12d875cf2f**** |
tag | String | 否 | 为证书设置一个标签。允许使用任意字符,无长度限制。 | 上传证书 |
purpose | String | 是 | 设置证书的用途。该参数的取值是 ssl。 | ssl |
type | String | 否 | 设置证书的类型。该参数有以下取值:
| dv |
is_sm | Boolean | 否 | 证书是否为国密证书。该参数有以下取值:
| 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 请求失败。关于更多错误码的信息,参见 错误码说明。