Help Center> Object Storage Service> SDK Reference> BrowserJS> Troubleshooting> SDK Common Result Objects
View PDF

SDK Common Result Objects

After you call an API in an instance of the ObsClient class, a common result object will be returned if the exception information parameter is null. The following table lists the object content:

Field

Type

Description

CommonMsg

Object

Common information generated after the API calling is complete, including HTTP status code and error code.
  

Status

Number

HTTP status code. If the value is smaller than 300, the operation succeeds. Otherwise, the operation fails.

Code

String

Error code on the OBS server. If Status is smaller than 300, the value is null.

Message

String

Error description on the OBS server. If Status is smaller than 300, the value is null.

HostId

String

Requested server ID. If Status is smaller than 300, the value is null.

RequestId

String

Request ID returned by the OBS server

Id2

String

Request ID2 returned by the OBS server

Indicator

String

Detailed error code returned by the OBS server. If Status is smaller than 300, the value is null.

InterfaceResult

Object

Result data generated after the operation is successful. If Status is greater than 300, the value is null.
  

RequestId

String

Request ID returned by the OBS server

Id2

String

Request ID2 returned by the OBS server

Other fields

For details, see the OBS BrowserJS SDK API Reference.

Sample code for processing public result objects:

// Create an instance of ObsClient.
var obsClient = new ObsClient({
    access_key_id: '*** Provide your Access Key ***',       
    secret_access_key: '*** Provide your Secret Key ***',       
    server : 'https://your-endpoint'
});

// Call APIs to perform related operations, for example, downloading an object.
obsClient.getObject({
       Bucket : 'bucketname',
       Key : 'objectname',
}, function (err, result) {
       if(!err){
              if(result.CommonMsg.Status < 300){
                     // Obtain the request ID.
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     // Obtain other parameters.
                     console.log('Content-->' + result.InterfaceResult.Content);
              }else{
                     // Obtain Code and Message.
                     console.log('Code-->' + result.CommonMsg.Code); 
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});
Parent topic: Troubleshooting