Help Center/ Scalable File Service/ API Reference/ Appendix/ General Purpose File System Error Codes

Updated on 2024-11-13 GMT+08:00

View PDF

General Purpose File System 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 shows the General Purpose File System error codes.

**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	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	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	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	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	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	KeyTooLongError	The provided key is too long.	Use a shorter key.
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	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	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	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	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	DeregisterUserId	The user has been deregistered.	Top up or register a new account.
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	InvalidAccessKeyId	The access key ID provided by the customer does not exist in the system.	Provide correct access key Id.
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	NoSuchLifecycleConfiguration	The requested lifecycle rule does not exist.	Configure a lifecycle rule 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	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	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.
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.