获取桶日志管理配置(Node.js SDK)
开发过程中,您有任何问题可以在github上提交issue。
功能介绍
调用获取桶日志管理配置,可获取指定桶的日志配置。
接口约束
- 您必须是桶拥有者或拥有获取桶日志管理配置的权限,才能获取桶日志管理配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketLogging权限,如果使用桶策略则需授予GetBucketLogging权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.getBucketLogging(params)
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Bucket |
string |
必选 |
参数解释: 桶名。 约束限制:
取值范围: 长度为3~63个字符。 默认取值: 无 |
返回结果
参数名称 |
参数类型 |
描述 |
---|---|---|
CommonMsg |
参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg。 |
|
InterfaceResult |
参数解释: 操作成功后的结果数据,详见表5。 约束限制: 当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。 |
Agency |
string |
参数解释: 目标桶(存放日志文件的桶)的所有者通过统一身份认证服务(IAM)创建对OBS云服务委托的名称。 可以选择账号下已有的IAM委托,也可以创建一个新的委托。创建委托参见创建IAM委托。 |
LoggingEnabled |
参数解释: 日志配置信息。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
TargetBucket |
string |
参数解释: 日志存储桶的桶名,该桶用于存放日志文件。 |
TargetPrefix |
string |
参数解释: 日志文件对象的对象名前缀,设置后日志文件对象将携带统一前缀存储在日志存储桶中。 |
TargetGrants |
参数解释: 被授权用户的权限信息列表,定义哪些用户可以针对日志文件进行哪些访问操作,详见Grant。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Grantee |
作为请求参数时必选 |
参数解释: 被授权用户相关信息,详见Grantee。 |
|
Permission |
作为请求参数时必选 |
参数解释: 被授予的权限,详见PermissionType。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Type |
作为请求参数时必选 |
参数解释: 被授权用户的类型,详见GranteeType。 |
|
ID |
string |
作为请求参数时,如果Type为用户类型则必选。 |
参数解释: 被授权用户的账号ID,即domain_id。 |
Name |
string |
作为请求参数时可选 |
参数解释: 被授权用户的账号名。 |
URI |
作为请求参数时,如果Type为用户组类型则必选。 |
参数解释: 被授权的用户组,详见GroupUriType。 |
常量名 |
原始值 |
说明 |
---|---|---|
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的权限。 |
代码示例
您可以通过ObsClient.getBucketLogging获取桶日志配置。以下代码展示了如何获取名为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 |
// 引入obs库 // 使用npm安装 const ObsClient = require("esdk-obs-nodejs"); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/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.ap-southeast-1.myhuaweicloud.com" }); async function getBucketLogging() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket", }; // 设置桶的访问日志配置 const result = await obsClient.getBucketLogging(params); if (result.CommonMsg.Status <= 300) { console.log("Get bucket(%s)'s logging configuraion successful!", params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); if (result.InterfaceResult.LoggingEnabled) { console.log('TargetBucket: %s', result.InterfaceResult.LoggingEnabled.TargetBucket); console.log('TargetPrefix: %s', result.InterfaceResult.LoggingEnabled.TargetPrefix); for (let i = 0; i < result.InterfaceResult.LoggingEnabled.TargetGrants.length; i++) { const grant = result.InterfaceResult.LoggingEnabled.TargetGrants[0]; console.log('Grant[%d]-Type:%s, ID:%s, URI:%s, Permission:%s', i, grant.Grantee.Type, grant.Grantee.ID, grant.Grantee.URI, grant.Permission ); }; }; 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); }; }; getBucketLogging(); |