本文介绍使用 TOS SDK 时的异常处理。

TOS 服务端错误 #

TOS 服务端遵循 HTTP 规范，对于请求失败的场景定义了详细的 HTTP 状态码和业务错误码。详细内容，请参见 TOS 服务端状态码和错误码定义。

SDK 自定义错误 #

客户端错误 - TosClientError #

TosClientError 是客户端输入参数有误、连接超时或客户端执行取消断点续传上传等特殊操作引起的。例如使用 createBucket 创建桶时，如果存储桶名称的字符长度大于 63 个字符则提示异常。

服务端错误 - TosServerError #

通过 TOS SDK 接口向 TOS 服务端发送请求，请求响应中会包含遵循 HTTP 规范的状态码和业务错误码，用于标识当前请求的响应状态。

错误处理示例 #

以下代码展示了下载一个不存在的对象时的异常处理。

import { TosClient } from '@volcengine/tos_harmonyos_sdk';

// 创建客户端
const client = new TosClient({
  accessKeyId: "Provide your ak", 
  accessKeySecret: "Provide your sk", 
  securityToken: 'Provide your securityToken',
  region: "Provide your region", // 填写 Bucket 所在地域。以华北2（北京)为例，"Provide your region" 填写为 cn-beijing。
  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 = 'harmony-sdk-test-bucket'; // 目标桶
  const objectName = 'object-not-exist'; // 不存在的对象

  try {
    await client.getObject({
      Bucket: bucketName,
      Key: objectName,
    });
  } catch (error) {
    handleError(error);
  }
}

main();