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 | Description |
---|---|
UnsupportedOperation | Unsupported operation. |
ResourceInUse | Resource is in use. |
InternalError | Internal error. |
RequestLimitExceeded | The number of requests exceeds the frequency limit. |
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. |
LimitExceeded | Quota limit exceeded. |
NoSuchVersion | The API version does not exist. |
ResourceNotFound | The resource does not exist. |
AuthFailure.SignatureFailure | Invalid signature. Signature calculation error. Please ensure you’ve followed the signature calculation process described in the Signature API documentation. |
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. |
UnsupportedRegion | API does not support the requested region. |
UnauthorizedOperation | Unauthorized operation. |
InvalidParameter | Incorrect parameter. |
ResourceUnavailable | Resource is unavailable. |
AuthFailure.MFAFailure | MFA failed. |
AuthFailure.UnauthorizedOperation | The request is not authorized. For more information, see the CAM documentation. |
AuthFailure.InvalidSecretId | Invalid key (not a TencentCloud API key type). |
AuthFailure.TokenFailure | Token error. |
DryRunOperation | DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used. |
FailedOperation | Operation failed. |
UnknownParameter | Unknown parameter. |
UnsupportedProtocol | HTTP(S) request protocol error; only GET and POST requests are supported. |
InvalidParameterValue | Invalid parameter value. |
InvalidAction | The API does not exist. |
MissingParameter | A parameter is missing. |
ResourceInsufficient | Insufficient resource. |
The billable API calls are successful calls and failed calls that return the error code InvalidParameterValue.NoFaceInPhoto
(for images without face).
Error Code | Description |
---|---|
FailedOperation.AcrossVersionsError | This operation cannot be performed across algorithm model versions. |
FailedOperation.ConflictOperation | The operations conflict. Do not operate on the same person simultaneously. |
FailedOperation.CreateFaceConcurrent | Faces cannot be added concurrently. |
FailedOperation.DuplicatedGroupDescription | The custom description field must be unique in the group. |
FailedOperation.FaceQualityNotQualified | The face image quality does not meet the requirement. |
FailedOperation.FaceSizeTooSmall | The face frame size is smaller than the MinFaceSize value, and the face is filtered out. |
FailedOperation.GroupInDeletedState | The current group is being deleted. Please wait. |
FailedOperation.GroupPersonMapExist | The ID of the corresponding person is already in the group. |
FailedOperation.GroupPersonMapNotExist | The ID of the corresponding person is not in the group. |
FailedOperation.ImageDecodeFailed | Image decoding failed. |
FailedOperation.ImageDownloadError | An error occurred while downloading the image. |
FailedOperation.ImageFacedetectFailed | Face detection failed. |
FailedOperation.ImageResolutionExceed | The image resolution is too high. |
FailedOperation.ImageResolutionTooSmall | The image short edge resolution is smaller than 64. |
FailedOperation.ImageSizeExceed | The size of the Base64-encoded image cannot exceed 5 MB. |
FailedOperation.RequestLimitExceeded | The request frequency exceeds the limit. |
FailedOperation.RequestTimeout | The backend service timed out. |
FailedOperation.SearchFacesExceed | The number of faces searched for exceeds the limit. |
FailedOperation.ServerError | The algorithm service is exceptional. Please retry. |
InvalidParameter.InvalidParameter | Invalid parameter. |
InvalidParameterValue.AccountFaceNumExceed | The number of faces in the account exceeds the limit. |
InvalidParameterValue.DeleteFaceNumExceed | The number of faces to be deleted exceeds the limit. Every person must have at least one face image. |
InvalidParameterValue.FaceMatchThresholdIllegal | Invalid FaceMatchThreshold parameter. |
InvalidParameterValue.FaceModelVersionIllegal | The algorithm model version is invalid. |
InvalidParameterValue.GroupExDescriptionsExceed | The array length of the group's custom description fields exceeds the limit. Up to 5 fields can be created. |
InvalidParameterValue.GroupExDescriptionsNameIdentical | The name of the group's custom description field must be unique. |
InvalidParameterValue.GroupExDescriptionsNameIllegal | The name of the group's custom description field contains invalid characters. It can contain only letters, - , _ , and digits. |
InvalidParameterValue.GroupExDescriptionsNameTooLong | The name of the group's custom description field exceeds the length limit. |
InvalidParameterValue.GroupFaceNumExceed | The number of faces in the group exceeds the limit. |
InvalidParameterValue.GroupIdAlreadyExist | The group ID already exists. It must be unique. |
InvalidParameterValue.GroupIdIllegal | The group ID contains invalid characters. It can contain only letters, digits, and special symbols (-%@#&_). |
InvalidParameterValue.GroupIdNotExist | The group ID does not exist. |
InvalidParameterValue.GroupIdNotExists | The corresponding group ID does not exist. |
InvalidParameterValue.GroupIdTooLong | The group ID exceeds the length limit. |
InvalidParameterValue.GroupIdsExceed | The list of groups passed in exceeds the limit. |
InvalidParameterValue.GroupNameAlreadyExist | The group name already exists. It must be unique. |
InvalidParameterValue.GroupNameIllegal | The group name contains invalid characters. It can contain only letters, - , _ , and digits. |
InvalidParameterValue.GroupNameTooLong | The group name exceeds the length limit. |
InvalidParameterValue.GroupNumExceed | The number of groups exceeds the limit. If you need more, please contact us. |
InvalidParameterValue.GroupNumPerPersonExceed | The number of groups exceeds the limit. One person can be added to up to 100 groups. |
InvalidParameterValue.GroupTagIllegal | The group remarks field contains invalid characters. It can contain only letters, - , _ , and digits. |
InvalidParameterValue.GroupTagTooLong | The group remarks field exceeds the length limit. |
InvalidParameterValue.ImageEmpty | Empty image. |
InvalidParameterValue.ImageEmptyError | Empty image. |
InvalidParameterValue.LimitExceed | The number of returned results exceeds the limit. |
InvalidParameterValue.NoFaceInGroups | There are no faces in the specified group. |
InvalidParameterValue.NoFaceInPhoto | There are no faces in the image. |
InvalidParameterValue.OffsetExceed | The starting number is too large. Please check the length of the array to be requested. |
InvalidParameterValue.PersonExDescriptionInfosExceed | The array length of the person's custom description fields exceeds the limit. Up to 5 fields are allowed. |
InvalidParameterValue.PersonExDescriptionsNameIdentical | The name of the person's custom description field must be unique. |
InvalidParameterValue.PersonExDescriptionsNameIllegal | The name of the person's custom description field contains invalid characters. It can contain only letters, - , _ , and digits. |
InvalidParameterValue.PersonExDescriptionsNameTooLong | The name of the person's custom description field exceeds the length limit. |
InvalidParameterValue.PersonExistInGroup | The ID of the corresponding person is already in the group. |
InvalidParameterValue.PersonFaceNumExceed | The number of face images for the person exceeds the limit. One person can have up to 5 face images. |
InvalidParameterValue.PersonGenderIllegal | An error occurred while setting person gender. 0: empty; 1: male; 2: female. |
InvalidParameterValue.PersonIdAlreadyExist | The person ID already exists. It must be unique. |
InvalidParameterValue.PersonIdIllegal | The person ID contains invalid characters. It can contain only letters, digits, and -%@#&_. |
InvalidParameterValue.PersonIdNotExist | The person ID does not exist. |
InvalidParameterValue.PersonIdTooLong | The person ID field exceeds the length limit. |
InvalidParameterValue.PersonNameIllegal | The person name contains invalid characters. It can contain only letters, - , _ , and digits. |
InvalidParameterValue.PersonNameTooLong | The person name exceeds the length limit. |
InvalidParameterValue.QualityControlIllegal | Invalid QualityControl parameter. |
InvalidParameterValue.SearchPersonsExceed | The number of persons searched for exceeds the limit. |
InvalidParameterValue.UniquePersonControlIllegal | Invalid UniquePersonControl parameter. |
InvalidParameterValue.UnsupportedGroupFaceModelVersion | This operation is not supported by algorithm model v2.0 or below. |
InvalidParameterValue.UploadFaceNumExceed | Up to four faces can be uploaded at a time. |
InvalidParameterValue.UrlIllegal | Invalid URL format. |
LimitExceeded.ErrorFaceNumExceed | The number of faces exceeds the limit. |
MissingParameter.ErrorParameterEmpty | A required parameter is empty. |
ResourceUnavailable.ChargeStatusException | The account is in arrears. |
ResourceUnavailable.Delivering | The resource is being shipped. |
ResourceUnavailable.Freeze | The account is frozen. |
ResourceUnavailable.GetAuthInfoError | Failed to get the authentication information. |
ResourceUnavailable.InArrears | The account is in arrears. |
ResourceUnavailable.LowBalance | Insufficient balance. |
ResourceUnavailable.NotExist | The billing status is unknown. Please check whether the service has been activated in the console. |
ResourceUnavailable.NotReady | The service is not activated. |
ResourceUnavailable.Recover | The resource has been repossessed. |
ResourceUnavailable.StopUsing | The service has been suspended for the account. |
ResourceUnavailable.UnknownStatus | The billing status is unknown. |
ResourcesSoldOut.ChargeStatusException | The billing status is exceptional. |
UnsupportedOperation.UnknowMethod | Unknown method name. |
Was this page helpful?