功能说明
如果返回结果中存在 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 | 接口不支持所传地域。 |
业务错误码
| 错误码 | 说明 |
|---|---|
| FailedOperation.AccountAlreadyExistedInAccountGroup | 账号已存在于该账号组。 |
| FailedOperation.AccountGroupNameAlreadyExists | 账号组名称已存在。 |
| FailedOperation.AccountGroupNotExist | 账号组不存在。 |
| FailedOperation.AccountNameAlreadyExists | 账号名称已存在。 |
| FailedOperation.AccountNotExist | 账号不存在。 |
| FailedOperation.AccountNotExisted | 账号不存在。 |
| FailedOperation.AppDisplayNameAlreadyExists | 应用名称已存在。 |
| FailedOperation.AppNotExist | 应用不存在。 |
| FailedOperation.ChildOrgNodeNameAlreadyExists | 同一组织下相同名称的子组织机构已存在。 |
| FailedOperation.ChildOrgNodeWithUsersCanNotBeDeleted | 其子机构中存在用户的机构节点不能被删除。 |
| FailedOperation.CreateOrgNodeError | 创建机构节点失败。 |
| FailedOperation.CreateUserFailure | 创建用户异常。 |
| FailedOperation.CreateUserGroupError | 创建用户组失败。 |
| FailedOperation.CustomizeParentOrgNodeIdAlreadyExists | 自定义机构节点对外ID已存在。 |
| FailedOperation.CustomizedOrgNodeIdCanNotBeEmpty | 自定义机构节点对外ID不可填为空字符。 |
| FailedOperation.DefaultOrgNodeCanNotBeDeleted | 默认导入机构不能被删除。 |
| FailedOperation.DeleteOrgNodeError | 删除机构节点失败。 |
| FailedOperation.DeleteUserError | 删除用户失败。 |
| FailedOperation.DeleteUserExistsAdministrator | 用户为管理员,不能删除。 |
| FailedOperation.DeleteUserGroupError | 删除用户组失败。 |
| FailedOperation.DescribeOrgNodeError | 读取机构节点信息失败。 |
| FailedOperation.DescribeOrgNodeRootError | 读取根机构节点信息失败。 |
| FailedOperation.ExpectFieldsNotFound | 期望返回的用户属性类型不存在。 |
| FailedOperation.GroupIdNotFound | 用户组ID未找到。 |
| FailedOperation.IdToCodeError | ID转换编码失败。 |
| FailedOperation.LimitQuotaNotEnough | 同一个应用,相同的用户不能添加超过 %s 个映射关系。 |
| FailedOperation.ListUserGroupsOfUserError | 获取用户所在的用户组列表失败。 |
| FailedOperation.ListUsersInOrgNodeError | 读取节点下用户失败。 |
| FailedOperation.ListUsersInUserGroupError | 获取用户组中的用户列表失败。 |
| FailedOperation.MainOrgNodeNotExist | 主组织机构不存在。 |
| FailedOperation.OperationError | 操作失败。 |
| FailedOperation.OperationFailure | 操作失败。 |
| FailedOperation.OrgNodeIdNotExist | 机构节点ID不存在。 |
| FailedOperation.OrgNodeNotExist | 机构节点不存在。 |
| FailedOperation.OrgNodeRootCanNotBeDeleted | 机构根节点不能被删除。 |
| FailedOperation.OrgNodeSettingError | 组织机构设置失败,组织机构不可同时被选择为用户所属的主组织和次要机构。 |
| FailedOperation.OrgNodeWithUsersCanNotBeDeleted | 有用户存在的机构节点不能被删除。 |
| FailedOperation.ParentOrgNodeIdNotFound | 父机构节点ID未找到。 |
| FailedOperation.PersonNotFound | 身份主体未找到。 |
| FailedOperation.RemoveUsersFromUserGroupError | 从用户组中移除用户失败。 |
| FailedOperation.SecondaryOrgNodeDuplicates | 次要机构元素重复。 |
| FailedOperation.UpdateLDAPUserOrgExceedsRange | 不能变更LDAP导入的用户到目录外的组织机构下。 |
| FailedOperation.UpdateLDAPUserOrgNotInSameCrop | 不能变更LDAP导入的用户到其他目录的企业机构下。 |
| FailedOperation.UpdateUserExceedsRange | 不能变更自建用户到有同步操作类型的组织机构下。 |
| FailedOperation.UpdateWeComUserOrgExceedsRange | 不能变更企业微信用户到企业外的组织机构。 |
| FailedOperation.UpdateWeComUserOrgNotInSameCrop | 不能变更企业微信用户到非相同的企业机构下。 |
| FailedOperation.UserAuthListError | 获取用户被授权访问的应用列表失败。 |
| FailedOperation.UserEmailAlreadyExists | 用户邮箱已存在。 |
| FailedOperation.UserGroupNotExist | 用户组不存在。 |
| FailedOperation.UserNameAlreadyExists | 用户名字已存在。 |
| FailedOperation.UserNotExistInUserGroup | 用户不存在于该用户组。 |
| FailedOperation.UserNotFound | 用户不存在。 |
| FailedOperation.UserPhoneAlreadyExists | 用户手机已存在。 |
| InvalidParameter.AttributeValueValidError | 属性校验失败。 |
| InvalidParameter.OrgCodeIllegal | 组织机构代码不合法。 |
| InvalidParameter.ParameterIllegal | 参数不合法。 |
| InvalidParameter.Parameterlllegal | 参数不合法。 |
| InvalidParameter.SearchCriteriaIllegal | 列表搜索条件不合法。 |
| InvalidParameter.TimeFormatIllegal | 时间格式不合法。 |
| InvalidParameter.UserExpirationTimeIllegal | 设定的用户过期时间不合法。 |
| InvalidParameter.UserIDIsNull | 用户ID参数为空。 |
| InvalidParameter.UserNameIsNull | 用户名参数为空。 |
| InvalidParameterValue.AccountIdsCanNotBeEmpty | 账号ID列表不能为空。 |
| InvalidParameterValue.AppIdCanNotBeEmpty | 应用ID不能为空。 |
| InvalidParameterValue.ApplicationInfoSortKeyIllegal | 应用信息分页展示的排列属性不合法。 |
| InvalidParameterValue.EntityTypeNotMatch | EntityType不匹配。 |
| InvalidParameterValue.LengthExceeded | 参数的长度超出限制。 |
| InvalidParameterValue.NewPasswordCanNotBeEmpty | 新密码不能为空。 |
| InvalidParameterValue.ParameterIllegal | 参数不合法。 |
| InvalidParameterValue.SortKeyIllegal | 分页展示的排序属性不合法。 |
| InvalidParameterValue.UserIdCanNotBeEmpty | 用户ID不能为空。 |
| InvalidParameterValue.UserNameCanNotBeEmpty | 用户名不能为空。 |
| InvalidParameterValue.UserPhoneCanNotBeEmpty | 用户手机不能为空。 |
| LimitExceeded.ItemsNumberLimitExceeded | 数据条目数超出最大限制。 |
| LimitExceeded.ParameterLengthLimitExceeded | 输入参数超出长度限制。 |
| LimitExceeded.SecondaryNodeCountLimitExceeded | 用户的次要机构超出数量上限。 |
| OperationDenied.ActionPermissionDeny | 当前用户缺乏访问该操作的权限。 |