PUT Bucket logging
API Description
You can use this API to set the access logging settings for a bucket.
Method Definition
ObsClient.setBucketLogging
Request Parameter
|
Field |
Type |
Optional or Mandatory |
Description |
|||
|---|---|---|---|---|---|---|
|
Bucket |
String |
Mandatory |
Bucket name |
|||
|
RequestDate |
String or Date |
Optional |
Request time
NOTE:
When the parameter type is String, the value must comply with the ISO8601 or RFC822 standards. |
|||
|
Agency |
String |
Mandatory when setting bucket logging |
Agency name |
|||
|
LoggingEnabled |
Object |
Optional |
Log configuration information |
|||
|
TargetBucket |
String |
Mandatory |
Target bucket for which logs are generated |
|||
|
TargetPrefix |
String |
Mandatory |
Name prefix of a to-be-logged object in the target bucket |
|||
|
TargetGrants |
Array |
Optional |
List of grantees' permission information |
|||
|
Grantee |
Object |
Optional |
Grantee |
|||
|
Type |
String |
Mandatory |
||||
|
ID |
String |
Mandatory when Type is CanonicalUser. In other cases, leave it null. |
ID of the domain to which the grantee belongs |
|||
|
URI |
String |
Mandatory when Type is Group. In other cases, leave it null. |
||||
|
Permission |
String |
Optional |
||||
Returned Result (InterfaceResult)
|
Field |
Type |
Description |
|---|---|---|
|
RequestId |
String |
Request ID returned by the OBS server |
Sample Code
obsClient.setBucketLogging ({
Bucket : 'bucketname',
LoggingEnabled:{
TargetBucket:'targetbucketname',
TargetPrefix:'prefix',
TargetGrants:[
{Grantee: {Type:'CanonicalUser',ID:'userid'},Permission: obsClient.enums.PermissionRead},
{Grantee: {Type:'Group',URI: obsClient.enums.GroupAllUsers},Permission: obsClient.enums.PermissionRead}
]
}
},function (err, result) {
if(err){
console.error('Error-->' + err);
}else{
if(result.CommonMsg.Status < 300){
console.log('RequestId-->' + result.InterfaceResult.RequestId);
}else{
console.log('Code-->' + result.CommonMsg.Code);
console.log('Message-->' + result.CommonMsg.Message);
}
}
});
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.