Help Center> OBS PHP SDK> API Reference> Bucket-Related APIs> PUT Bucket policy
Updated on 2023-11-09 GMT+08:00
View PDF

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

1. ObsClient->setBucketPolicy(array $parameter)
2. ObsClient->setBucketPolicyAsync(array $parameter, callable $callback)

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

string

Mandatory

Bucket name

Policy

string

Mandatory

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

Returned Result

Field

Type

Description

HttpStatusCode

integer

HTTP status code

Reason

string

Reason description

RequestId

string

Request ID returned by the OBS server

Sample Code

try{
       $resp = $obsClient -> setBucketPolicy([
              'Bucket' => 'bucketname',
              'Policy' => 'your policy'
       ]);
       printf("RequestId:%s\n", $resp['RequestId']);
}catch (Obs\Common\ObsException $obsException){
       printf("ExceptionCode:%s\n", $obsException->getExceptionCode());
       printf("ExceptionMessage:%s\n", $obsException->getExceptionMessage());
}

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

Parent topic: Bucket-Related APIs