调用本接口删除指定密钥环。删除前请确认该密钥环下没有仍需使用的密钥资源。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DeleteKeyring | 要执行的操作,取值:DeleteKeyring。 |
Version | String | 是 | 2021-02-18 | API的版本,取值:2021-02-18。 |
KeyringName | String | 否 | keyring-test | 密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。可通过 CreateKeyring 创建密钥环时指定,或通过 DescribeKeyrings、QueryKeyring 查询获取。KeyringName 与 KeyringID 必须且只能传入一个;同时传入或均不传入时,接口将返回错误。 |
KeyringID | String | 否 | 39a0e7c6-b7dd-4c83-b400-3449bb95403a | 密钥环 ID,UUID 形式。可通过 CreateKeyring 创建密钥环时返回,或通过 DescribeKeyrings、QueryKeyring 查询获取。KeyringID 与 KeyringName 必须且只能传入一个;同时传入或均不传入时,接口将返回错误。 |
本接口无特有的返回参数。更多信息请见返回结构。
GET /?Action=DeleteKeyring&Version=2021-02-18&KeyringName=demo HTTP/1.1 Host: kms.cn-beijing.volcengineapi.com X-Date: 20240707T073453Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240707/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{ "ResponseMetadata": { "RequestId": "20240707153520141247146044854A7C", "Action": "DeleteKeyring", "Version": "2021-02-18", "Service": "kms", "Region": "cn-beijing" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | InvalidParameter | 请求参数格式、类型或取值不合法,请根据参数说明检查并修正请求。 |
400 | MissingParameter | 缺少必填参数,请根据接口请求参数说明补充后重试。 |
403 | Reject.Throttling.Action | 接口级请求频率超过限制,请降低请求速率后重试。 |
403 | AccessDenied | 当前账号或子账号缺少执行该操作所需权限,请检查 IAM 授权策略。 |
404 | Not Found | 指定资源不存在或当前账号无权访问,请检查资源 ID、名称和地域是否正确。 |
500 | UndefinedError | 服务内部错误,请稍后重试;如持续出现,请联系技术支持。 |