Obtaining the Public Access Status of a Bucket Policy
Function
This API obtains the public access status of an OBS bucket policy.
Restrictions
- To obtain the public access status of a bucket policy, you must be the bucket owner or have the required permission (obs:bucket:GetBucketPolicyPublicStatus in IAM or GetBucketPolicyPublicStatus in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
- The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
Method
ObsClient.getBucketPolicyPublicStatus(params)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| Bucket | String | Yes | Explanation: Bucket name. Restrictions:
Default value: None |
Responses
| Parameter | Type | Description |
| Status | Number | Explanation: HTTP status code returned by the OBS server. Value range: A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For details, see Status Codes. |
| Code | String | Explanation: Error code returned by the OBS server. |
| Message | String | Explanation: Error description returned by the OBS server. |
| HostId | String | Explanation: Request server ID returned by the OBS server. |
| RequestId | String | Explanation: Request ID returned by the OBS server. |
| Id2 | String | Explanation: Request ID2 returned by the OBS server. |
| Indicator | String | Explanation: Error code details returned by the OBS server. |
| Parameter | Type | Description |
|---|---|---|
| IsPublic | String | Explanation: Whether the bucket policy is public. Restrictions: None Value range:
Default value: None |
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