すべてのプロダクト
Search

このプロダクト

    Database Autonomy Service:DescribeSqlLogTask

    ドキュメントセンター

    Database Autonomy Service:DescribeSqlLogTask

    最終更新日:Aug 28, 2026

    DAS Enterprise Edition のバッチタスクの詳細を照会します。

    操作説明

    開始する前に:

    • Alibaba Cloud または DAS SDK の最新バージョンを使用してください。

    • SDK を使用して DAS を呼び出す際は、リージョンを cn-shanghai に設定してください。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hdm:DescribeSqlLogTask

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    任意

    データベースインスタンスの ID。

    r-bp1nti25tc7bq5****
    TaskId

    string

    任意

    タスクの ID。

    a4f5c4494dbd6713185d87a97aa53e8
    PageNo

    integer

    任意

    ページングクエリのページ番号。ページは 1 から始まります。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページングクエリの 1 ページあたりの最大レコード数。最大値: 100。デフォルト値: 10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ルートノードまたはルートディレクトリ。

    Code

    string

    返される状態コード。

    200
    Message

    string

    返されるメッセージ。

    説明

    リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどの例外情報が返されます。

    Successful
    RequestId

    string

    リクエスト ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    string

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

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

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

    true
    Data

    object

    返されるデータ。

    Name

    string

    タスクの名前。

    SQL 監査エクスポート 1
    TaskId

    string

    タスクの ID。

    9a4f5c4494dbd6713185d87a97aa53e8
    TaskType

    string

    タスクのタイプ。有効な値:

    • Export: エクスポートタスク。

    • Query: カスタムクエリタスク。

    Query
    CreateTime

    integer

    タスクの作成時刻。値はミリ秒単位の UNIX タイムスタンプです。

    1681363254423

    Status

    string

    タスクのステータス。有効な値:

    • INIT: スケジューリング待ち。

    • RUNNING: 実行中。

    • FAILED: 失敗した。

    • CANCELED: キャンセル済み。

    • COMPLETED: 完了。

    説明

    タスクが COMPLETED 状態の場合、オフラインタスクの結果をビューできます。

    COMPLETED
    Expire

    boolean

    タスクが期限切れかどうかを示します。

    • true: タスクは期限切れです。

    • false: タスクは期限切れではありません。

    false
    Start

    integer

    クエリの開始時刻。値はミリ秒単位の UNIX タイムスタンプです。

    1596177993000

    End

    integer

    クエリの終了時刻。値はミリ秒単位の UNIX タイムスタンプです。

    1608888296000

    Filters

    array<object>

    フィルター条件。

    object

    クエリのフィルター条件。

    Key

    string

    フィルターパラメーターの名前。

    説明

    サポートされているフィルターパラメーターとその値については、「応答パラメーターの補足説明」を参照してください。

    keyWords
    Value

    any

    フィルターパラメーターの値。

    select
    Total

    integer

    タスクの総数。

    1
    Queries

    array<object>

    オフラインクエリノードのタスク結果。この値は TaskType が Query に設定されている場合にのみ返されます。

    object

    オフラインクエリノードのタスク結果。

    Vip

    string

    クエリリンクのエンドポイント解像度アドレス。

    10.146.XX.XX
    NodeId

    string

    子ノードの ID。

    pi-bp1o58x3ib7e6****

    SqlText

    string

    SQL ステートメントの詳細。

    SELECT @@session.トランザクション_read_only
    SqlType

    string

    SQL ステートメントのタイプ。有効な値:

    • SELECT

    • UPDATE

    • DELETE

    SELECT
    State

    string

    実行結果。

    • 0: 実行成功。

    • 1: 失敗した。

    0
    DBName

    string

    データベース名。

    testdb01
    SqlId

    string

    SQL ID。

    a4111670e80596c5bf42cf5154438a91
    ExecuteTime

    string

    協定世界時 (UTC) フォーマットの実行時間: yyyy-MM-ddTHH:mm:ssZ。

    2023-12-07T02:15:32Z
    OriginTime

    integer

    実行時間。値はミリ秒単位の UNIX タイムスタンプです。

    1701886532000

    AccountName

    string

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

    testname
    HostAddress

    string

    クライアント IP アドレス。

    11.197.XX.XX

    Consume

    integer

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

    58
    LockTime

    integer

    ロック待ち時間 (ミリ秒単位)。

    0
    UpdateRows

    integer

    更新された行数。

    0
    ScanRows

    integer

    スキャンされた行数。

    0
    ReturnRows

    integer

    返された行数。

    0
    LogicRead

    integer

    論理読み込みの数。

    0
    PhysicSyncRead

    integer

    物理同期読み込みの数。

    0
    PhysicAsyncRead

    integer

    物理非同期読み込みの数。

    0
    ThreadId

    integer

    スレッドの ID。

    None
    TrxId

    string

    トランザクションの ID。

    200000

    Ext

    string

    拡張情報フィールド。これは予約済みのパラメーターです。

    None
    Scnt

    integer

    PolarDB-X 2.0 コンピューティングノード (CN) からの DN リクエスト数。

    10

    Rows

    integer

    PolarDB-X 2.0 コンピューティングノードによって更新または返された行の総数。

    10
    Frows

    integer

    PolarDB-X 2.0 コンピューティングノード (CN) によってフェッチされた行数。

    10
    TraceId

    string

    PolarDB-X 2.0 のトレース ID。データノードでの SQL ステートメントの実行 ID です。

    14c93b7c7bf00000

    UseImciEngine

    string

    PolarDB for MySQL インスタンスがインメモリー列指向インデックスを使用しているかどうかを示します。

    • true: IMCI が使用されています。

    • false: IMCI は使用されていません。

    true
    ParallelDegree

    string

    PolarDB for MySQL インスタンスの並列キュー時間 (ミリ秒単位)。

    10

    ParallelQueueTime

    string

    PolarDB for MySQL インスタンスの次数。

    2
    PhysicRead

    integer

    物理読み込みの数。

    0
    CpuTime

    integer

    CPU 実行時間 (マイクロ秒単位)。

    100

    Writes

    integer

    RDS SQL Server エンジンの書き込み数。

    10
    Collection

    string

    予約済みのパラメーター。

    None
    SqlCommand

    integer

    クエリ内の SQL コマンド。

    sql
    ConnectionId

    string

    クエリで使用される接続 ID。

    ld-******
    Protected

    string

    クエリ項目が保護されているかどうかを示します。

    MySQL
    Params

    string

    クエリパラメーターのリスト。

    [1, "das"]
    ClientIp

    string

    クエリのクライアント IP アドレス。

    10.0.0.1xx
    ClientPort

    integer

    クエリのクライアントポート番号。

    3306
    RowKey

    string

    クエリの行キー。

    23
    AffectColumns

    string

    影響を受ける列。

    ["col1"]
    TableName

    string

    クエリで使用されるテーブル名。

    das
    Export

    string

    エクスポートタスクのダウンロード URL。この値は、TaskType が Export に設定されている場合にのみ返されます。

    "https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****"

    Key は以下のパラメーターと値をサポートします:

    • KeyWords: キーワード。複数のキーワードはスペースで区切ります。

    • LogicalOperator: キーワード間の論理演算子。有効な値: and または or。

    • AccountName: ユーザー名。複数のユーザー名をカンマで区切って指定できます。最大数は 5 です。

    • dbName: データベース名。複数のデータベース名をカンマで区切って指定できます。最大数は 5 です。

    • HostAddress: クライアントの IP アドレス。複数の IP アドレスをカンマで区切って指定できます。最大数は 5 です。

    • MaxConsume: 実行持続時間の最大値。単位: us。

    • MinConsume: 実行持続時間の最小値。単位: us。

    • MaxScanRows: スキャンされた行数の最大値。

    • MinScanRows: スキャンされた行数の最小値。

    • SqlType: SQL タイプ。有効な値: select、update、insert、または delete。

    • State: 実行結果。有効な値: 0 (成功) または 1 (失敗)。

    • ThreadId: スレッド ID。

    • SortKey: ソート列の名前。有効な値: ScanRows (スキャンされた行数)、UpdateRows (更新された行数)、Consume (実行持続時間)、ExecuteTime (実行時刻)、ReturnRows (返された行数)、LockTime (ロック待ち時間)、Frows (PolarDB-X 2.0 コンピューティングノードによってフェッチされた行数)、Scnt (PolarDB-X 2.0 コンピューティングノードからの DN リクエスト数)、CpuTime (CPU 実行時間)、または PhysicalRead (物理読み込み)。

    • SortMethod: ソート順序。有効な値: DESC (降順) または ASC (昇順)。デフォルト値: DESC。

    • TraceId: PolarDB-X 2.0 インスタンスのトレース ID。

    • MinRows: 更新された行数の最小値。

    • MaxRows: 更新された行数の最大値。

    • MinScnt: PolarDB-X 2.0 コンピューティングノード (CN) からの DN リクエスト数の最小値。

    • MaxScnt: PolarDB-X 2.0 コンピューティングノード (CN) からの DN リクエスト数の最大値。

    • TrxId: トランザクション ID。

    • Fail: エラーコード。

    • SqlId: SQL ID。

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "Name": "SQL audit export 1",
    "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8\n",
    "TaskType": "Query",
    "CreateTime": 1681363254423,
    "Status": "COMPLETED",
    "Expire": true,
    "Start": 1596177993000,
    "End": 1608888296000,
    "Filters": [
      {
        "Key": "keyWords\n",
        "Value": "select"
      }
    ],
    "Total": 1,
    "Queries": [
      {
        "Vip": "10.146.XX.XX",
        "NodeId": "pi-bp1o58x3ib7e6****\n",
        "SqlText": "SELECT @@session.transaction_read_only",
        "SqlType": "SELECT",
        "State": "0",
        "DBName": "testdb01",
        "SqlId": "a4111670e80596c5bf42cf5154438a91",
        "ExecuteTime": "2023-12-07T02:15:32Z",
        "OriginTime": 1701886532000,
        "AccountName": "testname\n",
        "HostAddress": "11.197.XX.XX\n",
        "Consume": 58,
        "LockTime": 0,
        "UpdateRows": 0,
        "ScanRows": 0,
        "ReturnRows": 0,
        "LogicRead": 0,
        "PhysicSyncRead": 0,
        "PhysicAsyncRead": 0,
        "ThreadId": 0,
        "TrxId": "200000\n",
        "Ext": "None",
        "Scnt": 10,
        "Rows": 10,
        "Frows": 10,
        "TraceId": "14c93b7c7bf00000 ",
        "UseImciEngine": "true\n",
        "ParallelDegree": "10\n",
        "ParallelQueueTime": "2",
        "PhysicRead": 0,
        "CpuTime": 100,
        "Writes": 10,
        "Collection": "None",
        "SqlCommand": 0,
        "ConnectionId": "ld-******",
        "Protected": "MySQL",
        "Params": "[1, \"das\"]",
        "ClientIp": "10.0.0.1xx",
        "ClientPort": 3306,
        "RowKey": "23",
        "AffectColumns": "[\"col1\"]",
        "TableName": "das"
      }
    ],
    "Export": "\"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****\""
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParams The request parameters are invalid. リクエストパラメーターが無効です。
    403 NoPermission You are not authorized to do this action. この操作を実行する権限がありません。

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

    変更履歴

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