The TOS server adheres to HTTP specifications and defines detailed HTTP status codes and business error codes for scenarios involving request failures. For detailed information, please refer to TOS Server-Side Status Codes and Error Codes Definition.

SDK Custom Errors

Client Error – TosClientError

TosClientError is caused by incorrect client input parameters, connection timeouts, or the execution of special operations by the client, such as canceling a breakpoint resume upload. For example, when using createBucket to create a bucket, an exception is raised if the bucket name exceeds 63 characters in length.

Server-side Error - TosServerError

Requests are sent to the TOS server via the TOS SDK interface. The response includes status codes that comply with HTTP standards and business error codes, which indicate the response status of the current request.

Error Handling Examples

The following code demonstrates exception handling when attempting to download a non-existent object.

import { TosClient } from '@volcengine/tos-sdk';​
​
const client = new TosClient({​
  accessKeyId: process.env['TOS_ACCESS_KEY'], ​
  accessKeySecret: process.env['TOS_SECRET_KEY'], ​
  region: "Provide your region", ​
  endpoint: "Provide your endpoint", ​
});​
​
function handleError(error) {​
  if (error instanceof TosClientError) {​
    console.log('Client Err Msg:', error.message);​
    console.log('Client Err Stack:', error.stack);​
  } else if (error instanceof TosServerError) {​
    console.log('Request ID:', error.requestId);​
    console.log('Response Status Code:', error.statusCode);​
    console.log('Response Header:', error.headers);​
    console.log('Response Err Code:', error.code);​
    console.log('Response Err Msg:', error.message);​
  } else {​
    console.log('unexpected exception, message: ', error);​
  }​
}​
​
async function main() {​
  const bucketName = 'node-sdk-test-bucket'; ​
  const objectName = 'object-not-exist'; ​
​
  try {​
    await client.getObjectV2({​
      bucket: bucketName,​
      key: objectName,​
    });​
  } catch (error) {​
    handleError(error);​
  }​
}​
​
main();​

Last updated: 2025.09.22 18:35:44

Public security network record in Beijing: No. 11010802032137