DescribeOSSStorage - 查看冷存 - 云数据库 ClickHouse

查看冷存。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:DescribeOSSStorage	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。	cn-hangzhou
DBClusterId	string	是	集群 ID。	cc-bp108z124a8o7****

返回参数

名称	类型	描述	示例值
	object
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" }]
RequestId	string	请求 ID。	aadbb456-ebf7-4ed8-9671-fad9f3846ca4
State	string	冷热分层存储的状态，取值说明： CREATING：开通中。 DISABLE：未开通。 ENABLE：已开通。	ENABLE
ColdStorage	boolean	是否支持开通冷热分层存储，取值说明： true：支持开通。 false：不支持开通。	true
StorageUsage	string	冷数据存储使用空间，单位：GB。	0.00

示例

正常返回示例

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

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	An error occurred while processing your request.	系统内部错误，请稍后重试
503	ServiceUnavailable	An error occurred while processing your request.	系统暂时不可用，请稍后重试

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-09-25	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情