Common Headers and Error Responses
Updated at:2025-10-27
Common header specifications
Common request headers
| Common headers | Description |
|---|---|
| Authorization | Include Access Key and request signature |
| Content-Type | application/json; charset=utf-8 |
| x-bce-date | A string representing the date, compliant with API specifications. |
Standard HTTP headers are not included here. Common header fields are mandatory and will appear in every API. For POST, PUT, DELETE, or other request types, the request data must be included in the request body.
Common response headers
| Common headers | Description |
|---|---|
| Content-Type | application/json; charset=utf-8 |
| x-bce-request-id | They are generated by the backend service and automatically set in the response header fields. |
Error response
When an error occurs during API access, the system will return the relevant error code and error message to help users identify and resolve the issue. If a request error happens, detailed error information is provided in the response body using the following format:
| Parameter name | Types | Description |
|---|---|---|
| code | String | Error code |
| message | String | Error description |
| requestId | String | requestID of this request |
Example:
Plain Text
1{
2 "code": "NoSuchObject",
3 "message": "account not exist",
4 "requestId": "c4abab14-ebc4-4eb0-85d2-03c4d51eed18"
5}
BCE global error codes
| Error return codes | Error message | Status code | Description |
|---|---|---|---|
| AccessDenied | Access denied. | 403 Forbidden | You do not have permission to access this resource. |
| InappropriateJSON | The JSON you provided was well-formed and valid, but not appropriate forthis operation. | 400 Bad Request | The JSON format in the request is correct but contains semantic errors. For instance, a required field might be missing, or the value type is incorrect. To maintain compatibility, any unrecognized items will be ignored, and no error will be returned for them. |
| InternalError | We encountered an internal error Please try again. | 500 Internal Server Error | All other undefined errors. This should not be used if there are clearly corresponding errors of other types, including both general and service-specific errors. |
| InvalidAccessKeyId | The Access Key ID you provided doesnot exist in our records. | 403 Forbidden | The specified Access Key ID does not exist. |
| InvalidHTTPAuthHeader | The Access Key ID you provided does notexist in our records. | 400 BadRequest | The authorization header format is invalid. |
| InvalidHTTPRequest | There was an error in the body of your HTTP request. | 400 Bad Request | The HTTP body format is invalid, e.g., it uses non-compliant encoding. |
| InvalidURI | Could not parse the specified URI. | 400 Bad Request | The URI format is invalid, for example, some service keywords do not match. For issues such as ID mismatches, more specific error codes, like NoSuchKey, should be used. |
| MalformedJSON | The JSON you provided was not well-formed. | 400 BadRequest | The JSON format is invalid. |
| InvalidVersion | The API version specified was invalid. | 404 NotFound | The URI version number is invalid. |
| OptInRequired | A subscription for the service is required. | 403 Forbidden | The corresponding service has not been activated. |
| PreconditionFailed | The specified If-Match header doesn’tmatch the ETag header. | 412 PreconditionFailed | Please refer to the Etag for more information. |
| RequestExpired | Request has expired. Timestamp date is . | 400 BadRequest | The request has timed out. Replace the date with x-bce-date. If only the Date field is included in the request, convert it to a datetime format. |
| IdempotentParameterMismatch | The request uses the same client token asa previous, but non-identical request. | 403 Forbidden | The API parameters vary based on the same clientToken. |
| SignatureDoesNotMatch | The request signature we calculated does not match the signature you provided. Check yourSecret Access Key and signing method. Consultthe service documentation for details. | 400 Bad Request | The signature in the Authorization header does not match the server's verification. |
Error return codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| RegistryAlreadyExist | Namespace Already exist. | 400 BadRequest | Domain name already exists |
| RegistryNoAuth | Authorization failed. | 404 NotFound | Auth authorization failed |
| RegistryInitFail | Init Registry failed. | 404 NotFound | Registry initialization failed |
| RegistryUpdateFail | Update user failed. | 404 NotFound | Registry update failed |
| RegistryUserNotFound | Cannot found user. | 404 NotFound | Registry user does not exist |
| RegistryLackParams | Bad request, lack param: user, namespace or public. | 404 NotFound | Missing parameter |
| RegistryOutOfLimit | Create failed, because number of namespaces out of limit. | 404 NotFound | Namespace quota exceeded |
| RegistryNamespaceNotFound | Cannot find Namespace. | 404 NotFound | Namespace not found |
| RegistryRepositoryNotFound | Cannot find Repository. | 404 NotFound | registry does not exist |
| RegistryTagNotFound | Cannot find tag. | 404 NotFound | Tag does not exist |
| RegistryDelFail | Delete manifest from registry failed. | 404 NotFound | Manifest deletion failed |
| RegistryInvalidParams | Invalid params to create image. | 404 NotFound | Registry update failed |
| RegistryNamespaceNotExist | Namespace is not exist. | 404 NotFound | Namespace does not exist |
| RegistryImageNotExist | Image is not exists. | 404 NotFound | Image does not exist |
| InternalServerError | Unknown error, please try again later. | 500 Internal Server | Internal server error |
| Cce.warning.UserNotExist | User not exist. | 404 NotFound | Username does not exist |
| Cce.ClusterDeleted | Cluster is deleted already. | 500 Internal Server | Cluster has been deleted |
| Cce.ClusterCreating | Cluster is creating. | 500 Internal Server | Cluster is being created |
| Cce.ClusterDeleting | Cluster is deleting. | 500 Internal Server | Cluster is being deleted |
| Cce.ClusterNotExit | Cluster is not exist. | 500 Internal Server | Cluster does not exist |
| DuplicateCLusterUuid | Generate cluster ID failed, please try again. | 500 Internal Server | Cluster creation failed. Please retry. |
| Cce.DeleteIDToken | BlbId or clientToken is null. | 500 Internal Server | BldID or clientToken is null |
| Cce.UpdateBlbId | BlbId is null. | 500 Internal Server | BlbId is null |
| Cce.CreateTokenNULL | ClientToken is null. | 500 Internal Server | clientToken is null |
| Cce.DeleteIdNULL | RouteRuled or clientToken is null. | 500 Internal Server | RouteRuled or clientToken is null |
| Cce.RouteInfoIdNULL | RouteTableId or vpcId is null. | 500 Internal Server | RouteTableId or vpcId is null |
| Cce.ClusterNotExit | Cluster is not exist. | 500 Internal Server | Cluster does not exist |
| Cce.EncryptFail | Encrypt passwd wrong. | 500 Internal Server | Password encryption error |
| Cce.DecryptFail | Decrypt passwd wrong. | 500 Internal Server | Password decryption error |
| Cce.MoreThanOneUserPerAccount | One can create only one user per account. | 500 Internal Server | Account must be unique |
| Cce.ImageMetaNull | ImageMeta is null. | 500 Internal Server | Image metadata is null |
| Cce.PasswdNotChange | New passwd should not as old. | 500 Internal Server | The new and old passwords must differ |
| Cce.UserExist | Username already exist. | 500 Internal Server | The username already exists |
| Cce.ConfirmFail | Passwd confirm fail. | 500 Internal Server | Password confirmation failed |
| Cce.UserNoAuth | User authorization failed. | 500 Internal Server | User auth authorization failed |
| Cce.NamespaceRepositoryOrTagNull | Namespace Repository or Tag is null. | 500 Internal Server | Image registry must be non-null |
| Cce.ImageTagFormatError | image tag cannot be empty, should be 1-65 characters long, and can only contain numbers, letters and '- _ /.' and can only start with letter or number | 500 Internal Server | Image format error |
| Cce.ImageRepositoryFormatError | image repository cannot be empty, should be 1-65 characters long, and can only contain numbers, letters and '- _ /.' and can only start with letter | 500 Internal Server | imageRepository format error |
| Cce.NamespaceNull | Namespace is null. | 500 Internal Server | Namespace is null |
| Cce.UserNameNull | Username cannot be empty. | 500 Internal Server | Username is null |
| Cce.NamespaceRequestFormatError | Username or namespace cannot be empty,namespace should be 1-65 characters long, and can only contain numbers and letters and '- _ /.' and only can start with letters. | 500 Internal Server | Namespace request format error |
| Cce.PasswordFormatError | Password format error or password conformation not same as password. | 500 Internal Server | Password format error |
| Cce.UserNameFormatError | Username format error,your username must be between 4 and 30 characters long, and can only contain numbers and lowercase letters. | 500 Internal Server | Username format error |
| Cce.WrongMainZone | Main zone in order is illegal. | 500 Internal Server | Invalid primary zone |
| Cce.namespaceOverQuota | Over the namespace quota. | 500 Internal Server | Domain name quota exceeded |
| Cce.slaveOverQuota | Over the slave quota. | 500 Internal Server | Slave quota exceeded |
| Cce.ClusterOverQuota | Over the cluster quota. | 500 Internal Server | Cluster quota exceeded |
| Cce.ContainerNetConflict | Container net conflict with vpc or other container nets in the same vpc. | 500 Internal Server | Container network conflict |
| Cce.IllegalArguments | Illegal arguments, check your input. | 500 Internal Server | Invalid parameter |
| Cce.UnsupportedPayType | Unsupported payment method. | 500 Internal Server | Payment method disabled |
| Cce.OrderError | Cluster order creation failed. | 500 Internal Server | Order error |
