You need to enable JavaScript to run this app.
导航
删除私有证书
最近更新时间:2023.10.31 14:35:41首次发布时间:2023.08.11 19:16:09

API 说明

API 名称:DeleteLeafInstance
API 域名:open.volcengineapi.com
API 描述:调用本接口删除指定的私有证书实例。

注意

  • 私有证书实例必须处于已吊销或已过期状态,才允许被删除。
  • 私有证书实例被删除后将无法恢复,请谨慎操作。

请求方法

POST

使用限制

节流限制:暂无。

公共请求头参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下三个请求头(header)参数的取值说明如下:

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

请求参数

参数名称
数据类型
是否必选
参数说明
示例
Action
String
API 的名称。该参数的取值是 DeleteLeafInstance
DeleteLeafInstance
Version
String
API 的版本。该参数的取值是 2023-05-01
2023-05-01

请求正文

参数名称
数据类型
是否必选
参数说明
示例
instance_id
String
要删除的私有证书实例的ID。
您可以调用 ListLeafInstances 接口获取所有私有证书实例的ID。
pca_leaf_AoK3Gg4pznu****

响应正文

示例

请求示例

POST https://open.volcengineapi.com/?Action=DeleteLeafInstance&Version=2023-05-01&<其他公共请求参数>

{
    "instance_id": "pca_leaf_AoK3Gg4pznu****"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230810111325BABF7C489B2FCD9C1D3E",
        "Action": "DeleteLeafInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-beijing"
    }
}

错误码

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