- Product Introduction
- Purchase Guide
- Operation Guide
- Development Guide
- API Documentation
- FAQs
- CIAM Policy
- Product Introduction
- Purchase Guide
- Operation Guide
- Development Guide
- API Documentation
- FAQs
- CIAM Policy
Feature Description
If there is an Error field in the response, it means that the API call failed. For example:
{
"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"
}
}
Code in Error indicates the error code, and Message indicates the specific information of the error.
Error Code List
Common Error Codes
| Error Code | Description |
|---|---|
| ActionOffline | This API has been deprecated. |
| AuthFailure.InvalidAuthorization | Authorization in the request header is invalid. |
| AuthFailure.InvalidSecretId | Invalid key (not a TencentCloud API key type). |
| AuthFailure.MFAFailure | MFA failed. |
| AuthFailure.SecretIdNotFound | Key does not exist. Check if the key has been deleted or disabled in the console, and if not, check if the key is correctly entered. Note that whitespaces should not exist before or after the key. |
| AuthFailure.SignatureExpire | Signature expired. Timestamp and server time cannot differ by more than five minutes. Please ensure your current local time matches the standard time. |
| AuthFailure.SignatureFailure | Invalid signature. Signature calculation error. Please ensure you’ve followed the signature calculation process described in the Signature API documentation. |
| AuthFailure.TokenFailure | Token error. |
| AuthFailure.UnauthorizedOperation | The request is not authorized. For more information, see the CAM documentation. |
| DryRunOperation | DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidAction | The API does not exist. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidRequest | The multipart format of the request body is incorrect. |
| IpInBlacklist | Your IP is in uin IP blacklist. |
| IpNotInWhitelist | Your IP is not in uin IP whitelist. |
| LimitExceeded | Quota limit exceeded. |
| MissingParameter | A parameter is missing. |
| NoSuchProduct | The product does not exist. |
| NoSuchVersion | The API version does not exist. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| RequestLimitExceeded.GlobalRegionUinLimitExceeded | Uin exceeds the frequency limit. |
| RequestLimitExceeded.IPLimitExceeded | The number of ip requests exceeds the frequency limit. |
| RequestLimitExceeded.UinLimitExceeded | The number of uin requests exceeds the frequency limit. |
| RequestSizeLimitExceeded | The request size exceeds the upper limit. |
| ResourceInUse | Resource is in use. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | Resource is unavailable. |
| ResponseSizeLimitExceeded | The response size exceeds the upper limit. |
| ServiceUnavailable | Service is unavailable now. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedProtocol | HTTP(S) request protocol error; only GET and POST requests are supported. |
| UnsupportedRegion | API does not support the requested region. |
Service Error Codes
| Error Code | Description |
|---|---|
| AuthFailure | A CAM signature/authentication error occurred. |
| FailedOperation.AccountAlreadyBeLinked | The secondary account has already been merged and cannot be merged again. |
| FailedOperation.AttributeFormatError | The user attribute format is abnormal. |
| FailedOperation.DataFlowTooManyRequests | There are already two valid tasks. Wait for one of them to complete and try again. |
| FailedOperation.EmailAlreadyExists | The email address has already been bound to a user. |
| FailedOperation.EmailIsNull | The email address cannot be empty. |
| FailedOperation.ImportUserIsEmpty | The user is empty during user import. |
| FailedOperation.IndexedAttributeTooLong | indexedAttribute can contain up to 512 characters. |
| FailedOperation.InvalidTenant | The tenant is invalid. |
| FailedOperation.InvalidUserStatusEnum | The status enumerated value is wrong. See the API documentation. |
| FailedOperation.InvalidUserStore | The user pool is invalid. |
| FailedOperation.PasswordIsNull | The password cannot be empty. |
| FailedOperation.PhoneNumberAlreadyExists | The mobile number has already been bound to a user. |
| FailedOperation.PhoneNumberIsNull | The mobile number cannot be empty. |
| FailedOperation.PrimaryUserNotFound | The primary user does not exist. |
| FailedOperation.QueryUsersParameterMustInWhitelist | The query condition must contain at least one of the followings: userName, phoneNumber, email, userGroup, alipayUserId, wechatOpenId,wechatUnionId, qqOpenId, qqUnionId,lastModifiedDate, indexedAttribute1, indexedAttribute2,indexedAttribute3, indexedAttribute4, indexedAttribute5. |
| FailedOperation.QueryUsersParameterRepeat | The conditions can not duplicate. |
| FailedOperation.QueryUsersSortParameterMustInWhitelist | The PropertyKey of Sort must include one of the followings: id, userName, phoneNumber, email, userGroup, alipayUserId, wechatOpenId,wechatUnionId, qqOpenId, qqUnionId,lastModifiedDate, indexedAttribute1, indexedAttribute2,indexedAttribute3, indexedAttribute4, indexedAttribute5. |
| FailedOperation.QuotaLimitExceeded | The quota is exceeded. Contact customer service. |
| FailedOperation.SecondaryUserNotFound | The secondary user does not exist. |
| FailedOperation.UserGroupNotFound | The user group does not exist. |
| FailedOperation.UserIsFreeze | The user account is frozen. |
| FailedOperation.UserNameAlreadyExists | The user name already exists. |
| FailedOperation.UserNameIsNull | The username cannot be empty. |
| FailedOperation.UserNotFound | The user does not exist. |
| FailedOperation.UserStatusRequired | The updated status is required. |
| InternalError.UnknownError | An unknown error occurred. |
| InvalidParameter.ParameterIllegal | The request parameter is invalid. |
| OperationDenied | The operation was denied. |
| RequestLimitExceeded.FrequentRequest | Too many requests. Try again later. |
| RequestLimitExceeded.RepeatRequest | Repeated request. Try again later. |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation.TenantNotActivated | The service is not activated. |
Yes
No
Was this page helpful?