Obtaining the Account Permissions of a Multi-cloud Cluster

Function

This API is used to obtain account permissions for a multi-cloud cluster.

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, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/container/kubernetes/multi-cloud/clusters/{cluster_id}/permissions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. Constraints N/A Range Length: 1 to 64 characters Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number of accounts Range 0-100
data_list	Array of MultiCloudClusterAuthInfo objects	Definition Multi-cloud cluster account permission list Range Number of items in the list. The value ranges from 0 to 100.

**Table 5** MultiCloudClusterAuthInfo
Parameter	Type	Description
api_groups	String	Definition API group Range Length: 1 to 64 characters
resources	String	Definition Resource Range Length: 1 to 16 characters
function	String	Definition Feature Range Length: 1 to 16 characters
is_authed	Boolean	Whether the access permission is acquired
advice	String	Definition Suggestion Range Length: 1 to 128 characters

Example Requests

Obtain the account permissions of a multi-cloud cluster.

GET https://{endpoint}/v5/{project_id}/container/kubernetes/multi-cloud/clusters/{cluster_id}/permissions?enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 2,
  "data_list" : [ {
    "api_groups" : "",
    "resources" : "namespaces, pods, nodes, services, endpoints, configmaps, events, persistentvolumeclaims, persistentvolumes, podtemplates, repli",
    "function" : "Asset Management",
    "is_authed" : false,
    "advice" : "For details about how to configure RBAC permissions, see section \"Configuring the kubeconfig File\" in the documentation."
  }, {
    "api_groups" : "",
    "resources" : "pods/status",
    "function" : "Container Security Response",
    "is_authed" : false,
    "advice" : "For details about how to configure RBAC permissions, see section \"Configuring the kubeconfig File\" in the documentation."
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Installation and Configuration

Previous topic: Obtaining the Agent Installation Script of a Multi-Cloud Cluster

Next topic: Deleting a Multi-cloud Cluster

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