删除证书--证书中心-火山引擎

文档中心

立即注册

导航

删除证书

最近更新时间：2024.06.24 15:32:01首次发布时间：2024.02.02 10:08:09

调用本接口从证书中心删除指定的SSL证书。

使用说明

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

注意事项

请求频率：同一个租户每秒最多允许请求20次。

请求说明

接口名称：CertificateDeleteInstance
请求方式：POST
请求地址：open.volcengineapi.com

请求参数

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

参数	类型	是否必选	描述	示例值
Region	string	是	服务地区。该参数的取值是`cn-north-1`。	`cn-north-1`
ServiceName	string	是	服务名称。该参数的取值是`certificate_service`。	`certificate_service`

Query

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

参数	类型	是否必选	描述	示例值
Action	string	是	API名称。该参数的取值是`CertificateDeleteInstance`。	`CertificateDeleteInstance`
Version	string	是	API版本。该参数的取值是`2021-06-01`。	`2021-06-01`

Body

下方表格中的参数包含在请求体（request body）中。

参数	类型	是否必选	描述	示例值
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请求失败。您可访问公共错误码，获取更多错误码信息。

证书中心