CheckScaleOutBalanced

對指定雲端資料庫 ClickHouse 叢集進行遷移擴容檢測。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:CheckScaleOutBalanced

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地域 ID。您可以透過呼叫 DescribeRegions 介面查詢地域 ID。	cn-hangzhou
DBClusterId	string	是	叢集 ID。	cc-bp108z124a8o7****
PageSize	integer	否	每頁記錄數，取值： 30（預設值） 50 100。	30
PageNumber	integer	否	頁數。	1
ScalingType	string	否	變配類型。水平擴容：ScaleOut；水平縮容：ScaleIn；升級為多可用區部署：MultiAzUpgrade；磁碟降配：DiskDownGrade。	ScaleOut

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	總記錄數。	1
TableDetails	object
TableDetail	array<object>	檢測失敗資訊。
	object
TableName	string	本機資料表名稱。	test
Cluster	string	叢集，唯一取值為 default。	default
Database	string	資料庫名稱。	db_name
Detail	integer	異常內容，取值說明： 1：缺少唯一的分散式資料表。 2：對應的分散式資料表不唯一。	1
RequestId	string	請求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
PageSize	integer	每頁記錄數，取值： 30（預設值） 50 100。	30
PageNumber	integer	頁數。	1
CheckCode	string	檢測結果，取值說明： 400：檢測失敗。 200：檢測成功。	400
TimeDuration	string	遷移擴容所需要的時間。單位：分鐘。	21

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "TableDetails": {
    "TableDetail": [
      {
        "TableName": "test",
        "Cluster": "default",
        "Database": "db_name",
        "Detail": 1
      }
    ]
  },
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageSize": 30,
  "PageNumber": 1,
  "CheckCode": "400",
  "TimeDuration": "21"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.

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

變更歷史

更多資訊，參考變更詳情。