Help Center> Scalable File Service> API Reference> Appendix> SFS 3.0 Capacity-Oriented Error Codes

Updated on 2024-03-05 GMT+08:00

View PDF

SFS 3.0 Capacity-Oriented Error Codes

If an API calling fails, no result data is returned. You can locate the cause of the error according to the error code of each API. If an API calling fails, HTTP status code 3xx, 4xx or 5xx is returned. The response body contains the specific error code and information. If you are unable to identify the cause of an error, contact customer service and provide the error code so that we can help you solve the problem as soon as possible.

Error Response Syntax

When an error occurs, the response header information contains:

Content-Type: application/xml
HTTP error status code 3xx, 4xx, or 5xx

The response body also contains information about the error. The following is an error response example that shows common elements in the Representational State Transfer (REST) error response body.

    
         <?xml version="1.0" encoding="UTF-8"?> 
<Error> 
<Code>NoSuchKey</Code> 
<Message>The resource you requested does not exist</Message> 
<Resource>/example-filesystem/object</Resource> 
<RequestId>001B21A61C6C0000013402C4616D5285</RequestId> 
<HostId>RkRCRDJENDc5MzdGQkQ4OUY3MTI4NTQ3NDk2Mjg0M0FB 
QUFBQUFBYmJiYmJiYmJD</HostId> 
</Error>

Table 1 describes the meaning of each element.

**Table 1** Error response elements
Element	Description
Error	Root element that describes the error in an XML response body
Code	HTTP return code that corresponds to the error in the XML response body. For details about error codes, see Table 2.
Message	Error details in the XML response body. For details about error messages, see Table 2.
RequestId	ID of the request whose error response is returned. The ID is used for locating the error.
HostId	ID of the server that returns an error response
Resource	File system or object related to an error.

Some error responses contain more detailed information. It is recommended that all error information be logged for easier rectification of errors.

Description

If SFS encounters an error when processing a request, a response containing the error code and description will be returned. Table 2 describes the error codes of SFS 3.0 Capacity-Oriented.

