DescribeClusterSecurity

Last updated: 2020-11-16 11:33:42

1. API Description

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

This API is used to query the key information of a 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

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: DescribeClusterSecurity.
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. Enter the ClusterId field returned by the DescribeClusters API

3. Output Parameters

Parameter Name Type Description
UserName String Cluster's account name
Password String Cluster's password
CertificationAuthority String Cluster's access CA certificate
ClusterExternalEndpoint String Cluster's access address
Domain String Domain name accessed by the cluster
PgwEndpoint String Cluster's endpoint address
SecurityPolicy Array of String Cluster's access policy group
Note: This field may return null, indicating that no valid value was found.
Kubeconfig String Cluster Kubeconfig file
Note: This field may return null, indicating that no valid value was found.
JnsGwEndpoint String Access address of the cluster JnsGw
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying secret information of a cluster

This example shows you how to query the secret information of a cluster.

Input Example

https://tke.tencentcloudapi.com/?Action=DescribeClusterSecurity
&ClusterId=cls-xxxxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "UserName": "xxxxx",
    "CertificationAuthority": "xxxxxx",
    "RequestId": "eac6b301-a322-493a-8e36-83b295459398"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Operation failed.
InternalError Internal error.
InternalError.AccountUserNotAuthenticated Account not verified.
InternalError.Db DB error.
InternalError.DbAffectivedRows Database error.
InternalError.DbRecordNotFound Record not found.
InternalError.Param Parameter error.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter.Param Invalid parameter.
LimitExceeded Quota limit is exceeded.
MissingParameter Missing parameter.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceNotFound.ClusterNotFound The cluster does not exist.
ResourceNotFound.KubeResourceNotFound The specified resource is not found in the Kubernetes cluster.
ResourceUnavailable Resource is unavailable
ResourceUnavailable.ClusterState The cluster’s status does support this operation.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.CamNoAuth The API has no CAM permissions.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help