文档中心

新增证书

最近更新时间：2024.01.31 15:09:01

首次发布时间：2021.02.23 10:42:28

通过自定义证书名称以及输入证书公钥以及私钥，在veImageX添加新的证书，并获取返回的证书 ID 等信息。

请求说明

接口名称：AddCert
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=AddCert&Version=2018-08-01
请求频率限制：10 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

Body

参数	类型	是否必选	描述
name	String	是	证书备注名
public	String	是	证书公钥
private	String	是	证书私钥

返回参数

参数	类型	描述
cert_id	String	证书 ID
cert_name	String	证书名称
common_name	String	证书通用名
create_time	Integer	证书创建时间，单位为秒。
not_after	Integer	证书过期时间，单位为秒。
issuer	String	证书签发机构

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=AddCert&Version=2018-08-01
{
        "name": "*.imagex.com",
        "public":"--BEGIN***",
        "private":"--BEGIN***"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "AddCert",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result":{
         "cert_id":"5dc727ce5cec43268c3591607fd6af97",
         "cert_name":"*.imagex.com",
         "common_name":"*.imagex.com",
         "create_time":1603523766,
         "not_after":1619755200,
         "issuer":"TrustAsia TLS RSA CA"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "AddCert",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "AddCertErr",
            "Message": "Cert format error"
        }
    }
}

错误码

访问公共错误码和通用错误码获取详细信息。