GET Bucket logging
API Description
You can use this API to obtain the access logging settings of a bucket.
Method Definition
ObsClient.getBucketLogging
Request Parameter
Field |
Type |
Optional or Mandatory |
Description |
---|---|---|---|
Bucket |
String |
Mandatory |
Bucket name |
Returned Result (InterfaceResult)
Field |
Type |
Description |
|||
---|---|---|---|---|---|
RequestId |
String |
Request ID returned by the OBS server |
|||
Agency |
String |
Agency name |
|||
LoggingEnabled |
Object |
Log configuration information |
|||
TargetBucket |
String |
Target bucket for which logs are generated |
|||
TargetPrefix |
String |
Name prefix of a to-be-logged object in the target bucket |
|||
TargetGrants |
Array |
List of grantees' permission information |
|||
Grantee |
Object |
Grantee |
|||
ID |
String |
ID of the domain to which the grantee belongs. This field is null when Type of Grantee is Group. |
|||
URI |
String |
Grantee group. This field is null when Type of Grantee is CanonicalUser. |
|||
Permission |
String |
Granted permission |
Sample Code
obsClient.getBucketLogging ({ Bucket : 'bucketname' },(err, result) => { if(err){ console.error('Error-->' + err); }else{ if(result.CommonMsg.Status < 300){ console.log('RequestId-->' + result.InterfaceResult.RequestId); if(result.InterfaceResult.LoggingEnabled){ console.log('TargetBucket-->' + result.InterfaceResult.LoggingEnabled.TargetBucket); console.log('TargetPrefix-->' + result.InterfaceResult.LoggingEnabled.TargetPrefix); for(let i=0;i<result.InterfaceResult.LoggingEnabled.TargetGrants.length;i++){ console.log('Grant[' + i + ']:'); console.log('Grantee[ID]-->' + result.InterfaceResult.LoggingEnabled.TargetGrants[i]['Grantee']['ID']); console.log('Grantee[URI]-->' + result.InterfaceResult.LoggingEnabled.TargetGrants[i]['Grantee']['URI']); console.log('Permission-->' + result.InterfaceResult.LoggingEnabled.TargetGrants[i]['Permission']); } } }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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot