文档中心

删除证书

最近更新时间：2024.02.02 10:34:52

首次发布时间：2024.02.02 10:08:09

API说明

API名称：CertificateDeleteInstance。
API域名：open.volcengineapi.com。
API描述：调用本接口从证书中心删除指定的SSL证书。

请求方法

POST

使用限制

QPS限制：同一个租户每秒最多允许请求20次。
如果证书与其他证书有续费关联，则证书不可删除。
示例：假设证书B由证书A续费获得，那么证书A和B都不可删除。
如果证书与火山引擎云服务的资源有关联，则证书不可删除。
示例：假设证书C与CDN某加速域名关联，那么证书C不可删除。
对于购自证书中心的证书，只有在处于 申请失败、已取消、已吊销、已过期 等状态下才可删除。

公共参数

下方表格中的公共参数必须包含在请求头（header）中。

参数名称	数据类型	是否必选	参数说明
Region	String	是	服务地区。该参数的取值是`cn-north-1`。
ServiceName	String	是	服务名称。该参数的取值是`certificate_service`。

下方表格中的公共参数必须包含在查询字符串（query string）中。

参数名称	数据类型	是否必选	参数说明
Action	String	是	API名称。该参数的取值是`CertificateDeleteInstance`。
Version	String	是	API版本。该参数的取值是`2021-06-01`。

请求参数

下方表格中的请求参数必须包含在查询字符串（query string）中。

参数名称	参数类型	是否必选	参数说明	示例
project_name	String	是	要删除的证书所属火山引擎项目。您可以调用CertificateGetInstance接口查询证书所属的项目信息。	default
instance_id	String	是	要删除的证书的实例ID。您可以调用CertificateGetInstance接口查询所有证书的实例ID。	cert-bb1555b6ac844d5e80f59eca7c2c****

响应正文

本接口无响应正文。

示例

请求示例

POST https://open.volcengineapi.com/?Action=CertificateDeleteInstance&Version=2021-06-01&project_name=default&instance_id=cert-bb1555b6ac844d5e80f59eca7c2c****&<其他公共请求参数>

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20240124161927FBBBCFDF7724D236BB08",
        "Action": "CertificateDeleteInstance",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    }
}

错误代码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。关于更多错误码的信息，参见错误码说明。