DescribeClusterCommonNames

Last updated: 2021-08-03 10:32:24

1. API Description

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

This API is used to obtain the CommonName from the kube-apiserver client certificate that corresponding to the sub-account in RBAC authorization mode.

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

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 parameter. The value used for this API: DescribeClusterCommonNames.
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
SubaccountUins.N No Array of String Sub-account. Up to 50 sub-accounts can be passed in at a time.
RoleIds.N No Array of String Role ID. Up to 50 role IDs can be passed in at a time.

3. Output Parameters

Parameter Name Type Description
CommonNames Array of CommonName The CommonName in the certificate of the client corresponding to the sub-account UIN
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the CommomName for the sub-account to access the cluster

Input Example

https://tke.tencentcloudapi.com/?Action=DescribeClusterCommonNames
&ClusterId=cls-65r1c5nu
&SubaccountUins.0=123456
&SubaccountUins.1=123457
&<Common request parameters>

Output Example

{
  "Response": {
    "CommonNames": [
      {
        "SubaccountUin": "123456",
        "CN": "123456-1588769189"
      }
    ],
    "RequestId": "33483fde-efec-4d3c-8ff6-340d9dbc2d01"
  }
}

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
InternalError Internal error.
InternalError.UnexpectedInternal Unknown internal error.
InternalError.WhitelistUnexpectedError Unknown allowlist error
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
ResourceNotFound.ClusterNotFound The cluster does not exist.
UnauthorizedOperation.CamNoAuth The API has no CAM permissions.
UnsupportedOperation.NotInWhitelist The user is not in the allowlist.