Queries whether hot and cold-tiered storage is enabled for an ApsaraDB for ClickHouse cluster.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeOSSStorage

The operation that you want to perform. Set the value to DescribeOSSStorage.

RegionId String Yes cn-hangzhou

The ID of the region. You can call the DescribeRegions operation to query the most recent region list.

DBClusterId String Yes cc-bp108z124a8o7****

The ID of the cluster.

Response parameters

Parameter Type Example Description
Policy String [{ "currentValue":"0.1", "defaultValue":"0.1", "desc":"Ratio of free disk space. When the ratio exceeds the value of configuration parameter, ClickHouse start to move data to the cold storage", "name":"move_factor", "restart":true, "valueRange":"(0, 1]" },{ "currentValue":"true", "defaultValue":"true", "desc":"Disables merging of data parts on cold storage", "name":"prefer_not_to_merge", "restart":true, "valueRange":"true|false" }]

The parameters of the hot and cold-tiered storage policy.

RequestId String aadbb456-ebf7-4ed8-9671-fad9f3846ca4

The ID of the request.

State String ENABLE

The state of hot and cold-tiered storage. Valid values:

  • CREATING: The hot and cold-tiered storage is being enabled.
  • DISABLE: The hot and cold-tiered storage is not enabled.
  • ENABLE: The hot and cold-tiered storage is enabled.
ColdStorage Boolean true

Indicates whether the hot and cold-tiered storage can be enabled. Valid values:

  • true: The hot and cold-tiered storage can be enabled.
  • false: The hot and cold-tiered storage cannot be enabled.
StorageUsage String 0.00

The space used for cold data storage. Unit: GB.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=DescribeOSSStorage
&RegionId=cn-hangzhou
&DBClusterId=cc-bp108z124a8o7****
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeOSSStorageResponse>
    <Policy>[{ "currentValue":"0.1", "defaultValue":"0.1", "desc":"Ratio of free disk space. When the ratio exceeds the value of configuration parameter, ClickHouse start to move data to the cold storage", "name":"move_factor", "restart":true, "valueRange":"(0, 1]" },{ "currentValue":"true", "defaultValue":"true", "desc":"Disables merging of data parts on cold storage", "name":"prefer_not_to_merge", "restart":true, "valueRange":"true|false" }]</Policy>
    <RequestId>aadbb456-ebf7-4ed8-9671-fad9f3846ca4</RequestId>
    <State>ENABLE</State>
    <ColdStorage>true</ColdStorage>
    <StorageUsage>0.00</StorageUsage>
</DescribeOSSStorageResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Policy" : "[{ \"currentValue\":\"0.1\", \"defaultValue\":\"0.1\", \"desc\":\"Ratio of free disk space. When the ratio exceeds the value of configuration parameter, ClickHouse start to move data to the cold storage\", \"name\":\"move_factor\", \"restart\":true, \"valueRange\":\"(0, 1]\" },{ \"currentValue\":\"true\", \"defaultValue\":\"true\", \"desc\":\"Disables merging of data parts on cold storage\", \"name\":\"prefer_not_to_merge\", \"restart\":true, \"valueRange\":\"true|false\" }]",
  "RequestId" : "aadbb456-ebf7-4ed8-9671-fad9f3846ca4",
  "State" : "ENABLE",
  "ColdStorage" : true,
  "StorageUsage" : 0
}

Error codes

HttpCode Error code Error message Description
500 InternalError An error occurred while processing your request. The error message returned because an internal error has occurred. Try again later.
503 ServiceUnavailable An error occurred while processing your request. The error message returned because the service is unavailable. Try again later.

For a list of error codes, visit the API Error Center.