DescribeSQLPatterns - AnalyticDB

Anda dapat memanggil operasi DescribeSQLPatterns untuk melihat daftar pola SQL pada kluster AnalyticDB for MySQL pada tanggal tertentu.

Deskripsi operasi

Titik akhir publik: adb.aliyuncs.com.
Titik akhir publik untuk wilayah: adb.<region-id>.aliyuncs.com. Contoh: adb.cn-hangzhou.aliyuncs.com.
Titik akhir VPC untuk wilayah: adb-vpc.<region-id>.aliyuncs.com. Contoh: adb-vpc.cn-hangzhou.aliyuncs.com.

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

adb:DescribeSQLPatterns

list

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster. Catatan Panggil operasi DescribeDBClusters untuk mengkueri detail semua kluster AnalyticDB for MySQL di wilayah tertentu, termasuk ID kluster.	am-bp1r053byu48p****
StartTime	string	Yes	Awal rentang waktu untuk dikueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Catatan Data dari 14 hari terakhir dapat dikueri. Misalnya, jika waktu saat ini adalah 2021-11-22T12:00:00Z, waktu paling awal yang dapat dikueri adalah 2021-11-09T12:00:00Z. Interval antara waktu mulai dan waktu akhir tidak boleh melebihi 24 jam.	2021-09-30T00:10:00Z
EndTime	string	Yes	Akhir rentang waktu untuk dikueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Catatan Waktu akhir harus lebih lambat dari waktu mulai.	2021-09-30T00:15:00Z
RegionId	string	Yes	ID wilayah. Catatan Panggil operasi DescribeRegions untuk mengkueri wilayah dan zona tempat AnalyticDB for MySQL tersedia, termasuk ID wilayah.	cn-hangzhou
Keyword	string	No	Kata kunci SQL.	SELECT
Order	string	Yes	Urutan pengurutan hasil kueri. Tentukan nilai sebagai string JSON. Contoh: `[{"Field":"AverageQueryTime","Type":"Asc"}]`. `Field` menentukan bidang yang digunakan untuk pengurutan. Nilai yang valid: `PatternCreationTime`: Waktu pengiriman paling awal dari pola SQL dalam rentang waktu tersebut. `AverageQueryTime`: Waktu total rata-rata dari pola SQL dalam rentang waktu tersebut. `MaxQueryTime`: Waktu total maksimum dari pola SQL dalam rentang waktu tersebut. `AverageExecutionTime`: Durasi eksekusi rata-rata dari pola SQL dalam rentang waktu tersebut. `MaxExecutionTime`: Durasi eksekusi maksimum dari pola SQL dalam rentang waktu tersebut. `AveragePeakMemory`: Penggunaan memori puncak rata-rata dari pola SQL dalam rentang waktu tersebut. `MaxPeakMemory`: Penggunaan memori puncak maksimum dari pola SQL dalam rentang waktu tersebut. `AverageScanSize`: Jumlah data yang dibaca rata-rata oleh pola SQL dalam rentang waktu tersebut. `MaxScanSize`: Jumlah data yang dibaca maksimum oleh pola SQL dalam rentang waktu tersebut. `QueryCount`: Jumlah eksekusi pola SQL dalam rentang waktu tersebut. `FailedCount`: Jumlah eksekusi gagal dari pola SQL dalam rentang waktu tersebut. `Type` menentukan metode pengurutan. Nilainya tidak peka huruf besar/kecil. Nilai yang valid: `Asc`: urutan menaik. `Desc`: urutan menurun.	[{"Field":"AverageQueryTime","Type":"Asc"}]
PageNumber	integer	No	Nomor halaman. Nilainya harus berupa bilangan bulat yang lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data integer. Catatan Nilai default-nya adalah 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 30 50 100 Catatan Nilai default-nya adalah 30.	30
Lang	string	No	Bahasa judul file dan beberapa pesan kesalahan dalam file yang diunduh. Nilai yang valid: zh: Bahasa Tionghoa Sederhana. Ini adalah nilai default. en: Bahasa Inggris. ja: Bahasa Jepang. zh-tw: Bahasa Tionghoa Tradisional.	zh
UserName	string	No	Username.	test_user

Elemen respons

Element	Type	Description	Example
	object	Daftar informasi.
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri pada halaman saat ini.	30
TotalCount	integer	Jumlah total entri.	1
PatternDetails	array<object>	Detail pola SQL.
	object	Daftar pola SQL.
