DescribeOSSStorage

更新時間:
Copy as MD

檢視冷存。

調試

您可以在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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情