DescribeSqlLogTask - Database Autonomy Service

Menampilkan detail tugas offline di DAS Edisi Perusahaan.

Deskripsi operasi

Sebelum memanggil operasi ini, pastikan Anda telah memenuhi prasyarat berikut:

Gunakan versi terbaru Alibaba Cloud Software Development Kit (SDK) atau DAS SDK.
Saat menggunakan SDK untuk memanggil layanan DAS, atur wilayah ke cn-shanghai.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

hdm:DescribeSqlLogTask

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	No	ID instans database.	r-bp1nti25tc7bq5****
TaskId	string	No	ID tugas.	a4f5c4494dbd6713185d87a97aa53e8
PageNo	integer	No	Nomor halaman untuk kueri terpaginasi. Halaman dimulai dari 1. Nilai default adalah 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai maksimum adalah 100. Nilai default adalah 10.	10

Elemen respons

Element	Type	Description	Example
	object	Node root.
Code	string	Kode status yang dikembalikan.	200
Message	string	Pesan yang dikembalikan untuk permintaan. Catatan Jika permintaan berhasil, parameter ini mengembalikan Successful. Jika permintaan gagal, parameter ini mengembalikan pesan kesalahan, seperti kode kesalahan.	Successful
RequestId	string	ID permintaan.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true
Data	object	Data yang dikembalikan.
Name	string	Nama tugas.	SQL审计导出1
TaskId	string	ID tugas.	9a4f5c4494dbd6713185d87a97aa53e8
TaskType	string	Jenis tugas. Nilai yang valid: Export: tugas ekspor. Query: tugas kueri.	Query
CreateTime	integer	Waktu pembuatan tugas. Nilai ini merupakan stempel waktu UNIX dalam milidetik.	1681363254423
Status	string	Status tugas. Nilai yang valid: INIT: Tugas akan dijadwalkan. RUNNING: Tugas sedang berjalan. FAILED: Tugas gagal. CANCELED: Tugas dibatalkan. COMPLETED: Tugas selesai. Catatan Hasil tugas offline tersedia ketika status tugas adalah COMPLETED.	COMPLETED
Expire	boolean	Menunjukkan apakah tugas telah kedaluwarsa. Nilai yang valid: true false	false
Start	integer	Awal rentang waktu untuk kueri. Nilai ini merupakan stempel waktu UNIX dalam milidetik.	1596177993000
End	integer	Akhir rentang waktu untuk kueri. Nilai ini merupakan stempel waktu UNIX dalam milidetik.	1608888296000
Filters	array<object>	Kondisi filter.
	object	Kondisi filter untuk kueri.
Key	string	Nama parameter filter. Catatan Untuk informasi selengkapnya tentang parameter filter yang didukung beserta nilai validnya, lihat Informasi tambahan mengenai parameter respons.	keyWords
Value	any	Nilai parameter filter.	select
Total	integer	Jumlah total tugas.	1
Queries	array<object>	Hasil tugas kueri offline. Parameter ini hanya dikembalikan jika TaskType diatur ke Query.
	object	Hasil tugas kueri offline.
