吊销私有证书--证书中心-火山引擎

文档中心

立即注册

导航

吊销私有证书

最近更新时间：2024.06.24 20:30:02首次发布时间：2023.08.11 19:16:08

调用本接口吊销指定的私有证书。

注意

私有证书被吊销后将无法恢复，请谨慎操作。

请求说明

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

调试

暂不支持。

请求参数

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

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

Query

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

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

Body

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

参数	类型	是否必选	描述	示例值
instance_id	String	是	要吊销的私有证书实例的ID。您可以调用 ListSubInstances 接口获取所有私有证书实例的ID。	`pca_leaf_M6gaihuZRcO****`

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

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

{
    "instance_id": "pca_leaf_M6gaihuZRcO****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230314203615189AD1AA0666E21569C0",
        "Action": "RevokeLeafInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。您可访问公共错误码，获取更多错误码信息。

证书中心