功能说明
如果返回结果中存在 Error 字段,则表示调用 API 接口失败。例如:
{
"Response": {
"Error": {
"Code": "AuthFailure.SignatureFailure",
"Message": "The provided credentials could not be validated. Please check your signature is correct."
},
"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
}
}
Error 中的 Code 表示错误码,Message 表示该错误的具体信息。
错误码列表
公共错误码
| 错误码 | 说明 |
|---|---|
| ActionOffline | 接口已下线。 |
| AuthFailure.InvalidAuthorization | 请求头部的 Authorization 不符合腾讯云标准。 |
| AuthFailure.InvalidSecretId | 密钥非法(不是云 API 密钥类型)。 |
| AuthFailure.MFAFailure | MFA 错误。 |
| AuthFailure.SecretIdNotFound | 密钥不存在。请在 控制台 检查密钥是否已被删除或者禁用,如状态正常,请检查密钥是否填写正确,注意前后不得有空格。 |
| AuthFailure.SignatureExpire | 签名过期。Timestamp 和服务器时间相差不得超过五分钟,请检查本地时间是否和标准时间同步。 |
| AuthFailure.SignatureFailure | 签名错误。签名计算错误,请对照调用方式中的签名方法文档检查签名计算过程。 |
| AuthFailure.TokenFailure | token 错误。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidAction | 接口不存在。 |
| InvalidParameter | 参数错误(包括参数格式、类型等错误)。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidRequest | 请求 body 的 multipart 格式错误。 |
| IpInBlacklist | IP 地址在黑名单中。 |
| IpNotInWhitelist | IP 地址不在白名单中。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数。 |
| NoSuchProduct | 产品不存在 |
| NoSuchVersion | 接口版本不存在。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| RequestLimitExceeded.GlobalRegionUinLimitExceeded | 主账号超过频率限制。 |
| RequestLimitExceeded.IPLimitExceeded | IP 限频。 |
| RequestLimitExceeded.UinLimitExceeded | 主账号限频。 |
| RequestSizeLimitExceeded | 请求包超过限制大小。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResponseSizeLimitExceeded | 返回包超过限制大小。 |
| ServiceUnavailable | 当前服务暂时不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误,用户多传未定义的参数会导致错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedProtocol | http(s) 请求协议错误,只支持 GET 和 POST 请求。 |
| UnsupportedRegion | 接口不支持所传地域。 |
业务错误码
| 错误码 | 说明 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.CmkUsedByCloudProduct | CMK正在被云产品使用。 |
| FailedOperation.DecryptError | 解密失败。 |
| FailedOperation.EncryptionError | 加密操作失败。 |
| FailedOperation.TaggingError | 标签服务错误。 |
| InvalidParameter.DecryptMaterialError | 解密EncryptedKeyMaterial失败。 |
| InvalidParameter.InvalidPendingWindowInDays | 计划删除时间参数非法。 |
| InvalidParameterValue.AliasAlreadyExists | 别名已经存在。 |
| InvalidParameterValue.DataKeyNameAlreadyExists | 数据密钥名称已存在 |
| InvalidParameterValue.DuplicatedDataKeyId | 存在重复的数据密钥ID |
| InvalidParameterValue.DuplicatedKeyId | KeyId重复。 |
| InvalidParameterValue.InvalidAlias | 别名格式错误。 |
| InvalidParameterValue.InvalidCiphertext | 密文格式错误。 |
| InvalidParameterValue.InvalidDataKeyId | 不合法的数据密钥ID |
| InvalidParameterValue.InvalidDataKeyName | 不合法的数据密钥名称 |
| InvalidParameterValue.InvalidHsmClusterId | 无效的 HSM 集群 ID。 |
| InvalidParameterValue.InvalidImportKeyMaterial | 导入的数据密钥合法 |
| InvalidParameterValue.InvalidKeyId | KeyId不合法。 |
| InvalidParameterValue.InvalidKeyUsage | KeyUsage参数错误。 |
| InvalidParameterValue.InvalidPlaintext | Plaintext不合法。 |
| InvalidParameterValue.InvalidType | Type参数错误。 |
| InvalidParameterValue.MaterialNotMatch | 导入的密钥材料和历史导入不同。 |
| InvalidParameterValue.TagKeysDuplicated | 标签键重复。 |
| InvalidParameterValue.TagsNotExisted | 标签键或标签值不存在。 |
| LimitExceeded.CmkLimitExceeded | CMK数量已达上限。 |
| LimitExceeded.DataKeyLimitExceeded | DataKey超过上限 |
| LimitExceeded.FingerprintsLimitExceeded | 设备指纹个数超过限制。 |
| LimitExceeded.KeyLimitExceeded | 创建的密钥个数超过限制。 |
| ResourceUnavailable.CloudResourceBindingNotFound | cmk和云资源的绑定关系不存在。 |
| ResourceUnavailable.CmkArchived | CMK已存档。 |
| ResourceUnavailable.CmkDisabled | CMK已被禁用。 |
| ResourceUnavailable.CmkNotFound | CMK不存在。 |
| ResourceUnavailable.CmkNotPendingDelete | CMK不是计划删除状态不能被执行取消计划删除。 |
| ResourceUnavailable.CmkShouldBeDisabled | 未被禁用的CMK不能被计划删除。 |
| ResourceUnavailable.CmkStateNotSupport | CMK 状态不支持该操作。 |
| ResourceUnavailable.DataKeyDisabled | 数据密钥已禁用 |
| ResourceUnavailable.DataKeyNotFound | 数据密钥不存在 |
| ResourceUnavailable.DataKeyNotPendingDelete | 数据密钥不是计划删除状态不能被执行取消计划删除。 |
| ResourceUnavailable.DataKeyPendingDelete | 数据密钥已计划删除 |
| ResourceUnavailable.DataKeyStateNotSupport | 数据密钥状态不支持该操作 |
| ResourceUnavailable.KeyDisabled | 密钥已被禁用。 |
| ResourceUnavailable.KeyPendingDelete | 不可用密钥:密钥待删除。 |
| ResourceUnavailable.NotPurchased | 白盒密钥服务尚未开通。 |
| ResourceUnavailable.TokenExpired | Token已过期。 |
| UnsupportedOperation.ExternalCmkCanNotRotate | 用户导入类型的CMK禁止轮换。 |
| UnsupportedOperation.NotExternalCmk | CMK类型错误,仅支持External CMK。 |
| UnsupportedOperation.NotUserCreatedCmk | 仅支持对用户自己创建的CMK做更新。 |
| UnsupportedOperation.ServiceTemporaryUnavailable | 服务暂时不可用。 |
| UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion | 加密方式在当前region不支持。 |