OBS客户端通用示例
开发过程中,您有任何问题可以在github上提交issue,或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。
回调函数返回结果:
OBS客户端可通过回调函数的形式返回结果,回调函数依次包含异常信息和SDK公共结果对象两个参数。如果回调函数中异常信息参数不为空,则表明接口调用异常;反之,则表明接口调用完成,此时应从SDK公共结果对象中获取HTTP状态码,判断操作是否成功。示例代码如下:
// 引入obs库 // 使用npm安装 var ObsClient = require('esdk-obs-nodejs'); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 var obsClient = new ObsClient({ //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html access_key_id: process.env.ACCESS_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, server : 'https://your-endpoint' }); // 构造桶操作请求参数 var requestParam1 = { Bucket : 'bucketname' // 其他字段 }; var callback1 = (err, result) => { // 处理桶操作调用结果 }; // 调用桶操作接口,如创建桶 obsClient.createBucket(requestParam1, callback1); //构造对象操作请求参数 var requestParam2 = { Bucket : 'bucketname', Key : 'objectname' // 其他字段 }; var callback2 = (err, result) => { // 处理对象操作调用结果 }; // 调用对象操作接口,如下载对象 obsClient.getObject(requestParam2, callback2);
对于桶操作接口,请求对象中固定包含Bucket字段用于指定桶名;对于对象操作接口,请求对象中固定包含Bucket字段和Key字段分别用于指定桶名与对象名。
以下代码展示了使用回调函数返回调用结果的通用示例:
// 引入obs库 // 使用npm安装 var ObsClient = require('esdk-obs-nodejs'); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 var obsClient = new ObsClient({ //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html access_key_id: process.env.ACCESS_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, server : 'https://your-endpoint' }); // 调用接口进行操作,例如上传对象 obsClient.putObject({ Bucket : 'bucketname', Key : 'objectname', Body : 'Hello OBS' }, (err, result) => { // 异常信息不为空,表明接口调用异常 if(err){ console.log('Error-->' + err); }else{ // 异常信息为空,表明接口调用完成,应进一步判断HTTP状态码 if(result.CommonMsg.Status < 300){// 操作成功 if(result.InterfaceResult){ // 处理操作成功后业务逻辑 } }else{// 操作失败,获取详细异常信息 console.log('Code-->' + result.CommonMsg.Code); console.log('Message-->' + result.CommonMsg.Message); console.log('HostId-->' + result.CommonMsg.HostId); console.log('RequestId-->' + result.CommonMsg.RequestId); } } });
Promise对象返回结果:
OBS客户端可通过Promise对象返回结果,如果通过Promise对象的catch方法没有捕获到异常,则表明接口调用完成,此时应从SDK公共结果对象中获取HTTP状态码,判断操作是否成功。示例代码如下:
// 引入obs库 // 使用npm安装 var ObsClient = require('esdk-obs-nodejs'); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 var obsClient = new ObsClient({ //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html access_key_id: process.env.ACCESS_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, server : 'https://your-endpoint' }); // 构造桶操作请求参数 var requestParam1 = { Bucket : 'bucketname' // 其他字段 }; // 调用桶操作接口,如创建桶 var promise1 = obsClient.createBucket(requestParam1); promise1.then((result) => { // 处理桶操作调用结果 }).catch((err)=>{ // 处理错误 }); //构造对象操作请求参数 var requestParam2 = { Bucket : 'bucketname', Key : 'objectname' // 其他字段 }; // 调用对象操作接口,如下载对象 var promise2 = obsClient.getObject(requestParam2); promise2.then((result) => { // 处理对象操作调用结果 }).catch((err)=>{ // 处理错误 });
对于桶操作接口,请求对象中固定包含Bucket字段用于指定桶名;对于对象操作接口,请求对象中固定包含Bucket字段和Key字段分别用于指定桶名与对象名。
以下代码展示了使用Promise对象返回调用结果的通用示例:
// 引入obs库 // 使用npm安装 var ObsClient = require('esdk-obs-nodejs'); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 var obsClient = new ObsClient({ //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html access_key_id: process.env.ACCESS_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, server : 'https://your-endpoint' }); // 调用接口进行操作,例如上传对象 obsClient.putObject({ Bucket : 'bucketname', Key : 'objectname', Body : 'Hello OBS' }).then((result) => { // 接口调用完成,应进一步判断HTTP状态码 if(result.CommonMsg.Status < 300){// 操作成功 if(result.InterfaceResult){ // 处理操作成功后业务逻辑 } }else{// 操作失败,获取详细异常信息 console.log('Code-->' + result.CommonMsg.Code); console.log('Message-->' + result.CommonMsg.Message); console.log('HostId-->' + result.CommonMsg.HostId); console.log('RequestId-->' + result.CommonMsg.RequestId); } }).catch((err) => { // 接口调用发生异常 console.error('Error-->' + err); });