Querying Access Permission Policies of a Storage Directory

Function

Queries access permission policies of a storage directory.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

workspace:storagePolicy:list

List

storage *

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:storagePolicy:list	List	storage *	-	-	-

URI

GET /v1/{project_id}/storages-policy/actions/list-statements

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Query offset.
limit	No	Integer	Size of a single query. The value ranges from 1 to 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number.
items	Array of PolicyStatement objects	Supported access policies.

**Table 5** PolicyStatement
Parameter	Type	Description
policy_statement_id	String	The following access policies are supported: DEFAULT_1: client access storage (upload and download); cloud access storage (read and write) action: PutObject, DeleteObject, and GetObject roam_action: PutObject, DeleteObject, and GetObject action: GetObject roam_action: PutObject, DeleteObject, and GetObject action: PutObject and DeleteObject roam_action: PutObject, DeleteObject, and GetObject action: roam_action: GetObject DEFAULT_2: client access storage (download); cloud access storage (read and write) DEFAULT_3: client access storage (upload); cloud access storage (read and write) DEFAULT_4: client access storage (only the list can be viewed, and upload and download are not allowed); cloud access storage (read only)
actions	Array of strings	All operation permissions on the client storage. PutObject: upload, modify, rename, and move GetObject: download DeleteObject: delete
roam_actions	Array of strings	All operation permissions on the cloud storage PutObject: upload, modify, rename, and move GetObject: download DeleteObject: delete

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Example Requests

GET /v1/a4da8115c9d8464ead3a38309130523f/storages-policy/actions/list-statements?offset=0&limit=100

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 4,
  "items" : [ {
    "policy_statement_id" : "DEFAULT_4",
    "actions" : null,
    "roam_actions" : [ "GetObject" ]
  }, {
    "policy_statement_id" : "DEFAULT_3",
    "actions" : [ "PutObject", "DeleteObject" ],
    "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ]
  }, {
    "policy_statement_id" : "DEFAULT_2",
    "actions" : [ "GetObject" ],
    "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ]
  }, {
    "policy_statement_id" : "DEFAULT_1",
    "actions" : [ "PutObject", "DeleteObject", "GetObject" ],
    "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ]
  } ]
}

Status Codes

Status Code	Description
200	Response to a successful request.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	Permissions required.
404	No resources found.
405	The request method is not allowed.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.

Error Codes

See Error Codes.

Parent topic: Storage management

Previous topic: Querying Personal Storage Directories

Next topic: Adding or Updating a Custom Policy for Storage Directory Access Permissions

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot