すべてのプロダクト
Search

このプロダクト

    AnalyticDB:ListStreamingJobs

    ドキュメントセンター

    AnalyticDB:ListStreamingJobs

    最終更新日:Mar 21, 2026

    リアルタイムデータ同期ジョブを照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    gpdb:ListStreamingJobs

    delete

    *DBInstance

    acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    説明

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

    cn-beijing
    DBInstanceId

    string

    必須

    インスタンス ID。

    gp-bp10g78o9807yv9h3
    PageSize

    integer

    任意

    1 ページあたりのレコード数。指定可能な値は以下のとおりです：

    • 30、50、100デフォルト値：30。

    kafka
    PageNumber

    integer

    任意

    ページ番号。0 より大きい整数で、Integer の最大値を超えてはなりません。デフォルト値：1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
    PageNumber

    integer

    現在のページ番号。

    1
    PageRecordCount

    integer

    1 ページあたりのレコード数。

    2
    TotalRecordCount

    integer

    レコードの合計数。

    2
    JobItems

    array<object>

    照会されたジョブの一覧。

    object

    JobId

    string

    ジョブ ID。

    1
    JobName

    string

    ジョブ名。

    test-job
    DataSourceId

    string

    データソース ID。

    58
    JobDescription

    string

    ジョブの説明文。

    test job
    SrcColumns

    array

    ソースフィールド。

    string

    ソースフィールドの名前。

    src_column_1
    DestColumns

    array

    送信先テーブル内のマップ対象フィールド。

    string

    送信先テーブル内のマップ対象フィールドの名前。

    dest_column_1
    MatchColumns

    array

    ソースデータと送信先テーブルを結合するための更新条件列。通常、送信先テーブルのすべてのプライマリキー列が該当します。このパラメーターで指定した複数の列の値が異なる行で同一の場合、その行は重複と見なされます。

    string

    更新条件列の名前。

    column_1
    UpdateColumns

    array

    更新条件を満たすデータ行に対して更新される列。通常、送信先テーブルのすべての非プライマリキー列が該当します。MatchColumns パラメーターで指定した列を条件としてソースデータと送信先テーブルを結合した場合、UpdateColumns 型の列のデータが一致時に更新されます。

    string

    更新対象列の名前。

    column_1
    Account

    string

    データベースアカウント名。

    test-account
    Password

    string

    データベースアカウントのパスワード。

    pwd123
    DestDatabase

    string

    ターゲットデータベース名。

    dest-db
    DestSchema

    string

    ターゲット名前空間名。

    dest-schema
    DestTable

    string

    送信先テーブル名。

    dest-table
    WriteMode

    string

    書き込みモード。

    INSERT/UPDATE/MERGE
    Mode

    string

    構成モード。有効な値は以下のとおりです：

    1. basic：基本モードでは、構成パラメーターを手動で設定する必要があります。

    2. professional：プロフェッショナルモードでは、YAML 構成ファイルを提出できます。

    basic / professional
    ErrorMessage

    string

    返されたエラーメッセージ。

    Status の戻り値が false の場合にのみ、このパラメーターが返されます。

    ""
    Status

    string

    ジョブのステータス。有効な値は以下のとおりです：

    • Init

    • Running

    • Exception

    • Paused

    Running
    CreateTime

    string

    ジョブの作成時刻。

    2019-09-08T16:00:00Z
    ModifyTime

    string

    ジョブの最終変更時刻。

    2019-09-08T17:00:00Z
    FallbackOffset

    string

    データ消費時のフォールバックオフセット。

    • コンシューマーが消費オフセットを要求しない、または現在の Kafka クラスターに記録されているオフセット情報の範囲外のオフセットを要求した場合に、データ消費を再開する起点となるオフセットを示します。有効な値：EARLIEST、LATEST。

    EARLIEST / LATEST
    Consistency

    string

    配信保証設定。

    ATLEAST / EXACTLY
    DataSourceName

    string

    データソース名。

    test-kafka

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "PageNumber": 1,
  "PageRecordCount": 2,
  "TotalRecordCount": 2,
  "JobItems": [
    {
      "JobId": "1",
      "JobName": "test-job",
      "DataSourceId": "58",
      "JobDescription": "test job",
      "SrcColumns": [
        "src_column_1"
      ],
      "DestColumns": [
        "dest_column_1"
      ],
      "MatchColumns": [
        "column_1"
      ],
      "UpdateColumns": [
        "column_1"
      ],
      "Account": "test-account",
      "Password": "pwd123",
      "DestDatabase": "dest-db",
      "DestSchema": "dest-schema",
      "DestTable": "dest-table",
      "WriteMode": "INSERT/UPDATE/MERGE",
      "Mode": "basic / professional",
      "ErrorMessage": "\"\"",
      "Status": "Running",
      "CreateTime": "2019-09-08T16:00:00Z",
      "ModifyTime": "2019-09-08T17:00:00Z",
      "FallbackOffset": "EARLIEST /  LATEST",
      "Consistency": "ATLEAST / EXACTLY",
      "DataSourceName": "test-kafka"
    }
  ]
}

    エラーコード

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

    変更履歴

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