**Table 2** Error codes
Status Code	Error Code	Error Message	Solution
301 Moved Permanently	PermanentRedirect	The requested file system can be accessed only through the specified address. Send subsequent requests to the address.	Send the request to the returned redirection address.
301 Moved Permanently	WebsiteRedirect	The website request lacks bucketName.	Put the file system name in the request and try again.
307 Moved Temporarily	TemporaryRedirect	Temporary redirection. If the DNS is updated, the request is redirected to the file system.	The system automatically redirects the request or sends the request to the redirection address.
400 Bad Request	BadDigest	The object content MD5 value specified by the client is inconsistent with that received by the system.	Check whether the MD5 value carried in the header is the same as that calculated by the message body.
400 Bad Request	BadDomainName	The domain name is invalid.	Use a valid domain name.
400 Bad Request	BadRequest	Invalid request parameters.	Modify the parameters according to the error details in the message body.
400 Bad Request	CustomDomainAreadyExist	The configured domain already exists.	It has been configured and does not need to be configured again.
400 Bad Request	CustomDomainNotExist	Delete the domain that does not exist.	It is not configured or has been deleted. You do not need to delete it.
400 Bad Request	EntityTooLarge	The size of the object uploaded using the POST method exceeds the upper limit.	Modify the conditions specified in the upload policy or reduce the object size.
400 Bad Request	EntityTooSmall	The size of the object uploaded using the POST method does not reach the lower limit.	Modify the conditions specified in the upload policy or increase the object size.
400 Bad Request	IllegalLocationConstraintException	A request without Location is sent for creating a file system in a non-default region.	Send the file system creation request to the default region, or send the request with the Location of a non-default region.
400 Bad Request	IncompleteBody	No complete request body is received due to network or other problems.	Upload the object again.
400 Bad Request	IncorrectNumberOfFilesInPost Request	Each POST request must contain one file to be uploaded.	Carry a file to be uploaded.
400 Bad Request	InvalidArgument	Invalid parameter.	Modify the parameter according to the error details in the message body.
400 Bad Request	InvalidBucket	The file system to be accessed does not exist.	Try again with another file system name.
400 Bad Request	InvalidBucketAlias	The file system alias in the request is too long or contains special characters that are not allowed.	Try again with another file system alias.
400 Bad Request	InvalidBucketName	The file system name in the request is too long or contains special characters that are not allowed.	Try again with another file system name.
400 Bad Request	InvalidEncryptionAlgorithmError	Incorrect encryption algorithm. The object cannot be decrypted due to incorrect encryption header carried when downloading the SSE-C encrypted object.	Carry the correct encryption header when downloading the object.
400 Bad Request	InvalidLocationConstraint	The specified Location in the file system creation request is invalid or does not exist.	Correct the Location in the file system creation request.
400 Bad Request	InvalidPart	One or more specified parts are not found. The parts may not be uploaded or the specified entity tags (ETags) do not match the parts' ETags.	Merge the parts correctly according to the ETags.
400 Bad Request	InvalidPartOrder	Parts are not listed in ascending order by part number.	Sort the parts in ascending order and merge them again.
400 Bad Request	InvalidPolicyDocument	The content of the form does not meet the conditions specified in the policy document.	Modify the policy in the constructed form according to the error details in the message body and try again.
400 Bad Request	InvalidRedirectLocation	Invalid redirect location.	Specifies the correct IP address.
400 Bad Request	InvalidRequest	Invalid request.	Modify the parameter according to the error details in the message body.
400 Bad Request	InvalidRequestBody	The request body is invalid. The request requires a message body but no message body is uploaded.	Upload the message body in the correct format.
400 Bad Request	InvalidTargetBucketForLogging	The delivery group has no ACL permission for the target file system.	Configure the ACL for the target file system and try again.
400 Bad Request	KeyTooLongError	The provided key is too long.	Use a shorter key.
400 Bad Request	KMS.DisabledException	The customer master key (CMK) is disabled in SSE-KMS mode.	Replace the key and try again, or contact with the technical support.
400 Bad Request	KMS.NotFoundException	The customer master key (CMK) does not exist in SSE-KMS mode.	Retry with the correct CMK.
400 Bad Request	MalformedACLError	The provided XML file is in an incorrect format or does not meet format requirements.	Use the correct XML format to retry.
400 Bad Request	MalformedError	The XML format in the request is incorrect.	Use the correct XML format to retry.
400 Bad Request	MalformedLoggingStatus	The XML format of Logging is incorrect.	Use the correct XML format to retry.
400 Bad Request	MalformedPolicy	The bucket policy does not pass.	Modify the file system policy according to the error details returned in the message body.
400 Bad Request	MalformedQuotaError	The Quota XML format is incorrect.	Use the correct XML format to retry.
400 Bad Request	MalformedXML	An XML file of a configuration item is in incorrect format.	Use the correct XML format to retry.
400 Bad Request	MaxMessageLengthExceeded	Copying an object does not require a message body in the request.	Remove the message body and retry.
400 Bad Request	MetadataTooLarge	The size of the metadata header has exceeded the upper limit.	Reduce the size of the metadata header.
400 Bad Request	MissingRegion	No region contained in the request and no default region defined in the system.	Carry the region information in the request.
400 Bad Request	MissingRequestBodyError	This error code is returned after you send an empty XML file.	Provide the correct XML file.
400 Bad Request	MissingRequiredHeader	Required headers are missing in the request.	Provide required headers.
400 Bad Request	MissingSecurityHeader	A required header is not provided.	Provide required headers.
400 Bad Request	TooManyBuckets	You have attempted to create more file systems than allowed.	Delete some file systems and try again.
400 Bad Request	TooManyBucketAliases	You have attempted to create more file system aliases than allowed.	Delete some file system aliases and try again.
400 Bad Request	TooManyCustomDomains	Too many user accounts are configured.	Delete some user accounts and try again.
400 Bad Request	TooManyWrongSignature	The request is rejected due to high-frequency errors.	Replace the Access Key and try again.
400 Bad Request	UnexpectedContent	The request requires a message body which is not carried by the client, or the request does not require a message body but the client carries the message body.	Try again according to the instruction.
400 Bad Request	UserKeyMustBeSpecified	This operation is available only to specific users.	Contact technical support.
400 Bad Request	ContentSHA256Mismatch	The object's SHA-256 value calculated by the client is different from that calculated by the server.	Check whether the SHA-256 value calculated by the client is correct.
403 Forbidden	AccessDenied	Access denied, because the request does not carry a date header or the header format is incorrect.	Provide a correct date header in the request.
403 Forbidden	AccessForbidden	Insufficient permission. No CORS configuration exists for the file system or the CORS rule does not match.	Modify the CORS configuration of the file system or send the matched OPTIONS request based on the CORS configuration of the file system.
403 Forbidden	AllAccessDisabled	You have no permission to perform the operation. The file system name is forbidden.	Try again with another file system name.
403 Forbidden	DeregisterUserId	The user has been deregistered.	Top up or re-register.
403 Forbidden	InArrearOrInsufficientBalance	The subscriber owes fees or the account balance is insufficient, and the subscriber does not have the permission to perform an operation.	Top up.
403 Forbidden	InsufficientStorageSpace	Insufficient storage space.	If the quota is exceeded, increase quota or delete some objects.
403 Forbidden	InvalidAccessKeyId	The access key ID provided by the customer does not exist in the system.	Provide correct access key Id.
403 Forbidden	InvalidObjectState	You need to restore ArchiveCold objects first before downloading them.	Restore the object first.
403 Forbidden	NotSignedUp	Your account is not in the system. The account must be registered before you can use it.	Register OBS.
403 Forbidden	RequestTimeTooSkewed	There was a large time offset between the OBS server time and the time when the client initiated a request. For security purposes, OBS verifies the time offset between the client and server. If the offset is longer than 15 minutes, the OBS server will reject your requests and this error message is reported.	Check whether there is a large time offset between the client time and server time. If there is, adjust the client time based on your local time (UTC) and try again.
403 Forbidden	SignatureDoesNotMatch	The provided signature does not match the signature calculated by the system.	Check your secret access key and signature algorithm. For details, Why Don't the Signatures Match?
403 Forbidden	VirtualHostDomainRequired	Virtual hosting access domain name is not used.	Use the virtual hosting access domain name. For details, see Constructing a Request.
403 Forbidden	Unauthorized	The user has not been authenticated in real name.	Authenticate the user's real name and try again.
403 Forbidden	RequestPayerDenied	This is a requester-pays file system.	Carry the header x-obs-request-payer: requester in the access request.
404 Not Found	NoSuchBucket	The specified file system does not exist.	Create a file system and perform the operation again.
404 Not Found	NoSuchBucketAlias	The specified file system alias does not exist.	Create a file system alias and perform the operation again.
404 Not Found	NoSuchBucketPolicy	No file system policy exists.	Configure a file system policy.
404 Not Found	NoSuchCORSConfiguration	No CORS configuration exists.	Configure CORS first.
404 Not Found	NoSuchCustomDomain	The requested user account does not exist.	Set a user account first.
404 Not Found	NoSuchKey	The specified key does not exist.	Upload the object first.
404 Not Found	NoSuchLifecycleConfiguration	The requested lifecycle rule does not exist.	Configure a lifecycle rule first.
404 Not Found	NoSuchUpload	The specified multipart upload does not exist. The upload ID does not exist or the multipart upload has been terminated or completed.	Use the existing part or reinitialize the part.
404 Not Found	NoSuchVersion	The specified version ID does not match any existing version.	Use a correct version ID.
404 Not Found	NoSuchWebsiteConfiguration	The requested website does not exist.	Configure the website first.
405 Method Not Allowed	MethodNotAllowed	The specified method is not allowed against the requested resource. The message "Specified method is not supported." is returned.	The method is not allowed.
408 Request Timeout	RequestTimeout	The socket connection to the server has no read or write operations within the timeout period.	Check the network and try again, or contact technical support.
409 Conflict	BucketAliasAlreadyExists	The requested file system alias already exists. The file system namespace is shared by all users.	Try again with another file system alias.
409 Conflict	BucketAliasInUse	The requested alias cannot be deleted because it has been bound to a file system.	Unbind the alias from the file system and then delete the alias.
409 Conflict	BucketAlreadyBindAlias	The requested file system has been bound to an alias. Each file system can be bound to only one file system alias.	Change the file system.
409 Conflict	BucketAlreadyExists	The requested file system name already exists. The file system namespace is shared by all users.	Try again with another file system name.
409 Conflict	BucketAlreadyOwnedByYou	Your previous request for creating the named file system succeeded and you already own it.	No further action is required.
409 Conflict	BucketNotEmpty	The file system you tried to delete is not empty.	Delete the objects in the file system and then delete the file system.
409 Conflict	InvalidBucketState	Invalid file system status. If cross-region replication is configured, file system versioning cannot be disabled.	Keep file system versioning enabled or cancel cross-region replication.
409 Conflict	OperationAborted	A conflicting operation is being performed on this resource. Retry later.	Try again later.
409 Conflict	ServiceNotSupported	The request method is not supported by the server.	Not supported by the server. Contact technical support.
411 Length Required	MissingContentLength	The HTTP header Content-Length is not provided.	Provide the Content-Length header.
412 Precondition Failed	PreconditionFailed	At least one of the specified preconditions is not met.	Modify according to the condition prompt in the returned message body.
416 Client Requested Range Not Satisfiable	InvalidRange	The requested range cannot be obtained.	Retry with the correct range.
500 Internal Server Error	InternalError	An internal error occurs. Retry later.	Contact technical support.
501 Not Implemented	ServiceNotImplemented	The request method is not implemented by the server.	Not supported currently. Contact technical support.
503 Service Unavailable	ServiceUnavailable	The server is overloaded or has internal errors.	Try later or contact technical support.
503 Service Unavailable	SlowDown	Too frequent requests.	Reduce your request frequency.

