Managed Service for ClickHouse API, REST: Cluster.DeleteShards
Deletes the specified shards (one or more).
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/shards:batchDelete
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the ClickHouse cluster the shards belong to. |
Body parameters
{
"shardNames": [
"string"
]
}
Field |
Description |
shardNames[] |
string Names of the shards to be deleted. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"clusterId": "string",
"shardNames": [
"string"
]
},
// Includes only one of the fields `error`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
DeleteClusterShardsMetadata
Field |
Description |
clusterId |
string ID of the cluster that contains the shards being deleted. |
shardNames[] |
string Names of the shards being deleted. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |