文档

公共错误码

更新时间:

本文介绍API请求发生错误时的公共错误码。

当API请求发生错误时,服务端会返回错误信息,包括HTTP状态码和响应Body中的具体错误细节。其中响应Body中的错误细节使用Protocol Buffers编码,使用如下消息定义:

message Error {
     int32 StatusCode = 1;
     string ErrorCode = 2;
     string ErrorMessage = 3;
     string RequestId = 4;
}

在服务端返回的错误信息中,适用于大部分API接口,但存在部分错误信息为某些API所独有的情况。下表描述API错误响应信息中的通用错误码,它们会在多个API错误响应信息中出现。每个API所独有的错误码会在对应API文档中单独描述。

HTTP状态码

错误码

错误消息

描述

400

InvalidApiName

The ApiName "<apiname>" is invalid.

API名称错误。

400

InvalidApiVersion

The ApiVersion "<apiversion value>" is invalid.

请求头缺少x-kms-apiversion。请您检查请求头,确认存在x-kms-apiversion。

400

InvalidParam

The Param Date is invalid.

请求头中Date的值不符合RFC 1123标准。请您检查请求头,确认Date取值符合RFC 1123标准。

400

InvalidParam

The Param x-kms-signaturemethod is invalid.

没有提供HTTP请求头x-kms-signaturemethod。请您检查请求头,确认存在x-kms-signaturemethod。

400

InvalidParam

The Param x-kms-signaturemethod is invalid. message:"<signaturemethod value>".

不支持x-kms-signaturemethod头部指定的签名方法。请您检查请求头,确认支持的签名方法。

400

MissingParameter

Parameter x-kms-acccesskeyid does not exist in http header or body.

没有在Authorization头部提供AccessKey ID。请检查请求头,确认Authorization头部存在AccessKey ID。

如果您使用的阿里云SDK访问,请确保使用的是KMS实例SDK

400

RequestTimeTooSkewed

Request time exceeds server time more than 15 minutes.

请求的发送时间超过当前服务处理时间前后15分钟的范围。请检查您的服务器时间。

400

InvalidParameter

The specified parameter is not valid.

参数非法。

400

UnsupportedOperation

Rejected.UnsupportedOperation

详细介绍,请参见调用KMS接口时出现UnsupportedOperation报错

401

SignatureNotMatch

Signature is not matched.

请求的数字签名不匹配。请您更换为正确的ClientKey后重试。

403

Forbidden.NoPermission

This operation for "<parameter name>" is forbidden by permission system.

操作无权限。请检查应用接入点(AAP)的访问策略,具体操作,请参见创建应用接入点

404

Forbidden.KeyNotFound

The key Key ID or Alias does not exist in the system.

密钥不存在。

404

Forbidden.KeyNotFound

The key Key ID or Alias does not exist in the key store "<parameter name>".

密钥不存在。

404

Forbidden.KeyNotFound

The specified key does not exist.

密钥不存在。

404

Unauthorized

The AccessKey ID "<accessKeyId>" does not exist in our records.

AccessKey ID不存在。AccessKey ID指的是ClientKey_KAAP中的KeyId,请检查您的ClientKey配置,具体请参见创建应用接入点

409

Rejected.PendingDeletion

The request was rejected because the key state is PendingDeletion.

密钥状态为待删除。

409

Rejected.Disabled

The request was rejected because the key state is Disabled.

密钥状态为禁用。

409

Rejected.PendingImport

The request was rejected because the key state is PendingImport.

密钥状态为待导入。

413

所有请求参数使用Protocol Buffers编码后(即Request Body),内容长度超过了3 MB。

  • 加解密操作:建议单次使用对称密钥加解密的数据不超过6 KB,单次使用非对称密钥加解密的数据不超过1 KB,超过后请使用信封加密。

  • 签名验签操作:签名消息较大时,建议您的应用在本地对消息生成摘要后,再调用Sign/Verify接口进行签名或验签。

415

InvalidContentType

Content-Type "<type>" is unsupported.

不支持该类型的Content-Type。

500

InternalFailure

Internal Failure.

服务内部错误,请联系技术支持人员。具体操作,请参见联系我们

503

ServiceUnavailableTemporary

Service Unavailable Temporary.

服务暂时不可用,请稍后重试。