DescribeOSSStorage - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the storage of cold data.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
clickhouse:DescribeOSSStorage	get	DBCluster acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

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
2024-09-25	API Description Update. The Error code has changed	View Change Details