tke — Kubernetes Engine
tke · 2018-05-25
ModifyClusterAttribute
POST
Modify cluster attributes.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /tke/ModifyClusterAttribute 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: ModifyClusterAttribute' \
-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 |
| ProjectId | integer | No | Project of the Cluster |
| ClusterName | string | No | Cluster name |
| ClusterDesc | string | No | Cluster description |
| ClusterLevel | string | No | Cluster specification |
| AutoUpgradeClusterLevel | AutoUpgradeClusterLevel | No | Auto-upgrades cluster specification |
| QGPUShareEnable | boolean | No | Whether to enable qGPU Sharing |
| ClusterProperty | ClusterProperty | No | Cluster attributes |
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 |
|---|---|---|
| ProjectId | integer | Project of the Cluster |
| ClusterName | string | Cluster name |
| ClusterDesc | string | Cluster description |
| ClusterLevel | string | Cluster specification |
| AutoUpgradeClusterLevel | AutoUpgradeClusterLevel | Auto-upgrades cluster specification |
| QGPUShareEnable | boolean | Whether to enable qGPU Sharing |
| ClusterProperty | ClusterProperty | Cluster attributes |
| 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": {
"ProjectId": …,
"ClusterName": …,
"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 · ModifyClusterAttribute
What failure looks like
Example error responses for this action. Match on Code.
Recorded error 1
{
"Response": {
"RequestId": "893dae6d-82ae-1d6d-9df1-f55c4938a8e4",
"Error": {
"Code": "InvalidParameter",
"Message": "get cluster failed: clusters.platform.tkestack.io \"cls-00000000\" not found"
}
}
}