SQLPattern	string	Pernyataan pola SQL.	SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)
PatternId	string	ID pola SQL.	5575924945138******
User	string	Username akun database yang mengirimkan pernyataan SQL terkait pola tersebut.	reporter
AccessIp	string	Alamat IP client yang mengirimkan pernyataan SQL terkait pola tersebut.	192.168.xx.xx
Tables	string	Nama tabel database yang dipindai oleh pola SQL.	tpch.orders
PatternCreationTime	string	Waktu pengiriman paling awal dari pola SQL dalam rentang waktu tersebut. Satuan: milidetik.	2021-11-12 03:06:00
AverageQueryTime	number	Waktu total rata-rata dari pola SQL dalam rentang waktu tersebut. Satuan: milidetik.	4
MaxQueryTime	integer	Waktu total maksimum dari pola SQL dalam rentang waktu tersebut. Satuan: milidetik.	2341
AverageExecutionTime	number	Durasi eksekusi rata-rata dari pola SQL dalam rentang waktu tersebut. Satuan: milidetik.	234.78
MaxExecutionTime	integer	Durasi eksekusi maksimum dari pola SQL dalam rentang waktu tersebut. Satuan: milidetik.	2142
AveragePeakMemory	number	Penggunaan memori puncak rata-rata dari pola SQL dalam rentang waktu tersebut. Satuan: byte.	234.22
MaxPeakMemory	integer	Penggunaan memori puncak maksimum dari pola SQL dalam rentang waktu tersebut. Satuan: byte.	234149
AverageScanSize	number	Jumlah data yang dipindai rata-rata oleh pola SQL dalam rentang waktu tersebut. Satuan: byte.	234149.23
MaxScanSize	integer	Jumlah data yang dipindai maksimum oleh pola SQL dalam rentang waktu tersebut. Satuan: byte.	234149
QueryCount	integer	Jumlah eksekusi pola SQL dalam rentang waktu tersebut.	345
FailedCount	integer	Jumlah eksekusi gagal dari pola SQL dalam rentang waktu tersebut.	234
Blockable	boolean	Menunjukkan apakah eksekusi pola SQL dapat diblokir. Nilai yang valid: true: Eksekusi dapat diblokir. false: Eksekusi tidak dapat diblokir. Catatan Saat ini, AnalyticDB for MySQL hanya mendukung pemblokiran pernyataan Select dan Insert.	true
QueryTimeSum	number	Waktu total. Satuan: milidetik.	5
QueryTimePercentage	number	Proporsi waktu total satu pola SQL terhadap waktu total semua pola SQL dalam rentang waktu tersebut. Satuan: %.	10
PeakMemorySum	number	Total penggunaan memori puncak. Satuan: byte.	5
PeakMemoryPercentage	number	Proporsi total penggunaan memori puncak. Satuan: %.	10
ScanSizeSum	number	Total jumlah data yang dipindai. Satuan: byte.	5
ScanSizePercentage	number	Proporsi total jumlah data yang dipindai. Satuan: %.	80
AverageOperatorCost	number	Biaya CPU rata-rata. Satuan: milidetik.	5
MaxOperatorCost	number	Biaya CPU maksimum. Satuan: milidetik.	5
OperatorCostSum	number	Total biaya CPU. Satuan: milidetik.	5
OperatorCostPercentage	number	Proporsi total biaya CPU. Satuan: %.	20
AverageScanCost	number	Biaya CPU rata-rata untuk pemindaian tabel. Satuan: milidetik.	5
MaxScanCost	number	Biaya CPU maksimum untuk pemindaian tabel. Satuan: milidetik.	5
ScanCostSum	number	Total jumlah data yang dipindai, dalam byte.	5
ScanCostPercentage	number	Proporsi total biaya pemindaian data. Satuan: %.	5
RequestId	string	ID permintaan.	6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******

Contoh

Respons sukses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "PatternDetails": [
    {
      "SQLPattern": "SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)",
      "PatternId": "5575924945138******",
      "User": "reporter",
      "AccessIp": "192.168.xx.xx",
      "Tables": "tpch.orders",
      "PatternCreationTime": "2021-11-12 03:06:00",
      "AverageQueryTime": 4,
      "MaxQueryTime": 2341,
      "AverageExecutionTime": 234.78,
      "MaxExecutionTime": 2142,
      "AveragePeakMemory": 234.22,
      "MaxPeakMemory": 234149,
      "AverageScanSize": 234149.23,
      "MaxScanSize": 234149,
      "QueryCount": 345,
      "FailedCount": 234,
      "Blockable": true,
      "QueryTimeSum": 5,
      "QueryTimePercentage": 10,
      "PeakMemorySum": 5,
      "PeakMemoryPercentage": 10,
      "ScanSizeSum": 5,
      "ScanSizePercentage": 80,
      "AverageOperatorCost": 5,
      "MaxOperatorCost": 5,
      "OperatorCostSum": 5,
      "OperatorCostPercentage": 20,
      "AverageScanCost": 5,
      "MaxScanCost": 5,
      "ScanCostSum": 5,
      "ScanCostPercentage": 5
    }
  ],
  "RequestId": "6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.