对象存储服务 OBS-获取桶日志管理配置(Harmony SDK):返回结果
下载对象存储服务 OBS用户手册完整版
返回结果
|
参数类型 |
描述 |
|---|---|
|
说明：
该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 |
参数解释： 接口返回信息，详见Response。 |
|
参数名称 |
参数类型 |
描述 |
|---|---|---|
|
CommonMsg |
参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 |
|
|
InterfaceResult |
参数解释： 操作成功后的结果数据，详见GetBucketLoggingOutput。 约束限制： 当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委托。 约束限制： 默认情况下，在为委托配置权限时只需设置日志存储桶的上传对象（PutObject）权限。如果日志存储桶开启了默认加密功能，还需要委托同时具有日志存储桶所在区域的KMS Administrator权限。 默认取值： 无 |
|
LoggingEnabled |
参数解释： 日志配置信息。 约束限制： 无 取值范围： 默认取值： 无，指关闭桶日志。 |
|
参数名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
TargetBucket |
string |
设置logging时必选。 关闭logging时勿选。 |
参数解释： 日志存储桶的桶名，该桶用于存放日志文件。 约束限制：
默认取值： 无 |
|
TargetPrefix |
string |
设置logging时必选。 关闭logging时勿选。 |
参数解释： 日志文件对象的对象名前缀，设置后日志文件对象将携带统一前缀存储在日志存储桶中。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 |
|
TargetGrants |
可选 |
参数解释： 被授权用户的权限信息列表，定义哪些用户可以针对日志文件进行哪些访问操作，详见Grant。 |
|
参数名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
Grantee |
作为请求参数时必选 |
参数解释： 被授权用户相关信息，详见Grantee。 |
|
|
Permission |
作为请求参数时必选 |
参数解释： 被授予的权限。 取值范围： 权限取值范围：详见PermissionType。 默认取值： 无 |
|
参数名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
Type |
作为请求参数时必选 |
参数解释： 被授权用户的类型。 取值范围： 被授权用户类型的取值范围：详见GranteeType。 默认取值： 无 |
|
|
ID |
string |
作为请求参数时，如果Type为用户类型则必选。 |
参数解释： 被授权用户的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见获取账号ID。 默认取值： 无 |
|
Name |
string |
作为请求参数时可选 |
参数解释： 被授权用户的账号名。 约束限制：
默认取值： 无 |
|
URI |
作为请求参数时，如果Type为用户组类型则必选。 |
参数解释： 被授权的用户组。 取值范围： 授权用户组取值范围：详见GroupUriType。 默认取值： 无 |
|
常量名 |
原始值 |
说明 |
|---|---|---|
|
ALL_USERS |
AllUsers |
所有用户。 |
|
AUTHENTICATED_USERS |
AuthenticatedUsers |
授权用户，已废弃。 |
|
LOG _DELIVERY |
LogDelivery |
日志投递组，已废弃。 |
|
常量名 |
原始值 |
说明 |
|---|---|---|
|
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的权限。 |
