CreateSqlLogTask 使用による SQL ログのオフラインタスク作成 - DAS - Alibaba Cloud - Database Autonomy Service

詳細データ用の非同期タスクを作成します。

操作説明

開始する前に:

最新バージョンの Alibaba Cloud SDK または DAS SDK を使用してください。
SDK を使用して DAS 操作を呼び出す場合は、リージョンを cn-shanghai にセットしてください。
バッチタスクの作成をサポートするのは、DAS Enterprise Edition が有効なデータベースインスタンスのみです。各 DAS Enterprise Edition バージョンでサポートされるデータベースとリージョンの詳細については、「DAS エディションとサポートされる特徴」を参照してください。

レート制限:

同時実行タスクの最大値は 10 です。

今すぐお試しください

この 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:CreateSqlLogTask

create

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	データベースインスタンスの ID。	pc-2ze8g2am97624****
NodeId	string	任意	ノードの ID。説明このパラメーターはクラスターインスタンスにのみ適用されます。このパラメーターを指定すると、特定のノードのバッチタスクをクエリできます。このパラメーターを指定しない場合、デフォルトでプライマリノードのバッチタスクが返されます。	pi-uf6k5f6g3912i****
Type	string	任意	タスクタイプ。 Export: エクスポートタスク。説明 Export でサポートされるフィルターパラメーターと値については、「リクエストパラメーターの説明」を参照してください。 Query: クエリタスク。	Export
Name	string	任意	タスク名。	SQL audit export 1
Filters	array<object>	任意	フィルター条件のリスト。
	object	任意	フィルター条件。
Key	string	任意	フィルターパラメーターの名前。説明サポートされるフィルターパラメーターと値については、「リクエストパラメーターの説明」を参照してください。	KeyWords
Value	string	任意	フィルターパラメーターの値。	select
StartTime	integer	任意	タスクの開始時刻。値は UNIX タイムスタンプとして指定します。単位: ミリ秒。	1596177993000
EndTime	integer	任意	タスクの終了時間。値は UNIX タイムスタンプとして指定します。単位: ミリ秒。	1608888296000
Role	string	任意	PolarDB-X 2.0 データベースインスタンスのノード情報。 polarx_cn: コンピューティングノード。 polarx_dn: データノード。	polarx_cn

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。
JobId: 返された結果をさらにクエリするために使用される非同期タスク ID。
Delimiter: 区切り文字。サポートされる値: | , $ #。
Columns: Type = Export (タスクタイプがエクスポートタスク) の場合、エクスポート列をスペースで区切って指定します。有効な値:
- columnDBName: データベース
- columnThreadId: スレッド ID
- columnAccountName: ユーザー
- columnHostAddress: クライアント IP
- columnSqlType: SQL タイプ
- columnState: ステータス
- columnConsume: 実行時間 (us)
- columnUpdateRows: 更新された行数
- columnScanRows: スキャンされた行数
- columnReturnRows: 返された行数
- columnLockTime: ロック待機時間
- columnLogicRead: 論理読み取り
- columnPhysicSyncRead: 物理同期読み取り
- columnPhysicASyncRead: 物理非同期読み取り
- columnOriginTime: 実行時間 (us)
- columnExecuteTime: 実行時刻 (例: 2024-07-30 11:00:00)

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	応答コード。	200
Message	string	返されたメッセージ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
RequestId	string	リクエスト ID。	83D9D59B-057A-54A9-BFF9-CF2B42F05645
Success	string	リクエストが成功したかどうかを示します。 true: 成功。 false: 失敗した。	true
Data	object	返されたデータ。
TaskId	string	タスクの ID。	54f8041743ca3a9ac5cb9342d050527c
InstanceId	string	データベースインスタンスの ID。	pc-2ze8g2am97624****
Name	string	タスク名。	Export_test
Start	integer	開始時刻。値は UNIX タイムスタンプとして指定します。単位: ミリ秒。	1596177993000
End	integer	終了時間。値は UNIX タイムスタンプとして指定します。単位: ミリ秒。	1608888296000
Status	string	タスクのステータス。 INIT: スケジューリング待ち。 RUNNING: 実行中。 FAILED: 失敗した。 CANCELED: キャンセル済み。 COMPLETED: 完了。説明タスクが COMPLETED 状態になると、タスク結果をビューできます。	COMPLETED
CreateTime	integer	タスクの作成時間。値は UNIX タイムスタンプとして指定します。単位: ミリ秒。	1681363254423

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "83D9D59B-057A-54A9-BFF9-CF2B42F05645",
  "Success": "true",
  "Data": {
    "TaskId": "54f8041743ca3a9ac5cb9342d050527c",
    "InstanceId": "pc-2ze8g2am97624****",
    "Name": "Export_test",
    "Start": 1596177993000,
    "End": 1608888296000,
    "Status": "COMPLETED",
    "CreateTime": 1681363254423
  }
}

エラーコード

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

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

変更履歴

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