The getObject method enables downloading objects from a specified bucket. Ensure that you have read access to this object before using this interface.

Precautions

Before downloading an object, you must have the tos:GetObject permission. For detailed instructions, see the Permission Configuration Guide.

For buckets with versioning enabled, you must have the tos:GetObjectVersion permission to download a specified version of an object. For detailed instructions, please refer to the Permissions Configuration Guide.

If an application downloads the same object in large quantities at the same time, your access speed will be limited by TOS bandwidth and geographic restrictions. It is recommended that you use CDN products to enhance performance while also reducing your costs. For detailed information on accessing TOS via CDN, see Using CDN to Accelerate Access to TOS Resources.

Sample Code

The following code is used to download objects from the bucket into memory.

import { TosClient, TosClientError, TosServerError } 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", ​
  endpoint: "Provide your endpoint", ​
});​
​
function handleError(error: 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() {​
  try {​
    const bucketName = 'harmony-sdk-test-bucket'; ​
    const objectName = 'example_dir/example.txt'; ​
    ​
    const res = await client.getObject({​
      Bucket: bucketName,​
      Key: objectName,​
    });​
​
    ​
    const str = buffer.from(res.Content.read(100)).toString()​
    res.Content.close();​
​
    console.log('object size:', str.length);​
  ​
    console.log('data string:', str);​
  } catch (error) {​
    handleError(error);​
  }​
}​
​
main();​

Last updated: 2025.09.26 19:05:16

Public security network record in Beijing: No. 11010802032137