Querying the Instance-Level/Project-Level Permission Matrix of an Application
Function
This API is used to query the instance-level or project-level permission matrix of an application. If app_id is transferred, the instance-level permission matrix is queried. If project_id is transferred while app_id is not transferred, the project-level permission matrix is queried.
Calling Method
For details, see Calling APIs.
URI
GET /v3/applications/permissions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
app_id |
No |
String |
Application ID |
project_id |
No |
String |
Project ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
Array of ApplicationPermissionVO objects |
Role application permission |
status |
String |
Request success or failure status |
Parameter |
Type |
Description |
---|---|---|
can_modify |
Boolean |
Whether you have the edit permission |
can_delete |
Boolean |
Whether you have the delete permission |
can_view |
Boolean |
Whether you have the view permission |
can_execute |
Boolean |
Whether you have the execute permission |
can_copy |
Boolean |
Whether you have the clone permission |
can_manage |
Boolean |
Whether you have the manage permission, including adding, deleting, modifying, querying, executing, and modifying permissions. |
can_create_env |
Boolean |
Whether you have the permission to create environments |
can_disable |
Boolean |
Whether you have the disable permission |
name |
String |
Role name |
region |
String |
Region information |
role_id |
String |
Role ID |
role_type |
String |
Role type. app-creator: Application creator. project: Project administrator. template-customized-inst: System roles. template-project-customized and project-customized: Custom roles. |
Example Requests
-
This API is used to query the project-level permission matrix of an application.
https://{endpoint}/v3/applications/permissions?project_id=0a38ce9ba3c740c199a0f872b6163661
-
This API is used to query the instance-level permission matrix of an application.
https://{endpoint}/v3/applications/permissions?app_id=0a38ce9ba3c740c199a0f872b6163661
Example Responses
Status code: 200
OK: The request is successful.
{ "result" : [ { "can_copy" : true, "can_create_env" : true, "can_delete" : true, "can_disable" : true, "can_execute" : true, "can_manage" : true, "can_modify" : true, "can_view" : true, "name" : "App creator", "region" : "cn-north-7", "role_id" : "0", "role_type" : "app-creator" }, { "can_copy" : true, "can_create_env" : true, "can_delete" : true, "can_disable" : true, "can_execute" : true, "can_manage" : true, "can_modify" : true, "can_view" : true, "name" : "Project Admin", "region" : "cn-north-7", "role_id" : "2e510051361942a8b7ecea00144172b3", "role_type" : "project" } ], "status" : "success" }
SDK Sample Code
The SDK sample code is as follows.
Java
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 |
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.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; public class ListApplicationPermissionsSolution { 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); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>")) .build(); ListApplicationPermissionsRequest request = new ListApplicationPermissionsRequest(); try { ListApplicationPermissionsResponse response = client.listApplicationPermissions(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()); } } } |
Python
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.v2 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 = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListApplicationPermissionsRequest() response = client.list_application_permissions(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/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 := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListApplicationPermissionsRequest{} response, err := client.ListApplicationPermissions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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: The request is successful. |
Error Codes
See Error Codes.
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