すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:DescribeSynDbs

    ドキュメントセンター

    ApsaraDB for ClickHouse:DescribeSynDbs

    最終更新日:Sep 28, 2025

    同期されたデータベースに関する情報を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    clickhouse:DescribeSynDbs

    get

    *DBCluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DbClusterId

    string

    必須

    ApsaraDB for 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

    ApsaraDB RDS for MySQL インスタンスのインスタンス ID。

    rm-wz9d11qg1j0h4****
    SynDb

    string

    ApsaraDB RDS for 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

    ApsaraDB RDS for MySQL インスタンスのデータベースアカウント。

    test
    RdsVpcUrl

    string

    ApsaraDB RDS for MySQL インスタンスの内部エンドポイント。

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

    integer

    レコードの総数。

    0
    PageSize

    integer

    各ページのレコード数。

    20
    PageNumber

    integer

    現在のページ番号。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The DBClusterId provided does not exist in our records.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。