tke — Kubernetes Engine
tke · 2018-05-25
DescribeClusterEndpointStatus
POST
Query cluster access port status (intranet / extranet access is enabled for independent clusters, and intranet access is supported for managed clusters).
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /tke/DescribeClusterEndpointStatus 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: DescribeClusterEndpointStatus' \
-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 |
| IsExtranet | boolean | No | Whether public network access is enabled or not (True = public network access, FALSE = private network access, with the default value as FALSE). |
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 |
|---|---|---|
| Status | string | The status of cluster access port. It can be `Created` (enabled); `Creating` (enabling) and `NotFound` (not enabled) |
| ErrorMsg | string | Details of the error occurred while opening the access port |
| 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": {
"Status": …,
"ErrorMsg": …,
"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.
Request bodyvalid JSONPOST tke.api3.convergecloud.com · DescribeClusterEndpointStatus
Read-only. Creates nothing.