Vip	string	Titik akhir yang diselesaikan dari koneksi kueri.	10.146.XX.XX
NodeId	string	ID node anak.	pi-bp1o58x3ib7e6****
SqlText	string	Pernyataan SQL.	SELECT @@session.transaction_read_only
SqlType	string	Jenis pernyataan SQL. Nilai yang valid: SELECT UPDATE DELETE	SELECT
State	string	Hasil eksekusi. Nilai yang valid: 0: Eksekusi berhasil. 1: Eksekusi gagal.	0
DBName	string	Nama database.	testdb01
SqlId	string	ID SQL.	a4111670e80596c5bf42cf5154438a91
ExecuteTime	string	Waktu eksekusi. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ`. Waktu ditampilkan dalam UTC.	2023-12-07T02:15:32Z
OriginTime	integer	Stempel waktu eksekusi. Nilai ini merupakan stempel waktu UNIX dalam milidetik.	1701886532000
AccountName	string	Akun database.	testname
HostAddress	string	Alamat IP client.	11.197.XX.XX
Consume	integer	Durasi eksekusi, dalam milidetik.	58
LockTime	integer	Waktu tunggu lock, dalam milidetik.	0
UpdateRows	integer	Jumlah baris yang diperbarui.	0
ScanRows	integer	Jumlah baris yang dipindai.	0
ReturnRows	integer	Jumlah baris yang dikembalikan.	0
LogicRead	integer	Jumlah logical read.	0
PhysicSyncRead	integer	Jumlah physical synchronous read.	0
PhysicAsyncRead	integer	Jumlah physical asynchronous read.	0
ThreadId	integer	ID thread.	None
TrxId	string	ID transaksi.	200000
Ext	string	Informasi tambahan. Ini adalah parameter cadangan.	None
Scnt	integer	Jumlah permintaan yang dikirim dari compute nodes (CNs) ke data nodes (DNs) untuk instans PolarDB-X 2.0.	10
Rows	integer	Jumlah total baris yang diperbarui atau dikembalikan oleh compute nodes pada instans database PolarDB-X 2.0.	10
Frows	integer	Jumlah baris yang ditarik oleh compute nodes (CNs) pada instans PolarDB-X 2.0.	10
TraceId	string	ID jejak instans PolarDB-X 2.0. Ini adalah ID eksekusi SQL pada data nodes.	14c93b7c7bf00000
UseImciEngine	string	Menunjukkan apakah Indeks Kolom dalam Memori (IMCI) digunakan untuk instans PolarDB for MySQL. Nilai yang valid: true false	true
ParallelDegree	string	Waktu antrian paralel untuk instans PolarDB for MySQL, dalam satuan milidetik.	10
ParallelQueueTime	string	Tingkat paralelisme instans PolarDB for MySQL.	2
PhysicRead	integer	Jumlah physical read.	0
CpuTime	integer	Waktu eksekusi CPU, dalam mikrodetik (us).	100
Writes	integer	Jumlah write untuk engine ApsaraDB RDS for SQL Server.	10
Collection	string	Parameter cadangan.	None
SqlCommand	integer	Perintah SQL dalam kueri.	sql
ConnectionId	string		ld-******
Protected	string		MySQL
Params	string		[1, "das"]
ClientIp	string		10.0.0.1xx
ClientPort	integer		3306
RowKey	string		23
AffectColumns	string		["col1"]
TableName	string		das
Export	string	URL unduhan tugas ekspor. Parameter ini hanya dikembalikan jika TaskType diatur ke Export.	"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****"

Nilai berikut didukung untuk parameter Key:

KeyWords: Kata kunci untuk kueri. Pisahkan beberapa kata kunci dengan spasi.
LogicalOperator: Operator logika yang digunakan antara kata kunci. Nilai yang valid: and dan or.
AccountName: Nama pengguna. Anda dapat menentukan hingga lima nama pengguna, dipisahkan dengan koma.
dbName: Nama database. Anda dapat menentukan hingga lima nama database, dipisahkan dengan koma.
HostAddress: Alamat IP klien. Anda dapat menentukan hingga lima alamat IP, dipisahkan dengan koma.
MaxConsume: Durasi eksekusi maksimum, dalam mikrodetik (µs).
MinConsume: Durasi eksekusi minimum, dalam mikrodetik (µs).
MaxScanRows: Jumlah maksimum baris yang dipindai.
MinScanRows: Jumlah minimum baris yang dipindai.
SqlType: Jenis pernyataan SQL. Nilai yang valid: select, update, insert, dan delete.
State: Status eksekusi. Nilai yang valid: 0 (berhasil) dan 1 (gagal).
ThreadId: ID thread.
SortKey: Kolom untuk mengurutkan hasil. Nilai yang valid: ScanRows (jumlah baris yang dipindai), UpdateRows (jumlah baris yang diperbarui), Consume (durasi eksekusi), ExecuteTime (waktu eksekusi), ReturnRows (jumlah baris yang dikembalikan), LockTime (waktu tunggu lock), Frows (jumlah baris yang ditarik oleh compute nodes pada instans PolarDB-X 2.0), Scnt (jumlah permintaan dari compute nodes ke data nodes untuk instans PolarDB-X 2.0), CpuTime (waktu eksekusi CPU), dan PhysicalRead (jumlah physical read).
SortMethod: Urutan pengurutan hasil. Nilai yang valid: DESC (menurun) dan ASC (menaik). Nilai default adalah DESC.
TraceId: ID jejak instans PolarDB-X 2.0.
MinRows: Jumlah minimum baris yang diperbarui.
MaxRows: Jumlah maksimum baris yang diperbarui.
MinScnt: Jumlah minimum permintaan dari compute nodes (CNs) ke data nodes (DNs) untuk instans PolarDB-X 2.0.
MaxScnt: Jumlah maksimum permintaan dari compute nodes (CNs) ke data nodes (DNs) untuk instans PolarDB-X 2.0.
TrxId: ID transaksi.
Fail: Kode kesalahan.
SqlId: ID SQL.

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "Name": "SQL审计导出1\n",
    "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/****\""
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.