すべてのプロダクト
Search

このプロダクト

    Data Management:ListDBTaskSQLJob

    ドキュメントセンター

    Data Management:ListDBTaskSQLJob

    最終更新日:Mar 21, 2026

    SQL タスクの一覧を照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:ListDBTaskSQLJob

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBTaskGroupId

    integer

    必須

    SQL タスクグループの ID です。このパラメーターは、GetStructSyncJobDetail 操作を呼び出すことで取得できます。

    132****
    PageNumber

    integer

    任意

    返されるページ番号です。

    1
    PageSize

    integer

    任意

    各ページに返されるエントリ数です。

    20
    Tid

    integer

    任意

    テナントの ID です。

    説明

    テナント ID を確認するには、Data Management (DMS) コンソールにログインし、右上隅のプロフィール画像にポインターを合わせます。詳細については、「DMS テナントの管理」をご参照ください。

    1***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマです。

    RequestId

    string

    リクエストの ID です。

    F6C47680-8D2D-43A4-8902-F2740D71A398
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージです。

    UnknownError
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコードです。

    UnknownError
    DBTaskSQLJobList

    array<object>

    SQL タスクの一覧です。

    object

    SQL タスクです。

    JobId

    integer

    SQL タスクの ID です。

    12****
    JobType

    string

    SQL タスクの種別です。

    STRUCT_SYNC
    Comment

    string

    SQL タスクの説明です。

    test
    DbSearchName

    string

    データベースを検索するために使用する名前です。

    test@xxx:3306[test]
    DbId

    integer

    データベースの ID です。

    43214523
    Logic

    boolean

    データベースが論理データベースであるかどうかを示します。有効な値は以下のとおりです。

    • true: 論理データベースです。

    • false: 論理データベースではありません。

    false
    CreateTime

    string

    SQL タスクが作成された時刻です。

    2021-02-18 17:49:20
    LastExecTime

    string

    SQL タスクが最後に実行された時刻です。

    2021-02-18 17:49:31
    DbTaskGroupId

    integer

    SQL タスクグループの ID です。

    432****
    Status

    string

    SQL タスクの状態です。有効な値は以下のとおりです。

    • INIT: SQL タスクが初期化されました。

    • PENDING: SQL タスクが実行待ちです。

    • BE_SCHEDULED: SQL タスクがスケジュール待ちです。

    • FAIL: SQL タスクが失敗しました。

    • SUCCESS: SQL タスクが成功しました。

    • PAUSE: SQL タスクが一時停止されています。

    • DELETE: SQL タスクが削除されました。

    • RUNNING: SQL タスクが実行中です。

    SUCCESS
    Transactional

    boolean

    SQL タスクがトランザクションとして実行されるかどうかを示します。有効な値は以下のとおりです。

    • true: トランザクションとして実行されます。

    • false: トランザクションとして実行されません。

    false
    TotalCount

    integer

    SQL タスクの合計数です。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F6C47680-8D2D-43A4-8902-F2740D71A398",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DBTaskSQLJobList": [
    {
      "JobId": 0,
      "JobType": "STRUCT_SYNC",
      "Comment": "test",
      "DbSearchName": "test@xxx:3306[test]",
      "DbId": 43214523,
      "Logic": false,
      "CreateTime": "2021-02-18 17:49:20",
      "LastExecTime": "2021-02-18 17:49:31",
      "DbTaskGroupId": 0,
      "Status": "SUCCESS",
      "Transactional": false
    }
  ],
  "TotalCount": 1
}

    エラーコード

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

    変更履歴

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