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.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: AcquireClusterAdminRole. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-05-25. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| ClusterId | Yes | String | Cluster ID |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
When a CAM admin sub-account is granted this action permission, it can acquire the cluster admin role through this API to access resources in the Kubernetes cluster.
https://tke.tencentcloudapi.com/?Action=AcquireClusterAdminRole
&ClusterId=cls-xxxx
&<Common request parameters>
{
"Response": {
"RequestId": "xxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InternalError.CamNoAuth | You do not have permissions. |
| InternalError.KubernetesClientBuildError | Failed to create the kubernetes client. |
| InternalError.UnexpectedInternal | Unknown internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.Param | Invalid parameter. |
| 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. |
Was this page helpful?