DescribeOSSStorage - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the storage of cold data.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****

Response parameters

Parameter	Type	Description	Example
	object
Policy	string	The parameters for tiered storage of hot data and cold data.	[{ "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	string	The request ID.	aadbb456-ebf7-4ed8-9671-fad9f3846ca4
State	string	The state of tiered storage of hot data and cold data. Valid values: CREATING: Tiered storage of hot data and cold data is being enabled. DISABLE: Tiered storage of hot data and cold data is not enabled. ENABLE: Tiered storage of hot data and cold data is enabled.	ENABLE
ColdStorage	boolean	Indicates whether tiered storage of hot data and cold data is supported. Valid values: true: Tiered storage of hot data and cold data is supported. false: Tiered storage of hot data and cold data is not supported.	true
StorageUsage	string	The space used for tiered storage of hot data and cold data. Unit: GB.	0.00

Examples

Sample success responses

JSONformat

{
  "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.00"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history