设置桶日志管理配置(node.js sdk)-九游平台

开发过程中,您有任何问题可以在github上,或者在中发帖求助。

如果桶的存储类别为低频访问存储或归档存储,则不能作为日志目标桶。
功能说明
调用设置桶日志管理配置接口,您可以为指定桶打开桶日志功能,并配置日志存放的目标桶。创建桶时,默认是不生成桶的日志的,调用node.js sdk的设置桶日志管理配置接口时,接口会自动为您打开桶日志配置。桶日志功能开启后,桶的每次操作将会产生一条日志,并将多条日志打包成一个日志文件。日志文件存放位置需要在开启桶日志功能时指定,可以存放到开启日志功能的桶中,也可以存放到其他您有权限的桶中,但需要和开启日志功能的桶在同一个region中。您还可以根据需要配置日志文件的访问权限,以及日志文件的文件名前缀。
接口约束
- 由于日志文件是obs产生,并且由obs上传到存放日志的桶中,因此obs需要获得委托授权,用于上传生成的日志文件,所以在配置桶日志管理前,需要先到统一身份认证服务生成一个对obs服务的委托,委托配置权限只需设置目标桶的上传对象权限。如何创建委托请参考创建云服务委托。
- 您必须是桶拥有者或拥有设置桶日志管理配置的权限,才能设置桶日志管理配置。建议使用iam或桶策略进行授权,如果使用iam则需授予obs:bucket:putbucketlogging权限,如果使用桶策略则需授予putbucketlogging权限。相关授权方式介绍可参见obs权限控制概述,配置方式详见、。
- obs支持的region与endpoint的对应关系,详细信息请参见。
- 日志目标桶与源桶必须在同一个区域(region)。
- 在配置桶日志管理前,需要先到生成一个对obs服务的委托,获取到委托名。请参考创建iam委托。
方法定义
obsclient.setbucketlogging(params)
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucket |
string |
必选 |
参数解释: 桶名。 约束限制:
取值范围: 长度为3~63个字符。 默认取值: 无 |
agency |
string |
作为请求参数时如果是设置桶日志配置则必选 |
参数解释: 目标桶(存放日志文件的桶)的所有者通过统一身份认证服务(iam)创建对obs云服务委托的名称。 约束限制: 默认情况下,在为委托配置权限时只需设置日志存储桶的上传对象(putobject)权限。如果日志存储桶开启了默认加密功能,还需要委托同时具有日志存储桶所在区域的kms administrator权限。 取值范围: 可以选择账号下已有的iam委托,也可以创建一个新的委托。创建委托参见创建iam委托。 默认取值: 无 |
loggingenabled |
设置logging时必选。 关闭logging时勿选。 |
参数解释: 日志配置信息。不配置时默认关闭桶日志。 约束限制: 无 取值范围: 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
targetbucket |
string |
设置logging时必选。 关闭logging时勿选。 |
参数解释: 日志存储桶的桶名,该桶用于存放日志文件。 约束限制:
取值范围: 长度为3~63个字符。 默认取值: 无 |
targetprefix |
string |
设置logging时必选。 关闭logging时勿选。 |
参数解释: 日志文件对象的对象名前缀,设置后日志文件对象将携带统一前缀存储在日志存储桶中。 约束限制: 无 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
targetgrants |
可选 |
参数解释: 被授权用户的权限信息列表,定义哪些用户可以针对日志文件进行哪些访问操作。 约束限制: 无 取值范围: 详见grant。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
grantee |
必选 |
参数解释: 被授权用户相关信息。 约束限制: 无 取值范围: 详见grantee。 默认取值: 无 |
|
permission |
必选 |
参数解释: 被授予的权限。 约束限制: 无 取值范围: 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
type |
作为请求参数时必选 |
参数解释: 被授权用户的类型。 约束限制: 无 取值范围: 被授权用户类型的取值范围详见granteetype。 默认取值: 无 |
|
id |
string |
作为请求参数时,如果type为用户类型则必选。 |
参数解释: 被授权用户的账号id,即domain_id。 约束限制: 无 取值范围: 如何获取账号id请参见获取账号id。 默认取值: 无 |
name |
string |
作为请求参数时可选 |
参数解释: 被授权用户的账号名。 约束限制:
取值范围: 无 默认取值: 无 |
uri |
作为请求参数时,如果type为用户组类型则必选。 |
参数解释: 被授权的用户组。 约束限制: 无 取值范围: 授权用户组取值范围详见groupuritype。 默认取值: 无 |
常量名 |
原始值 |
说明 |
---|---|---|
granteegroup |
group |
授权给用户组。 |
granteeuser |
canonicaluser |
授权给单个用户。 |
常量名 |
原始值 |
说明 |
---|---|---|
groupallusers |
allusers |
所有用户。 |
groupauthenticatedusers |
authenticatedusers |
授权用户,已废弃。 |
grouplogdelivery |
logdelivery |
日志投递组,已废弃。 |
常量名 |
原始值 |
说明 |
---|---|---|
obsclient.enums.permissionread |
read |
如果有桶的读权限,则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限,则可以获取该对象内容和元数据。 |
obsclient.enums.permissionwrite |
write |
如果有桶的写权限,则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 |
obsclient.enums.permissionreadacp |
read_acp |
如果有读acp的权限,则可以获取对应的桶或对象的权限控制列表(acl)。 桶或对象的所有者永远拥有读对应桶或对象acp的权限。 |
obsclient.enums.permissionwriteacp |
write_acp |
如果有写acp的权限,则可以更新对应桶或对象的权限控制列表(acl)。 桶或对象的所有者永远拥有写对应桶或对象的acp的权限。 拥有了写acp的权限,由于可以更改权限控制策略,实际上意味着拥有了完全访问的权限。 |
obsclient.enums.permissionfullcontrol |
full_control |
如果有桶的完全控制权限意味着拥有permissionread、permissionwrite、permissionreadacp和permissionwriteacp的权限。 如果有对象的完全控制权限意味着拥有permissionread、permissionreadacp和permissionwriteacp的权限。 |
返回结果
参数名称 |
参数类型 |
描述 |
---|---|---|
commonmsg |
参数解释: 接口调用完成后的公共信息,包含http状态码,操作失败的错误码等,详见icommonmsg。 |
|
interfaceresult |
参数解释: 操作成功后的结果数据,详见表11。 约束限制: 当status大于300时为空。 |
参数名称 |
参数类型 |
描述 |
status |
number |
参数解释: obs服务端返回的http状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见。 |
code |
string |
参数解释: obs服务端返回的错误码。 |
message |
string |
参数解释: obs服务端返回的错误描述。 |
hostid |
string |
参数解释: obs服务端返回的请求服务端id。 |
requestid |
string |
参数解释: obs服务端返回的请求id。 |
id2 |
string |
参数解释: obs服务端返回的请求id2。 |
indicator |
string |
参数解释: obs服务端返回的详细错误码。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
requestid |
string |
参数解释: obs服务端返回的请求id。 |
代码示例一:开启桶日志
本示例用于设置名为examplebucket桶的日志管理配置。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
// 引入obs库 // 使用npm安装 constobsclient=require("esdk-obs-nodejs"); // 使用源码安装 // var obsclient = require('./lib/obs'); // 创建obsclient实例 constobsclient=newobsclient({ // 推荐通过环境变量获取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, // 【可选】如果使用临时ak/sk和securitytoken访问obs,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥ak/sk,也可以使用其他外部引入方式传入 // security_token: process.env.security_token, // endpoint填写bucket对应的endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写 server:"https://obs.cn-north-4.myhuaweicloud.com", }); asyncfunctionsetbucketlogging(){ try{ constparams={ // 指定存储桶名称 bucket:"examplebucket", // 指定委托的名称,此处以 obs_test_agency 为例 agency:'obs_test_agency', loggingenabled:{ // 指定用于存放产生的日志文件的桶名,此处以 targetbucketname 为例 targetbucket:'targetbucketname', // 指定用于生成的日志文件的名称前缀,此处以 targetprefixtest/ 为例 targetprefix:'targetprefixtest/', // 指定被授权用户权限信息列表 targetgrants:[ // 指定特定用户拥有读的权限,此处用户id为0a03f5833900d3730f13c00f49d5exxx {grantee:{type:'canonicaluser',id:'0a03f5833900d3730f13c00f49d5exxx'},permission:obsclient.enums.permissionread} ] } }; // 设置桶的访问日志配置 constresult=awaitobsclient.setbucketlogging(params); if(result.commonmsg.status<=300){ console.log("set bucket(%s)'s logging configuration successful!",params.bucket); console.log("requestid: %s",result.commonmsg.requestid); return; }; console.log("an obserror was found, which means your request sent to obs was rejected with an error response."); console.log("status: %d",result.commonmsg.status); console.log("code: %s",result.commonmsg.code); console.log("message: %s",result.commonmsg.message); console.log("requestid: %s",result.commonmsg.requestid); }catch(error){ console.log("an exception was found, which means the client encountered an internal problem when attempting to communicate with obs, for example, the client was unable to access the network."); console.log(error); }; }; setbucketlogging(); |
代码示例二:关闭桶日志
本示例用于关闭名为examplebucket桶的日志管理配置。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
// 引入obs库 // 使用npm安装 constobsclient=require("esdk-obs-nodejs"); // 使用源码安装 // var obsclient = require('./lib/obs'); // 创建obsclient实例 constobsclient=newobsclient({ // 推荐通过环境变量获取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, // 【可选】如果使用临时ak/sk和securitytoken访问obs,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥ak/sk,也可以使用其他外部引入方式传入 // security_token: process.env.security_token, // endpoint填写bucket对应的endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写 server:"https://obs.cn-north-4.myhuaweicloud.com", }); asyncfunctionsetbucketlogging(){ try{ constparams={ // 指定存储桶名称 bucket:"examplebucket", // 清空日志配置 loggingenabled:{} }; // 删除桶的访问日志配置 constresult=awaitobsclient.setbucketlogging(params); if(result.commonmsg.status<=300){ console.log("delete bucket(%s)'s logging configuration successful!",params.bucket); console.log("requestid: %s",result.commonmsg.requestid); return; }; console.log("an obserror was found, which means your request sent to obs was rejected with an error response."); console.log("status: %d",result.commonmsg.status); console.log("code: %s",result.commonmsg.code); console.log("message: %s",result.commonmsg.message); console.log("requestid: %s",result.commonmsg.requestid); }catch(error){ console.log("an exception was found, which means the client encountered an internal problem when attempting to communicate with obs, for example, the client was unable to access the network."); console.log(error); }; }; setbucketlogging(); |
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