すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeSyncJobList

    ドキュメントセンター

    AnalyticDB:DescribeSyncJobList

    最終更新日:Feb 26, 2026

    AnalyticDB for MySQL クラスター内の同期ジョブの一覧をクエリします。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribeSyncJobList

    get

    DBCluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID です。

    説明

    DescribeRegions 操作を呼び出して、最新のリージョン一覧を照会できます。

    cn-hangzhou
    DBClusterId

    string

    必須

    AnalyticDB for MySQL Data Warehouse Edition クラスターの ID です。

    説明

    DescribeDBClusters 操作を呼び出して、指定されたリージョン内にあるすべての AnalyticDB for MySQL Data Warehouse Edition クラスターの ID を照会できます。

    am-8vb39udfi356l9psq
    SourceDBType

    string

    任意

    ソースデータベースの種類です。

    列挙値:

    • rds :

      rds

    • sls :

      sls

    • polardb :

      polardb

    sls
    PageSize

    integer

    任意

    1 ページあたりの表示件数です。

    30
    PageNumber

    integer

    任意

    ページ番号です。1 から始まります。デフォルト値は 1 です。

    1
    SourceDBClusterId

    string

    任意

    ソースクラスターの ID です。DescribeDBClusters 操作を呼び出して、バックアップセット ID を照会できます。

    説明

    ApsaraDB for ClickHouse クラスターのデータを復元する場合、このパラメーターは必須です。

    pc-t4n766v2llx852n81
    SourceDBClusterDescription

    string

    任意

    ソースクラスターの説明です。

    test
    GetSourceDetail

    boolean

    任意

    ソースインスタンスまたはクラスターの詳細情報を取得するかどうかを指定します。

    列挙値:

    • true :

      true

    • false :

      false

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    TotalCount

    integer

    返された合計件数です。

    100
    PageSize

    integer

    1 ページあたりの表示件数です。

    30
    RequestId

    string

    リクエスト ID です。

    482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67
    PageNumber

    integer

    ページ番号です。

    1
    DBClusterId

    integer

    クラスター ID です。

    am-j6c22lubl8d9l3989
    SyncJobs

    array<object>

    照会された同期ジョブです。

    object

    照会された同期ジョブです。

    SourceStorageSize

    integer

    ソースインスタンスまたはクラスターのストレージサイズです。

    100
    SourceDBClusterId

    string

    ソースクラスターの ID です。DescribeDBClusters 操作を呼び出して、バックアップセット ID を照会できます。

    説明

    ApsaraDB for ClickHouse クラスターのデータを復元する場合、このパラメーターは必須です。

    pc-t4n766v2llx852n81
    JobId

    string

    Spark ジョブの ID です。

    dts-xxxxx
    SourceDBType

    string

    ソースインスタンスまたはクラスターのデータベース種類です。

    polardb
    SourceDBClusterDescription

    string

    ソースインスタンスまたはクラスターの説明です。

    test
    RegionId

    string

    リージョン ID です。

    cn-hangzhou
    SourceTableNumber

    integer

    ソースインスタンスまたはクラスター内のテーブル数です。

    100
    SyncPlatform

    string

    同期プラットフォームです。

    ADB-CDC

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 100,
  "PageSize": 30,
  "RequestId": "482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67",
  "PageNumber": 1,
  "DBClusterId": 0,
  "SyncJobs": [
    {
      "SourceStorageSize": 100,
      "SourceDBClusterId": "pc-t4n766v2llx852n81",
      "JobId": "dts-xxxxx",
      "SourceDBType": "polardb",
      "SourceDBClusterDescription": "test",
      "RegionId": "cn-hangzhou",
      "SourceTableNumber": 100,
      "SyncPlatform": "ADB-CDC"
    }
  ]
}

    エラーコード

    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.

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

    変更履歴

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