文档首页/ 云容器引擎 CCE/ API参考/ API/ 权限管理/ 获取访问策略详情 - GetAccessPolicy
更新时间:2025-11-05 GMT+08:00

获取访问策略详情 - GetAccessPolicy

功能介绍

该API用于获取单个访问策略。

调用方法

请参见如何调用API

URI

GET /api/v3/access-policies/{policy_id}

表1 路径参数

参数

是否必选

参数类型

描述

policy_id

String

参数解释:

访问策略ID。获取方式请参见获取访问策略列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

kind

String

参数解释:

API类型。

约束限制:

该值不可修改。

取值范围:

不涉及

默认取值:

AccessPolicy

apiVersion

String

参数解释:

API版本。

约束限制:

该值不可修改。

取值范围:

不涉及

默认取值:

v3

name

String

参数解释:

访问策略名称。

约束限制:

以小写字母开头,由小写字母、数字、中划线(-)组成,长度范围1-56位,且不能以中划线(-)结尾。

取值范围:

不涉及

默认取值:

不涉及

policyId

String

参数解释:

权限ID。

约束限制:

系统自动生成,该值不可修改。

取值范围:

不涉及

默认取值:

不涉及

clusters

Array of strings

参数解释:

集群ID的列表,允许使用通配符(“*”),表示所有集群。

约束限制:

当前最多支持同时授权200个集群。

取值范围:

["*"]或者集群ID列表。

默认取值:

不涉及

accessScope

AccessScope object

参数解释:

授权范围,指定需要授权的集群及命名空间。

约束限制:

不涉及

policyType

String

参数解释:

权限类型。

约束限制:

不涉及

取值范围:

  • CCEClusterAdminPolicy:管理员权限。对全部命名空间下所有资源的读写权限。

  • CCEAdminPolicy:运维权限。对全部命名空间下大多数资源的读写权限,对节点、存储卷,命名空间和配额管理的只读权限。

  • CCEEditPolicy:开发权限。对全部或所选命名空间下多数资源的读写权限。当配置在全部命名空间时能力与运维权限一致。

  • CCEViewPolicy:只读权限。对全部或所选命名空间下大多数资源的只读权限。

默认取值:

不涉及

principal

Principal object

参数解释:

授权对象。

约束限制:

不涉及

createTime

String

参数解释:

创建时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

updateTime

String

参数解释:

更新时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 AccessScope

参数

参数类型

描述

namespaces

Array of strings

参数解释:

集群命名空间的列表,允许使用通配符(“*”),表示所有命名空间。当选择了不同集群时,命名空间的列表可以为多个集群的集合,在转化成RBAC策略时,会自动判断集群下的命名空间是否存在。

约束限制:

当前最多支持同时授权500个命名空间。

取值范围:

["*"]或者集群命名空间列表。

默认取值:

不涉及

表4 Principal

参数

参数类型

描述

type

String

参数解释:

授权对象的类型。

约束限制:

不涉及

取值范围:

  • user:用户

  • group:用户组

  • agency:委托账号

默认取值:

不涉及

ids

Array of strings

参数解释:

授权对象ID列表,根据授权对象的类型,用户、用户组和委托账号,填入对应的ID。

约束限制:

当前最多支持同时授权500个用户/用户组。

取值范围:

不涉及

默认取值:

不涉及

请求示例

响应示例

状态码:200

{
  "kind" : "AccessPolicy",
  "apiVersion" : "v3",
  "name" : "test-access-policy",
  "policyId" : "402358e8-2e3a-4531-bae7-fe9cba14d0d1",
  "clusters" : [ "*" ],
  "accessScope" : {
    "namespaces" : [ "*" ]
  },
  "policyType" : "CCEAdminPolicy",
  "principal" : {
    "type" : "user",
    "ids" : [ "069fcc2116c347b89869eae3cdxxxxxx1", "069fcc2116c347b89869eae3cdxxxxxx2" ]
  },
  "createTime" : "",
  "updateTime" : ""
}

SDK代码示例

SDK代码示例如下。

 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.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;


public class GetAccessPolicySolution {

    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);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        GetAccessPolicyRequest request = new GetAccessPolicyRequest();
        request.withPolicyId("{policy_id}");
        try {
            GetAccessPolicyResponse response = client.getAccessPolicy(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 huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.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 = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = GetAccessPolicyRequest()
        request.policy_id = "{policy_id}"
        response = client.get_access_policy(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"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/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 := cce.NewCceClient(
        cce.CceClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.GetAccessPolicyRequest{}
	request.PolicyId = "{policy_id}"
	response, err := client.GetAccessPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

错误码

请参见错误码