错误码

最近更新时间:2019-09-20 15:41:40

功能说明

如果返回结果中存在 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.AccountNotOwnContractError 该账号不具有该合同。
FailedOperation.AuthorizationTimeError 授权时间格式错误。
FailedOperation.BackendInterfaceError 后端接口调用失败。
FailedOperation.BackendInterfaceResponseContentError 后端接口返回内容异常,请检查请求参数。
FailedOperation.BackendInterfaceResponseHeaderError 后端接口返回头异常,请检查请求参数。
FailedOperation.CertTypeError 证书类型错误。
FailedOperation.CheckVcodeError 验证签署验证码失败。
FailedOperation.ContractExpired 合同已过期。
FailedOperation.ContractSignedError 该合同已被签署过。
FailedOperation.CoordinateError 坐标值错误,必须保证坐标值为数字。
FailedOperation.CoordinateOutsidePDF 坐标值超出PDF尺寸范围。
FailedOperation.CostAccountError 计费账户问题。
FailedOperation.CreateContractError 合同创建失败。
FailedOperation.CreateEnterpriseAccountError 创建企业账户失败,请检查请求参数。
FailedOperation.CreatePersonalAccountError 创建个人账户失败。
FailedOperation.CreateSealError 新增印章失败。
FailedOperation.DeleteAccountError 删除账户失败。
FailedOperation.DeleteSealError 删除印章失败。
FailedOperation.DescribeSubplatError 获取子平台信息失败。
FailedOperation.DescribeTaskStatusError 查询任务结果失败。
FailedOperation.DownloadSealError 下载签章文件失败,请确保路径正确。
FailedOperation.EnterpriseNameFormatError 企业名称格式错误,不能包含数字。
FailedOperation.FirstEnterpriseAccountDeleteError 不能删除第一个有效的企业账户。
FailedOperation.FormatError 签署关键字信息中存在格式错误(偏移坐标,签章图片宽/高度都必须为数字)。
FailedOperation.GetPDFSizeFailed 获得PDF页面尺寸失败。
FailedOperation.IPFormatError 授权IP地址格式错误。
FailedOperation.IdentNoFormatError 证件号码格式错误,请输入正确的个人/企业证件号码。
FailedOperation.IdentTypeError 证件类型错误,企业证件类型值只允许[0-8],个人证件类型值为0。
FailedOperation.ImageMeasurementOverLimitError 图片宽度/高度超过最大像素限制(300px)。
FailedOperation.ImageNotBase 图片数据应为BASE64编码格式。
FailedOperation.ImageNotPNG 图片数据应为PNG格式。
FailedOperation.MessageDataIllegal 报文不可包含以下字符 '%&<>。
FailedOperation.MessageDataOverSize 报文数据长度过长。
FailedOperation.NameContainsNumber 用户名称不能包含数字。
FailedOperation.NameIsPureNumber 企业名称不能为纯数字。
FailedOperation.NoPermissionToSign 用户没有开通代签权限。
FailedOperation.OffsetCoordOverLimitError 偏移坐标超过最大偏移量,X轴/Y轴最大偏移量为50。
FailedOperation.Other 其它。
FailedOperation.RepeatedCoordinate 签名域对角坐标值不能重复。
FailedOperation.SMSCodeExpired 短信验证码已超时。
FailedOperation.SMSCodeLengthWrong 短信校验码长度错误。
FailedOperation.SealMismatched 印章不匹配。
FailedOperation.SealNumOverLimit 印章数超过上限。
FailedOperation.SealsExceed 印章数量超出限制。
FailedOperation.SendVcodeError 发送签署验证码失败。
FailedOperation.SignContractByCoordinateError 按坐标签署合同失败。
FailedOperation.SignContractByKeywordError 按关键字签署合同失败。
FailedOperation.SignFieldNotFound 根据关键字获得PDF签名域失败。
FailedOperation.SignPageError 页数必须是自然数。
FailedOperation.SignPermissionExisted 已经开通代签权限。
FailedOperation.TransactorNameFormatError 经办人姓名格式错误,不能包含数字。
FailedOperation.TransactorPhoneFormatError 经办人手机号格式错误,必须为全数字。
FailedOperation.UpdateFeeStatusError 更新计费状态错误。
FailedOperation.VcodeChecked 已经开通代签权限。
FailedOperation.WrongCertType 证书类型为不支持的类型。
FailedOperation.WrongIdentNoFormat 身份证号格式错误。
FailedOperation.WrongIdentNoSize 身份证号只能为15或18位字符。
FailedOperation.WrongSMSCode 短信验证码不正确。
InternalError.UnknownError 内部错误。
MissingParameter.ContractFileNameError 合同名称不能为空。
MissingParameter.ContractFilePathError 合同文件路径不能为空。
MissingParameter.ImageMeasurementNullError 签署关键字信息-签章图片宽度/高度不能为空。
MissingParameter.KeywordNullError 签署关键字信息-关键字不能为空。
MissingParameter.LocationNullError 授权IP地址不能为空。
MissingParameter.MOError 找不到 module 或 operation。
MissingParameter.OffsetCoordNullError 签署关键字信息-偏移坐标不能为空。
MissingParameter.SignerNullError 签署人不能为空。
ResourceInUse.AccountExist 已经开过该账户。
ResourceInUse.EnterpriseAccountAlreadyExist 企业账户已存在。
ResourceInUse.PersonAccountAlreadyExist 个人账户已存在。
ResourceNotFound.AccountNotFound 账户不存在或已删除。
ResourceNotFound.ContractNotFound 合同ID不存在。
ResourceNotFound.ContractProjectCodeNotFound 合同project_code不存在。
ResourceNotFound.InitiatorNotFoundError 合同发起方账号不存在。
ResourceNotFound.SealNotFound 印章不存在。
ResourceNotFound.SubplatIdNotFound 子平台ID不存在。
ResourceNotFound.TaskNotFound 任务不存在。
ResourceUnavailable.AccountUnavailable 账户状态已冻结或已注销。
ResourceUnavailable.ContractSignerUnavailable 合同签署人不存在或状态异常,不能进行合同创建操作。
ResourceUnavailable.DownloadSealError 下载签章文件失败,请确保路径正确。
ResourceUnavailable.SubplatUnavailable 子平台欠费。