全部產品
Search

搜尋本產品

    ApsaraDB for ClickHouse：DescribeSynDbs - 查看同步db

    文件中心

    ApsaraDB for ClickHouse：DescribeSynDbs - 查看同步db

    更新時間：Sep 28, 2025

    查看同步db。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    clickhouse:DescribeSynDbs

    get

    *DBCluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DbClusterId

    string

    是

    雲資料庫 ClickHouse 的叢集 ID。

    cc-bp1ab22b80814****
    PageSize

    integer

    否

    每頁記錄數。

    20
    PageNumber

    integer

    否

    當前頁碼。

    1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    7655F5F9-1313-5ABA-8516-F6EB79605A5F
    SynDbs

    array<object>

    同步資料。

    object

    同步到 ClickHouse 的對象。

    RdsId

    string

    雲資料庫 RDS MySQL 的執行個體 ID。

    rm-wz9d11qg1j0h4****
    SynDb

    string

    雲資料庫 RDS MySQL 的資料庫。

    database
    SynStatus

    boolean

    同步是否成功，取值說明：

    • true：同步成功。

    • false：同步失敗。

    true
    ErrorMsg

    string

    • 當 SynStatus 返回為 true 時，不返回該參數。

    • 當 SynStatus 返回為 false 時，表示同步失敗的原因。

    ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n
    RdsUserName

    string

    雲資料庫 RDS MySQL 的資料庫帳號。

    test
    RdsVpcUrl

    string

    雲資料庫 RDS MySQL 的內網串連地址。

    rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306
    TotalCount

    integer

    總記錄數。

    0
    PageSize

    integer

    每頁記錄數。

    20
    PageNumber

    integer

    當前頁碼。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "7655F5F9-1313-5ABA-8516-F6EB79605A5F",
  "SynDbs": [
    {
      "RdsId": "rm-wz9d11qg1j0h4****",
      "SynDb": "database",
      "SynStatus": true,
      "ErrorMsg": "ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n",
      "RdsUserName": "test",
      "RdsVpcUrl": "rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306"
    }
  ],
  "TotalCount": 0,
  "PageSize": 20,
  "PageNumber": 1
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

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

    變更歷史

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