全部產品
Search
文件中心

ApsaraDB for ClickHouse:CreateRDSToClickhouseDb - 建立同步任務

更新時間:Sep 28, 2025

調用CreateRDSToClickhouseDb介面建立雲資料庫ClickHouse社區相容版同步任務。

介面說明

說明

該介面僅適用於雲資料庫 ClickHouse 的社區相容版叢集。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:CreateRDSToClickhouseDb

create

*DBCluster

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

請求參數

名稱

類型

必填

描述

樣本值

DbClusterId

string

雲資料庫 ClickHouse 的叢集 ID。

cc-2ze5zeyl72188****

ClickhousePort

integer

雲資料庫 ClickHouse 的連接埠號碼。

8123

CkUserName

string

雲資料庫 ClickHouse 的資料庫帳號。

user1

CkPassword

string

雲資料庫 ClickHouse 的資料庫帳號密碼。

123456Aa

RdsId

string

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

rm-8vb989qj9roh0****

RdsPort

integer

雲資料庫 RDS MySQL 的連接埠號碼。

3306

RdsVpcId

string

雲資料庫 RDS MySQL 的 VPC ID。

vpc-2zen93xryil99jsfy****

RdsUserName

string

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

user2

RdsPassword

string

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

123456Rr

SkipUnsupported

boolean

是否忽略不支援同步的表結構,取值說明:

  • true:忽略。

  • false:不忽略。

true

LimitUpper

integer

每秒最多同步的行數。

50000

SynDbTables

string

同步的表。

[{"Schema":"recommend","Tables":["mr_platform_cpm","mr_platform_ecpm","p_monitor_record"]}]

RdsVpcUrl

string

雲資料庫 RDS 的內網地址。

rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com

返回參數

名稱

類型

描述

樣本值

object

返回結果。

RequestId

string

請求 ID。

66676F54-1994-5DCF-993F-74536649628A

Status

integer

建立是否成功,取值說明:

  • 1:建立成功。

  • 0:建立失敗。同步任務中的表重複了,具體重複的表在 RepeatedDbs 參數中返回。

  • -1:建立失敗。建立失敗的原因在 ErrorMsg 參數中返回。

0

ErrorMsg

string

Status 參數返回為-1 時,返回建立失敗的原因。

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

RepeatedDbs

array

同步任務中重複的表。

string

Status 返回為 0 時,返回建立同步任務中重複的表。

["mr_platform_cpm","mr_platform_ecpm"]

樣本

正常返回樣本

JSON格式

{
  "RequestId": "66676F54-1994-5DCF-993F-74536649628A",
  "Status": 0,
  "ErrorMsg": "ClickHouse exception, code: 49, host: 100.100.79.102, port: 14540; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n",
  "RepeatedDbs": [
    "[\"mr_platform_cpm\",\"mr_platform_ecpm\"]"
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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

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

變更歷史

更多資訊,參考變更詳情