**Table 3** OEF error codes
Status Code	Error Code	Error Message	Solution
500 Internal Server Error	SYS.0001	Internal service error.	Contact technical support.
404 Not Found	SYS.0003	Unsupported API.	Use another API.
401 Unauthorized	SYS.0004	Unauthenticated request.	Contact technical support.
403 Forbidden	SYS.0005	No access permission.	Contact technical support.
400 Bad Request	SYS.0006	Incorrect request format.	Check the request format.
400 Bad Request	SYS.0007	Invalid request for range download.	Contact technical support.
500 Internal Server Error	SYS.0008	Token expired.	Use a valid token.
431 Request Header Fields Too Large	SYS.0009	The number of headers in the HTTP request exceeds the upper limit.	Reduce the number of headers in the HTTP request.
400 Bad Request	SYS.0010	Invalid request parameters.	Check the request parameters.
429 Too Many Requests	SYS.0011	The number of requests has exceeded the upper limit.	Reduce the number of requests.
400 Bad Request	SYS.0012	The request body is oversized.	Reduce the request body size.
403 Forbidden	SYS.0013	Token update is required due to permission changes.	Update the token.
404 Not Found	SYS.0014	The file system does not exist.	Try again with another file system name.
404 Not Found	SYS.0015	The object does not exist.	Try with another object name.
500 Internal Server Error	SYS.0016	OBS access error.	Contact technical support.
500 Internal Server Error	SYS.0018	Internal request error. Possible causes: incorrect request format or network disconnection.	Check the request format and network connectivity.
500 Internal Server Error	SYS.0019	Failed to access the file system policy.	Contact technical support.
500 Internal Server Error	SYS.0020	Failed to access the background task management service.	Contact technical support.
403 Forbidden	SYS.0021	Restricted account.	Top up your account.
403 Forbidden	SYS.0022	Account frozen.	Top up or register a new account.
400 Bad Request	SYS.0023	Incorrect region.	Try with another region name.
500 Internal Server Error	SYS.0024	Failed to access an authorized service.	Contact technical support.
500 Internal Server Error	SYS.0025	Incorrect response content.	Contact technical support.
500 Internal Server Error	SYS.0026	Incorrect read response content.	Contact technical support.
400 Bad Request	SYS.0027	The agency does not have any permissions.	Contact technical support.
400 Bad Request	SYS.0028	The agency does not exist.	Try with another agency.
400 Bad Request	SYS.0029	Invalid OBS region domain name.	Try with another OBS region domain name.
400 Bad Request	SYS.0030	OBS region domain name is not matched.	Try with another OBS region domain name.
500 Internal Server Error	SYS.0031	Failed to authorize OBS to automatically create an agency.	Contact technical support.
500 Internal Server Error	SYS.0032	Failed to authorize OBS to automatically modify an agency.	Contact technical support.
500 Internal Server Error	SYS.0033	Failed to grant OBS to automatically create custom permissions.	Contact technical support.
500 Internal Server Error	SYS.0034	Failed to grant OBS to automatically query custom permissions.	Contact technical support.
500 Internal Server Error	SYS.0035	Failed to grant OBS to automatically update custom permissions.	Contact technical support.
400 Bad Request	SYS.0036	Invalid project ID.	Try with another project ID.
400 Bad Request	SYS.0037	Insufficient permissions granted to the agency.	Contact technical support.
400 Bad Request	SYS.0038	Multi-range download is not supported.	Contact technical support.
500 Internal Server Error	SYS.0039	Invalid account ID.	Enter the correct tenant ID.
500 Internal Server Error	SYS.0040	An error occurred when initializing the SDK client.	Contact technical support.
400 Bad Request	SYS.0041	Failed to replace the magic parameter.	Contact technical support.
500 Internal Server Error	SYS.0042	Server processing times out.	Contact technical support.
500 Internal Server Error	SYS.0043	Failed to deserialize the JSON character string.	Contact technical support.
500 Internal Server Error	SYS.0044	An error occurred when obtaining the internal cache status.	Contact technical support.
404 Not Found	Fetch.0001	The task does not exist.	Try with another task ID.
500 Internal Server Error	Fetch.0003	Task persistence failed.	Contact technical support.
400 Bad Request	Fetch.0004	The to-be-downloaded object already exists in the file system.	Download another object or overwrite the existing one.
400 Bad Request	Fetch.0005	Failed to download the object from the source site.	Contact technical support.