Updated on 2026-01-16 GMT+08:00

Obtaining Customized Metadata

The customized metadata of an object will be returned after the object is successfully downloaded.

This example downloads object objectname from bucketname and returns the custom metadata of the object.

The example code is as follows:

// Create an instance of ObsClient.
var obsClient = new ObsClient({
    // Hard-coded or plaintext AK/SK are risky. For security purposes, encrypt your AK/SK and store them in the configuration file or environment variables. In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, configure environment variables AccessKeyID and SecretAccessKey.
    // The front-end code does not have the process environment variable, so you need to use a module bundler like webpack to define the process variable.
    // Obtain an AK/SK pair on the management console.
    access_key_id: process.env.AccessKeyID,
    secret_access_key: process.env.SecretAccessKey,
    server: 'https://your-endpoint'
});

// Download the object and obtain the customized metadata.
obsClient.getObject({
       Bucket : 'bucketname',
       Key : 'objectname',
}, function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
              if(result.CommonMsg.Status < 300 && result.InterfaceResult){
                  console.log('Metadata-->' + JSON.stringify(result.InterfaceResult.Metadata['property']));
              }
       }
});
  • To obtain the customized metadata of an object, you need to add the additional headers that are allowed to be carried in responses to the CORS configurations. For example, you can add x-obs-meta-property to enable the query of property.