すべてのプロダクト
Search
ドキュメントセンター

Data Management:ListDBTaskSQLJobDetail

最終更新日:Apr 08, 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:ListDBTaskSQLJobDetail

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

JobId

integer

必須

SQL タスクの ID。 ListDBTaskSQLJob 操作を呼び出してこの ID を取得できます。

1276****

PageNumber

integer

任意

ページ番号。

1

PageSize

integer

任意

1 ページあたりのエントリ数。

20

Tid

integer

任意

テナントの ID。 GetUserActiveTenant 操作を呼び出してこの ID を取得できます。

3***

レスポンスフィールド

フィールド

説明

object

応答で返されるデータ。

RequestId

string

リクエスト ID。

3F044E33-FE09-58F1-8C61-A0F612EC****

Success

boolean

リクエストが成功したかどうかを示します。 有効な値:

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

ErrorMessage

string

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

JobId is mandatory for this action.

ErrorCode

string

返されるエラーコード。

MissingJobId

DBTaskSQLJobDetailList

array<object>

SQL ジョブの詳細。

object

SQL ジョブの詳細。

JobDetailId

integer

SQL ジョブ詳細の ID。

24723****

CurrentSql

string

現在実行中の SQL ステートメント。

update a set id = 1 where id = 1;

ExecuteCount

integer

実行回数。

1

JobId

integer

SQL ジョブの ID。

1276****

DbId

integer

物理データベースの ID。

1988****

Logic

boolean

データベースが論理データベースであるかどうかを示します。 有効な値:

  • true:論理データベース

  • false:物理データベース

false

Skip

boolean

SQL スクリプトがスキップされたかどうかを示します。 有効な値:

  • true:スクリプトはスキップされました。

  • false:スクリプトはスキップされませんでした。

false

SqlType

string

SQL ステートメントのタイプ。 例:DELETE、UPDATE、ALTER_TABLE。

CREATE_TABLE

Status

string

SQL ジョブのステータス。 有効な値:

  • INIT:ジョブは初期化中です。

  • PENDING:ジョブはフェッチ保留中です。

  • BE_SCHEDULED:ジョブはスケジュール待ちです。

  • FAIL:ジョブは失敗しました。

  • SUCCESS:ジョブは成功しました。

  • PAUSE:ジョブは一時停止しています。

  • DELETE:ジョブは削除されました。

  • RUNNING:ジョブは実行中です。

SUCCESS

Log

string

SQL ジョブの実行ログ。

log_info

StartTime

string

SQL の実行が開始された時刻。

2021-12-16 00:00:00

EndTime

string

SQL の実行が終了した時刻。

2021-12-16 00:00:01

TimeDelay

integer

SQL の実行時間 (ミリ秒単位)。

38

AffectRows

integer

影響を受けた行数。

0

SqlId

integer

SQL ステートメントの ID。

TotalCount

integer

SQL ジョブの総数。

1

成功レスポンス

JSONJSON

{
  "RequestId": "3F044E33-FE09-58F1-8C61-A0F612EC****",
  "Success": true,
  "ErrorMessage": "JobId is mandatory for this action.",
  "ErrorCode": "MissingJobId",
  "DBTaskSQLJobDetailList": [
    {
      "JobDetailId": 0,
      "CurrentSql": "update a set id = 1 where id  = 1;",
      "ExecuteCount": 1,
      "JobId": 0,
      "DbId": 0,
      "Logic": false,
      "Skip": false,
      "SqlType": "CREATE_TABLE",
      "Status": "SUCCESS",
      "Log": "log_info",
      "StartTime": "2021-12-16 00:00:00",
      "EndTime": "2021-12-16 00:00:01",
      "TimeDelay": 38,
      "AffectRows": 0,
      "SqlId": 0
    }
  ],
  "TotalCount": 1
}

エラーコード

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

変更履歴

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