Referensi API DescribeSearchTemplates - ActionTrail - Alibaba Cloud - ActionTrail

Mengkueri templat kueri lanjutan untuk skenario tertentu.

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

actiontrail:DescribeSearchTemplates

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SceneId	string	Yes	ID skenario.	sc-lpYrjKouRfy3MK-wteJW_Q
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah maksimum entri yang akan dikembalikan. Nilai default: 20.	20

Elemen respons

Element	Type	Description	Example
	object
PageNumber	integer	The page number.	1
PageSize	integer	The maximum number of results returned. Default value: 20.	20
RequestId	string	The request ID.	787DD24A-E322-5C0D-A730-057FE62B****
TemplateList	array<object>	The list of template details.
	object
Charts	string	The list of dashboards. This parameter is deprecated. Catatan This parameter is deprecated and no longer returns valid data. The returned value is always an empty array `[]`. Stop using this parameter and remove its dependency from your code.	[]
Description	string	The template description.	Events of Console Logons by Using Cloud Account
Params	string	The filter conditions. This parameter is returned as a JSON-serialized string that contains a structured list of filter conditions. Use a standard JSON deserialization tool for your programming language to parse the string into an array of objects.	[{"key":"event.eventName","value":"ConsoleSignin","type":"system","display":true,"displayKey":"event.eventName","displayValue":"ConsoleSignin","displayValueEn":"ConsoleSignin"},{"oper":"AND","key":"event.userIdentity.type","value":"root-account","type":"system","display":true,"displayKey":"event.userIdentity.type","displayValueEn":"Alibaba Cloud Account"}]
SceneId	string	The scenario ID.	sc-lpYrjKouRfy3MK-wteJW_Q
Sql	string	The query statement.	select "event.userIdentity.accountId" as account_id, count(1) as cnt group by account_id limit 1000
TemplateId	string	The template ID.	tpl-wCZAFWx3Spq6CO9Ymp****
TemplateName	string	The template name.	Events of Console Logons by Using Cloud Account
Token	string	The identifier for the template category.	identity.rootLogin
Type	string	The template type.	audit

Contoh

Respons sukses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 20,
  "RequestId": "787DD24A-E322-5C0D-A730-057FE62B****",
  "TemplateList": [
    {
      "Charts": "[]",
      "Description": "Events of Console Logons by Using Cloud Account",
      "Params": "[{\"key\":\"event.eventName\",\"value\":\"ConsoleSignin\",\"type\":\"system\",\"display\":true,\"displayKey\":\"event.eventName\",\"displayValue\":\"ConsoleSignin\",\"displayValueEn\":\"ConsoleSignin\"},{\"oper\":\"AND\",\"key\":\"event.userIdentity.type\",\"value\":\"root-account\",\"type\":\"system\",\"display\":true,\"displayKey\":\"event.userIdentity.type\",\"displayValueEn\":\"Alibaba Cloud Account\"}]",
      "SceneId": "sc-lpYrjKouRfy3MK-wteJW_Q",
      "Sql": "select \"event.userIdentity.accountId\" as account_id, count(1) as cnt group by account_id limit 1000",
      "TemplateId": "tpl-wCZAFWx3Spq6CO9Ymp****",
      "TemplateName": "Events of Console Logons by Using Cloud Account",
      "Token": "identity.rootLogin",
      "Type": "audit"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.