tke · 2018-05-25

DescribeClusterSecurity

POST

Query the key information of a cluster.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /tke/DescribeClusterSecurity path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://tke.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/tke/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: tke.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeClusterSecurity' \
  -H 'X-TC-Version: 2018-05-25' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"ClusterId":"<ClusterId>"}'

Request parameters

Field	Type	Required	Description
ClusterId	string	Yes	Cluster ID. Enter the ClusterId field returned by the DescribeClusters API

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	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	string[]	Cluster's access policy group
Kubeconfig	string	Cluster Kubeconfig file
JnsGwEndpoint	string	Access address of the cluster JnsGw
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "UserName": …,
    "Password": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/tke.

SecretIdSecretKey

Request bodyvalid JSONPOST tke.api3.convergecloud.com · DescribeClusterSecurity

{
  "ClusterId": "<ClusterId>"
}

Read-only. Creates nothing.