tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

AcquireClusterAdminRole

最后更新时间：2023-09-18 16:00:31

1. API Description

Domain name for API request: tke.tencentcloudapi.com.

This API can be called to acquire the ClusterRole tke:admin. By setting a CAM policy, you can grant permission of this API to a sub-account that has higher permission in CAM. In this way, this sub-account can call this API directly to acquire the admin role of a Kubernetes cluster.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: AcquireClusterAdminRole.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region No String Common Params. This parameter is not required for this API.
ClusterId Yes String Cluster ID

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Assigning the cluster admin role

This example shows you how to assign the cluster admin role to a sub-account to access resources in the Kubernetes cluster.

Input Example

https://tke.tencentcloudapi.com/?Action=AcquireClusterAdminRole
&ClusterId=cls-7ph3twqe
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "24564577-a642-4164-8752-4668d4ca8886"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.ComponentClientHttp Internal HTTP client error.
FailedOperation.KubernetesCreateOperationError An error occurs while creating the cluster client.
FailedOperation.KubernetesGetOperationError
InternalError Internal error.
InternalError.CamNoAuth You do not have permissions.
InternalError.KubernetesClientBuildError Failed to create the kubernetes client.
InternalError.KubernetesCreateOperationError Failed to create the kubernetes resource.
InternalError.KubernetesGetOperationError Failed to obtain the kubernetes resources
InternalError.UnexpectedInternal Unknown internal error.
InternalError.WhitelistUnexpectedError Unknown allowlist error
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
ResourceNotFound The resource does not exist.
ResourceNotFound.ClusterNotFound The cluster does not exist.
ResourceUnavailable.ClusterState The cluster’s status does support this operation.
UnauthorizedOperation.CamNoAuth The API has no CAM permissions.
UnsupportedOperation.NotInWhitelist The user is not in the allowlist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款