# 设置桶日志管理配置(HarmonyOS SDK) #### 功能说明 调用设置桶日志管理配置接口，您可以为指定桶打开桶日志功能，并配置日志存放的目标桶。创建桶时，默认是不生成桶的日志的，调用HarmonyOS SDK的设置桶日志管理配置接口时，接口会自动为您打开桶日志配置。桶日志功能开启后，桶的每次操作将会产生一条日志，并将多条日志打包成一个日志文件。日志文件存放位置需要在开启桶日志功能时指定，可以存放到开启日志功能的桶中，也可以存放到其他您有权限的桶中，但需要和开启日志功能的桶在同一个region中。您还可以根据需要配置日志文件的访问权限，以及日志文件的文件名前缀。 #### 接口约束 - 由于日志文件是OBS产生，并且由OBS上传到存放日志的桶中，因此OBS需要获得委托授权，用于上传生成的日志文件，所以在配置桶日志管理前，需要先到统一身份认证服务生成一个对OBS服务的委托，委托配置权限只需设置目标桶的上传对象权限。如何创建委托请参考[创建云服务委托](https://support.huaweicloud.com/usermanual-iam/iam_06_0004.html)。 - 您必须是桶拥有者或拥有设置桶日志管理配置的权限，才能设置桶日志管理配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketLogging权限，如果使用桶策略则需授予PutBucketLogging权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ``` setBucketLogging(input: SetBucketLoggingInput): Response ``` #### 请求参数 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | [SetBucketLoggingInput] | 必选 | **参数解释：** 设置桶的日志管理配置接口入参，详见[SetBucketCustomDomainInput]。 | 表2SetBucketLoggingInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值**： 无 | | Agency | string | 作为请求参数时如果是设置桶日志配置则必选 | **参数解释：** 目标桶（存放日志文件的桶）的所有者通过统一身份认证服务（IAM）创建对OBS云服务委托的名称。 可以选择账号下已有的IAM委托，也可以创建一个新的委托。创建委托参见[创建IAM委托](https://support.huaweicloud.com/usermanual-obs/obs_03_0329.html)。 **约束限制：** 默认情况下，在为委托配置权限时只需设置日志存储桶的上传对象（PutObject）权限。如果日志存储桶开启了默认加密功能，还需要委托同时具有日志存储桶所在区域的KMS Administrator权限。 **默认取值：** 无 | | LoggingEnabled | [LoggingEnabled] | 可选 | **参数解释：** 日志配置信息，详见[LoggingEnabled]。 | 表3LoggingEnabled | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | TargetBucket | string | 设置logging时必选。 关闭logging时勿选。 | **参数解释：** 日志存储桶的桶名，该桶用于存放日志文件。 **约束限制：** - 需要和开启日志功能的桶在同一个region中。 - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | TargetPrefix | string | 设置logging时必选。 关闭logging时勿选。 | **参数解释：** 日志文件对象的对象名前缀，设置后日志文件对象将携带统一前缀存储在日志存储桶中。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | TargetGrants | [Grant] | 可选 | **参数解释：** 被授权用户的权限信息列表，定义哪些用户可以针对日志文件进行哪些访问操作，详见[Grant]。 | 表4Grant | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Grantee | [Grantee] | 作为请求参数时必选 | **参数解释：** 被授权用户相关信息，详见[Grantee]。 | | Permission | [PermissionType] | 作为请求参数时必选 | **参数解释：** 被授予的权限。 **取值范围：** 权限取值范围：详见[PermissionType]。 **默认取值：** 无 | 表5Grantee | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Type | [GranteeType] | 作为请求参数时必选 | **参数解释：** 被授权用户的类型。 **取值范围：** 被授权用户类型的取值范围：详见[GranteeType]。 **默认取值：** 无 | | ID | string | 作为请求参数时，如果Type为用户类型则必选。 | **参数解释：** 被授权用户的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[获取账号ID](https://support.huaweicloud.com/api-obs/obs_04_0117.html)。 **默认取值：** 无 | | Name | string | 作为请求参数时可选 | **参数解释：** 被授权用户的账号名。 **约束限制：** - 不支持中文。 - 只能以字母开头。 - 长度为6-32个字符。 - 只能包含英文字母、数字或特殊字符(-_)。 **默认取值：** 无 | | URI | [GroupUriType] | 作为请求参数时，如果Type为用户组类型则必选。 | **参数解释：** 被授权的用户组。 **取值范围：** 授权用户组取值范围：详见[GroupUriType]。 **默认取值：** 无 | 表6GranteeType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | GROUP | Group | 授权给用户组。 | | CANONICAL_USER | CanonicalUser | 授权给单个用户。 | 表7GroupUriType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ALL_USERS | AllUsers | 所有用户。 | | AUTHENTICATED_USERS | AuthenticatedUsers | 授权用户，已废弃。 | | LOG_DELIVERY | LogDelivery | 日志投递组，已废弃。 | 表8PermissionType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | READ | READ | 如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限，则可以获取该对象内容和元数据。 | | WRITE | WRITE | 如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 | | READ_ACP | READ_ACP | 如果有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 | | WRITE_ACP | WRITE_ACP | 如果有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。 | | FULL_CONTROL | FULL_CONTROL | 如果有桶的完全控制权限意味着拥有PermissionRead、PermissionWrite、PermissionReadAcp和PermissionWriteAcp的权限。 如果有对象的完全控制权限意味着拥有PermissionRead、PermissionReadAcp和PermissionWriteAcp的权限。 | #### 返回结果 表9返回结果 | **参数类型** | **描述** | |:---|:---| | [Response] 说明： 该接口返回一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[Response]。 | 表10Response | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [BaseResponseOutput] | **参数解释：** 操作成功后的结果数据，详见[BaseResponseOutput]。 **约束限制：** 当Status大于300时为空。 | 表11ICommonMsg | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表12BaseResponseOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | #### 代码示例 本示例用于设置名为examplebucket桶的日志管理配置。 ``` // 引入依赖包 import ObsClient, { GranteeType, PermissionType, SetBucketLoggingInput, GroupUriType} from '@obs/esdk-obs-harmony'; import { process } from '@kit.ArkTS'; import { BusinessError } from '@kit.BasicServicesKit'; import { hilog } from '@kit.PerformanceAnalysisKit'; const processManager = new process.ProcessManager(); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html AccessKeyId: processManager.getEnvironmentVar("ACCESS_KEY_ID"), SecretAccessKey: processManager.getEnvironmentVar("SECRET_ACCESS_KEY"), // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入 // SecurityToken: processManager.getEnvironmentVar("SECURITY_TOKEN"), // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function setBucketLogging() { try { const params: SetBucketLoggingInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定委托的名称，此处以 obs_test_agency 为例 Agency: 'obs_test_agency', LoggingEnabled: { // 指定用于存放产生的日志文件的桶名，此处以 TargetBucketname 为例 TargetBucket: 'TargetBucketname', // 指定用于生成的日志文件的名称前缀，此处以 TargetPrefixtest/ 为例 TargetPrefix: 'TargetPrefixtest/', // 指定被授权用户权限信息列表 TargetGrants: [ // 指定特定用户拥有公共写的权限，此处用户ID为0a03f5833900d3730f13c00f49d5exxx { Grantee: { Type: GranteeType.CANONICAL_USER, ID: '0a03f5833900d3730f13c00f49d5exxx' }, Permission: PermissionType.WRITE }, // 指定所有用户拥有公共读的权限 { Grantee: { Type: GranteeType.GROUP, URI: GroupUriType.ALL_USERS }, Permission: PermissionType.READ } ] } }; // 设置桶的访问日志配置 const result = await obsClient.setBucketLogging(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "Set bucket(%s)'s logging configuration successful!", params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); return; } hilog.error(0x0001, 'OBS-Harmony', "An ObsError was found, which means your request sent to OBS was rejected with an error response."); hilog.error(0x0001, 'OBS-Harmony', "Status: %d", result.CommonMsg.Status); hilog.error(0x0001, 'OBS-Harmony', "Code: %s", result.CommonMsg.Code); hilog.error(0x0001, 'OBS-Harmony', "Message: %s", result.CommonMsg.Message); hilog.error(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); } catch (error) { hilog.info(0x0001, 'OBS-Harmony', "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."); hilog.info(0x0001, 'OBS-Harmony', error); } } setBucketLogging(); ``` #### 相关链接 - 关于设置桶日志管理配置的API说明，请参见[设置桶日志管理配置](https://support.huaweicloud.com/api-obs/obs_04_0032.html)。 - 设置桶日志管理配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。