功能说明
如果返回结果中存在 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.AccountAlreadyBeLinked | 从账号已经被融合过,不允许再次融合。 |
| FailedOperation.AttributeFormatError | 用户属性格式异常。 |
| FailedOperation.AuthSourceNameAlreadyExists | 认证源名称已存在。 |
| FailedOperation.AuthSourceNotFound | 认证源不存在。 |
| FailedOperation.DataFlowTooManyRequests | 已存在2个有效的任务,请等待其中一部分完成后重试。 |
| FailedOperation.EmailAlreadyExists | 该邮箱已被用户绑定。 |
| FailedOperation.EmailIsNull | 邮箱地址不能为空。 |
| FailedOperation.ImportUserIsEmpty | 导入用户时,用户为空。 |
| FailedOperation.IndexedAttributeTooLong | indexedAttribute最长512字符。 |
| FailedOperation.InvalidTenant | 无效租户。 |
| FailedOperation.InvalidUserStatusEnum | 状态枚举值错误,请参考接口文档。 |
| FailedOperation.InvalidUserStore | 无效用户池。 |
| FailedOperation.PasswordIsNull | 密码不能为空。 |
| FailedOperation.PhoneNumberAlreadyExists | 该手机号已被用户绑定。 |
| FailedOperation.PhoneNumberIsNull | 电话号码不能为空。 |
| FailedOperation.PrimaryUserNotFound | 主用户不存在。 |
| FailedOperation.QueryUsersParameterMustInWhitelist | 查询条件必须包含id, userName, phoneNumber, email, userGroup, alipayUserId, wechatOpenId,wechatUnionId, qqOpenId, qqUnionId,lastModifiedDate, indexedAttribute1, indexedAttribute2,indexedAttribute3, indexedAttribute4, indexedAttribute5重的一个或者多个。 |
| FailedOperation.QueryUsersParameterRepeat | 查询用户条件不能有重复的条件。 |
| FailedOperation.QueryUsersSortParameterMustInWhitelist | Sort条件的PropertyKey必须在id, userName, phoneNumber, email, userGroup, alipayUserId, wechatOpenId,wechatUnionId, qqOpenId, qqUnionId,lastModifiedDate, indexedAttribute1, indexedAttribute2,indexedAttribute3, indexedAttribute4, indexedAttribute5中。 |
| FailedOperation.QuotaLimitExceeded | 配额超限,如有需求请联系客服人员。 |
| FailedOperation.SecondaryUserNotFound | 从用户不存在。 |
| FailedOperation.UserGroupNameAlreadyExists | 用户组名称已存在。 |
| FailedOperation.UserGroupNotFound | 用户组不存在。 |
| FailedOperation.UserIsFreeze | 用户已被冻结。 |
| FailedOperation.UserNameAlreadyExists | 用户名称已存在。 |
| FailedOperation.UserNameIsNull | 用户名不能为空。 |
| FailedOperation.UserNotFound | 用户不存在。 |
| FailedOperation.UserPropertyCodeAlreadyExists | 属性标识已存在。 |
| FailedOperation.UserPropertyNotFound | 用户属性不存在。 |
| FailedOperation.UserStatusRequired | 更新状态必传。 |
| FailedOperation.UserStoreAlreadyExists | 已存在相同用户目录名。 |
| FailedOperation.UserStoreDomainAlreadyExists | 已存在相同域名。 |
| FailedOperation.UserStoreNotExist | 用户目录不存在。 |
| InternalError.JudgeUserExistException | 判断存在用户内部请求错误,请稍后重试。 |
| InternalError.UnknownError | 未知错误。 |
| InternalError.UserStoreCreateSecretFail | 创建用户目录时创建密钥失败。 |
| InternalError.UserStoreDeleteUserFail | 删除用户目录时删除用户失败。 |
| InvalidParameter.ParameterIllegal | 请求参数不合法。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded.FrequentRequest | 请求过于频繁,请稍后再试。 |
| RequestLimitExceeded.RepeatRequest | 请求重复,请稍后再试。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation.TenantNotActivated | 服务未开通。 |
| UnsupportedOperation.EnabledAuthSourceCanNotBeDeleted | 认证源已启用,不允许删除。 |
| UnsupportedOperation.EnabledAuthSourceCanNotBeUpdated | 认证源已启用,不允许更新。 |
| UnsupportedOperation.InternalUserProperty | 内置属性不支持该操作。 |
| UnsupportedOperation.LinkedAppUserPropertyCanNotBeDeleted | 属性被应用关联,不允许删除。 |
| UnsupportedOperation.LinkedAuthSourceCanNotBeClosed | 认证源被应用关联,不允许关闭。 |
| UnsupportedOperation.LinkedAuthSourceCanNotBeDeleted | 认证源被应用关联,不允许删除。 |
| UnsupportedOperation.LinkedAuthSourceUserPropertyCanNotBeDeleted | 属性被认证源关联,不允许删除。 |
| UnsupportedOperation.LinkedUserPropertyCanNotBeDeleted | 属性被其它模块关联,不允许删除。 |
| UnsupportedOperation.PlatformDomainSuffixCanNotBeUsed | 不允许使用平台域名后缀作为自有域名后缀。 |
| UnsupportedOperation.WhenUserExistUserPropertyCanNotBeDeleted | 用户池下已存在用户,用户属性不允许被删除。 |