すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:DescribeTransferHistory

    ドキュメントセンター

    ApsaraDB for ClickHouse:DescribeTransferHistory

    最終更新日:Mar 30, 2026

    データ移行履歴を表示します。

    操作説明

    説明

    この API オペレーションは、Alibaba Cloud ClickHouse クラスターのバージョンアップ時のクラスター間データ移行情報を照会する場合にのみ使用します。

    今すぐお試しください

    この 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:DescribeTransferHistory

    get

    *DBCluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスターの ID です。

    cc-bp108z124a8o7****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    HistoryDetails

    object

    HistoryDetail

    array<object>

    データ移行の詳細情報です。

    object

    SourceDBCluster

    string

    ソースクラスターの ID です。

    cc-bp108z124a8o7****
    SourceControlVersion

    string

    ソースクラスターのコントロールバージョンです。

    v1
    TargetDBCluster

    string

    ターゲットクラスターの ID です。

    cc-bp13zkh9uw523****
    TargetControlVersion

    string

    ターゲットクラスターのコントロールバージョンです。

    v2
    Status

    string

    データ移行のステータスです。有効な値は以下のとおりです。

    • Finished：完了済み。

    • Processing：実行中。

    Finished
    Progress

    string

    データ移行の進捗率です。

    100%
    DisableWriteWindows

    string

    書き込み一時停止ウィンドウです。

    2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00
    UnsyncedBytes

    integer

    同期されていないデータ量（バイト単位）です。

    102400
    UnsyncedParts

    integer

    同期されていないパーツ数です。

    1000
    PartsPerMinute

    number

    1 分あたりに移行されるパーツ数です。

    1.24
    BytesPerMinute

    integer

    1 分あたりに移行されるデータ量（バイト単位）です。

    10240
    SubJob

    string

    実行中のサブジョブです。

    SubJob
    SubJobStatus

    string

    サブジョブのステータスです。

    running
    SubJobMessage

    string

    サブジョブから返されたメッセージです。

    Code: 210. DB::NetException: Connection refused (ck-****-****-clickhouse-s-0-r-0.ck-****-****-clickhouse-headless.ck-****.svc.cluster.local:3003). (NETWORK_ERROR) (version 22.8.5.29)
    RequestId

    string

    リクエスト ID です。

    05321590-BB65-4720-8CB6-8218E041CDD0

    例

    成功レスポンス

    JSONJSON

    {
  "HistoryDetails": {
    "HistoryDetail": [
      {
        "SourceDBCluster": "cc-bp108z124a8o7****",
        "SourceControlVersion": "v1",
        "TargetDBCluster": "cc-bp13zkh9uw523****",
        "TargetControlVersion": "v2",
        "Status": "Finished",
        "Progress": "100%",
        "DisableWriteWindows": "2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00",
        "UnsyncedBytes": 102400,
        "UnsyncedParts": 1000,
        "PartsPerMinute": 1.24,
        "BytesPerMinute": 10240,
        "SubJob": "SubJob",
        "SubJobStatus": "running",
        "SubJobMessage": "Code: 210. DB::NetException: Connection refused (ck-****-****-clickhouse-s-0-r-0.ck-****-****-clickhouse-headless.ck-****.svc.cluster.local:3003). (NETWORK_ERROR) (version 22.8.5.29)"
      }
    ]
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError An error occurred while processing your request. An error occurred while processing your request.
    503 ServiceUnavailable An error occurred while processing your request. An error occurred while processing your request.

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

    変更履歴

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