错误码

最近更新时间:2019-12-05 19:43:27

功能说明

如果返回结果中存在 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 表示该错误的具体信息。

错误码列表

公共错误码

错误码 说明
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 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
NoSuchVersion 接口版本不存在。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
UnsupportedProtocol HTTP(S)请求协议错误,只支持 GET 和 POST 请求。
UnsupportedRegion 接口不支持所传地域。

业务错误码

错误码 说明
FailedOperation.ActionUnreachable 动作消息不可达。
InternalError 内部错误。
InternalError.DBOpertaionError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
InvalidParameter 参数错误。
InvalidParameter.ActionInputParamsInvalid 动作输入参数不合法。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ActionNilOrNotExist 动作为空或不存在。
InvalidParameterValue.AppDescriptionTooLong 应用描述过长。
InvalidParameterValue.AppExists App已存在。
InvalidParameterValue.AppNameTooLong 应用名称过长。
InvalidParameterValue.AppNoPermission App无权限。
InvalidParameterValue.AppNotExists App不存在。
InvalidParameterValue.DeviceAlreadyExist 创建的设备名已存在。
InvalidParameterValue.DeviceNameInvalid 设备名称非法。
InvalidParameterValue.ErrorTaskNotExist 任务不存在。
InvalidParameterValue.ModelDefineDontMatchTemplate 物模型不符合产品模板。
InvalidParameterValue.ModelDefineDupID 物模型存在重复ID。
InvalidParameterValue.ModelDefineErrorModel 物模型事件/属性Model错误。
InvalidParameterValue.ModelDefineErrorType 物模型事件/属性Model Type错误。
InvalidParameterValue.ModelDefineEventParamsDupID 物模型EVENT Parms存在重复ID。
InvalidParameterValue.ModelDefineEventParamsExceedLimit 物模型EVENT Parms数量超过限制。
InvalidParameterValue.ModelDefineEventPropNameError 物模型事件/属性 Name 错误。
InvalidParameterValue.ModelDefineInvalid 数据模板未定义。
InvalidParameterValue.ModelDefineNil 物模型为空。
InvalidParameterValue.ModelDefinePropBoolMappingError 物模型事件/属性 BOOL类型 Mapping 定义错误。
InvalidParameterValue.ModelDefinePropEnumMappingError 物模型事件/属性 Enum类型 Mapping 定义错误。
InvalidParameterValue.ModelDefinePropRangeError 物模型事件/属性 Min/Max 定义错误。
InvalidParameterValue.ModelDefinePropRangeOverflow 物模型事件/属性 Min/Max 范围超限。
InvalidParameterValue.ModelPropertyNotExist 属性ID不存在。
InvalidParameterValue.MsgContentInvalid 消息内容非法。
InvalidParameterValue.MsgLevelInvalid 消息等级非法。
InvalidParameterValue.MsgTitleInvalid 消息标题非法。
InvalidParameterValue.MsgTypeInvalid 消息类型非法。
InvalidParameterValue.ProductAlreadyExist 创建的产品名已存在。
InvalidParameterValue.ProductIDInvalid 产品ID非法。
InvalidParameterValue.ProductParmsError 产品参数错误。
InvalidParameterValue.ProjectParmsError 项目参数错误。
InvalidParameterValue.UserIDInvalid 用户ID非法。
LimitExceeded.ApplicationExceedLimit 应用数量超出限制。
LimitExceeded.DeviceExceedLimit 设备数量超过限制。
LimitExceeded.ProjectExceedLimit 项目数量超出限制。
LimitExceeded.StudioProductExceedLimit 产品数量超出限制。
LimitExceeded.ThingModelExceedLimit 物模型超出限制。
MissingParameter.ModelDefineEventTypeError 物模型事件 Type 错误。
ResourceNotFound.DeviceDupKeyExist 存在重复设备。
ResourceNotFound.DeviceNotExist 设备不存在。
ResourceNotFound.DeviceShadowNotExist 设备没有影子信息。
ResourceNotFound.ModuleNotExist 模组不存在或改动未生效。
ResourceNotFound.ProductNotExist 产品不存在。
ResourceNotFound.ProductOrDeviceNotExist 产品或设备不存在。
ResourceNotFound.ProjectNotExist 项目不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.AppNoPermission App无权限。
UnauthorizedOperation.NoPermissionToProject 项目ACL错误。
UnauthorizedOperation.NoPermissionToStudioProduct 产品ACL错误。
UnauthorizedOperation.ProductNotSupportPSK 产品不支持密钥认证。
UnsupportedOperation.DeviceOtaTaskInProgress 设备ota升级中。
UnsupportedOperation.DevicesExistUnderProduct 产品下还存在未删除的设备。
UnsupportedOperation.ProductDupKeyExist 存在重复产品。
UnsupportedOperation.ProductExistUnderProject 项目下有产品。
UnsupportedOperation.ProjectDupKeyExist 存在重复项目。