获取桶日志分析配置-GetBucketRealTimeLog
功能介绍
开启了桶日志分析功能后,可以通过本接口查询当前桶的日志分析配置情况。了解功能详情可参见日志管理概述。
接口约束
- 单桶只能绑定一个日志组的一个日志流,OBS桶、日志组、日志流需要处于同一个区域(Region)。
- 桶创建者和日志流创建者必须归属于同一个账号。
- 不支持专属对象存储。
- 不支持OBS智能边缘小站。
授权信息
您必须是桶拥有者或拥有获取桶实时日志管理配置的权限,才能调用本接口,建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别。
- 如果使用IAM授权,那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种,并配置相应权限:
- 如果使用角色与策略授权(旧版IAM,即IAM v3接口),需具备obs:bucket:GetBucketRealTimeLog权限,授权操作请参见创建IAM自定义策略。
- 如果使用身份策略授权(新版IAM,即IAM v5接口),如下表所示,需具备obs:bucket:getBucketRealTimeLog权限,授权操作请参见创建IAM自定义身份策略。
授权项
Action
访问级别
Access Level
资源类型(*为必须)
Resource Type (*: required)
Condition Key
Alias
依赖的授权项
Dependencies
obs:bucket:getBucketRealTimeLog
Read
bucket *
-
-
-
- obs:EpochTime
- obs:SourceIp
- obs:TlsVersion
- obs:CustomDomain
- 如果使用桶策略进行授权,需具备obs:bucket:GetBucketRealTimeLog权限,具体操作请参见自定义创建桶策略。
URI
GET /?realtimeLog
请求消息样式
以下为请求消息样例,请将示例中的BucketName修改为您的桶名,RegionID修改为桶所在的区域ID,可参考支持区域获取区域ID。
1 2 3 4 | GET /?realtimeLog HTTP/1.1 Host: BucketName.obs.RegionID.myhuaweicloud.com Date: GMT Date Authorization: SignatureValue |
URI参数(URI Parameters)
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| realtimeLog | 是 | String | 参数解释: 用于标识API接口的作用与桶日志分析相关。 约束限制: 计算签名时,请在CanonicalizedResource中添加“/BucketName/?realtimeLog”,详情参见签名计算。 取值范围: realtimeLog 默认取值: 不涉及 |
请求头参数(Request headers)
该请求使用公共请求头,具体参见表3。
请求体参数(Request body)
该请求消息中不带请求体参数。
响应消息样式
1 2 3 4 5 6 7 8 9 10 11 | HTTP/1.1 status_code Content-Type: application/xml Date: date Content-Length: length <?xml version="1.0" encoding="UTF-8"?> <RealTimeLogConfiguration xmlns="http://obs.example.com/doc/2015-06-30/"> <LogGroupId>log-group-id</LogGroupId> <LogStreamId>log-stream-id</LogStreamId> <ProjectId>project-id</ProjectId> </RealTimeLogConfiguration> |
响应头 (Response Headers)
该请求的响应消息使用公共响应头,具体请参考表1。
响应体 (Response Body)
该请求的响应中以消息元素的形式返回桶的日志信息。
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| RealTimeLogConfiguration | Container | 参数解释: 日志分析信息的容器。 |
| ProjectId | String | 参数解释: 项目ID。父节点:RealTimeLogConfiguration 取值范围: 日志组和日志流归属的项目ID。 |
| LogGroupId | String | 参数解释: 日志组ID,用于指定日志推送的目标日志组。父节点:RealTimeLogConfiguration 取值范围: 桶绑定的日志组ID。 |
| LogStreamId | String | 参数解释: 日志流ID,用于指定日志推送的目标日志流。父节点:RealTimeLogConfiguration 取值范围: 桶绑定的日志流ID。 |
错误响应消息
详见NoSuchRealTimeLogConfiguration,其余错误包含在错误码概述中。
请求示例
1 2 3 4 5 6 | GET /?realtimeLog HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: Wed, 01 Jul 2015 02:42:46 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:hUk+jTnR07hcKwJh4ousF2E1U3E= |
响应示例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF260000016436B8EEE7FBA2AA3335E3 x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCShuQJoWFpS77C8bOv1mqURv0UY+0ejx Content-Type: application/xml Date: Wed, 01 Jul 2015 02:42:46 GMT Content-Length: 429 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <RealTimeLogConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <LogGroupId>4490333d-******</LogGroupId> <LogStreamId>05661fde-******</LogStreamId> <ProjectId>067cf8******</ProjectId> </RealTimeLogConfiguration> |