Help Center/ OBS BrowserJS SDK/ API Reference/ Bucket-Related APIs/ PUT Bucket policy
Updated on 2022-02-10 GMT+08:00
View PDF
Share

PUT Bucket policy

API Description

You can use this API to set a bucket policy. If the bucket already has a policy, the policy will be overwritten by the one specified in this request.

Method Definition

ObsClient.setBucketPolicy

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.

Policy

String

Mandatory

Policy information in JSON format. For details about the format, see Policy Format.

Returned Result (InterfaceResult)

Field

Type

Description

RequestId

String

Request ID returned by the OBS server

Sample Code

obsClient.setBucketPolicy ({
       Bucket : 'bucketname',
       Policy: 'your policy',
},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);
              }
       }
});

The bucket name contained in the Resource field in Policy must be the one specified for the bucket policy.

Parent topic: Bucket-Related APIs