Updated on 2025-08-21 GMT+08:00

Querying File Permissions

Function

This API is used to query file permissions.

Calling Method

For details, see Calling APIs.

URI

GET /v2/keystore/permission/{keystore_id}/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

keystore_id

Yes

String

Definition

Keystore ID for the file.

Constraints

N/A.

Range

A UUID. Use a 32-character string containing a mix of digits and letters.

Default Value

N/A.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

page_size

Yes

Integer

Details:

Number of records displayed on each page.

Constraints:

N/A

Value Range:

Only numbers that are 100 or less can be used.

page

Yes

String

Definition

page indicates the index of the page to start the query from. The value is no less than 1.

Constraints

The value is a positive integer.

Range

The value of page is at least 1.

Default Value

1

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. For details, see Obtaining an IAM User Token.

Constraints

Global tenant tokens are not supported. Use a region-level token whose scope is project.

Range

N/A.

Default Value

N/A.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition

API response status.

Range

success: The API call is successful.

fail: The API call failed.

error

String

Definition

Error message.

Range

N/A.

result

result object

Definition

Data returned after the API is successfully called.

Range

N/A.

Table 5 result

Parameter

Type

Description

total

Integer

Definition

Total number.

Range

1-2147483647

permission_list

Array of AddKeystorePermissionResponseBody objects

Definition

A list of permissions.

Range

N/A.

Table 6 AddKeystorePermissionResponseBody

Parameter

Type

Description

id

String

Definition

Permission ID.

Range

N/A.

setting

Boolean

Definition

Permission to edit.

Range

true: Can edit.

false: Cannot edit.

delete

Boolean

Definition

Whether granted the delete permission.

Range

true: Granted the delete permission.

false: Not granted the delete permission.

keystore_id

String

Definition

File keystore ID.

Range

N/A.

modify

Boolean

Definition

Whether granted the modification permission.

Range

true: Granted the modification permission.

false: Not granted the modification permission.

usage

Boolean

Definition

Whether granted the use permission.

Range

true: Granted the use permission.

false: Not granted the use permission.

user_name

String

Definition

Username.

Range

N/A.

is_creator

Boolean

Definition

Creator or not.

Range

true: Creator.

false: Not a creator.

can_absent

Boolean

Definition

Optional or not.

Range

true: Optional.

false: Mandatory.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v2/keystore/permission/b916d73b5ba8483983230365e6d0e2bd/query

Example Responses

Status code: 200

OK

{
  "result" : {
    "total" : 2,
    "permission_list" : [ {
      "id" : "2b0d4c2a799011efb818fa163ed0d7fd",
      "setting" : true,
      "delete" : true,
      "modify" : true,
      "usage" : true,
      "keystore_id" : "787dd84682aa4e78947af56277422259",
      "user_name" : "testUser",
      "is_creator" : true,
      "can_absent" : false
    }, {
      "id" : "7eee02907a1d11efb818fa163ed0d7fd",
      "setting" : false,
      "delete" : true,
      "modify" : false,
      "usage" : false,
      "keystore_id" : "787dd84682aa4e78947af56277422259",
      "user_name" : "chengziyan",
      "is_creator" : false,
      "can_absent" : true
    } ]
  },
  "error" : null,
  "status" : "success"
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartsbuild.v3.region.CodeArtsBuildRegion;
import com.huaweicloud.sdk.codeartsbuild.v3.*;
import com.huaweicloud.sdk.codeartsbuild.v3.model.*;


public class ShowKeystorePermissionSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowKeystorePermissionRequest request = new ShowKeystorePermissionRequest();
        request.withKeystoreId("{keystore_id}");
        try {
            ShowKeystorePermissionResponse response = client.showKeystorePermission(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsbuild.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsBuildClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowKeystorePermissionRequest()
        request.keystore_id = "{keystore_id}"
        response = client.show_keystore_permission(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartsbuild.NewCodeArtsBuildClient(
        codeartsbuild.CodeArtsBuildClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowKeystorePermissionRequest{}
	request.KeystoreId = "{keystore_id}"
	response, err := client.ShowKeystorePermission(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.