DescribeSearchTemplates API リファレンス - ActionTrail

指定されたシナリオの高度なクエリテンプレートを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

actiontrail:DescribeSearchTemplates

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SceneId	string	必須	シナリオ ID。	sc-lpYrjKouRfy3MK-wteJW_Q
PageNumber	integer	任意	ページ番号。デフォルト値：1。	1
PageSize	integer	任意	返すエントリの最大数。デフォルト値：20。	20

レスポンスフィールド

フィールド	型	説明	例
	object
PageNumber	integer	ページ番号。	1
PageSize	integer	返される結果の最大数。デフォルト値：20。	20
RequestId	string	リクエスト ID。	787DD24A-E322-5C0D-A730-057FE62B****
TemplateList	array<object>	テンプレート詳細のリスト。
	object
Charts	string	ダッシュボードのリスト。このパラメーターは非推奨です。説明このパラメーターは非推奨であり、有効なデータを返さなくなりました。返される値は常に空の配列 `[]` です。このパラメーターの使用を停止し、コードからその依存関係を削除してください。	[]
Description	string	テンプレートの説明。	Events of Console Logons by Using Cloud Account
Params	string	フィルター条件。このパラメーターは、フィルター条件の構造化リストを含む JSON 形式でシリアル化された文字列として返されます。お使いのプログラミング言語の標準的な JSON 逆シリアル化ツールを使用して、文字列をオブジェクトの配列に解析してください。	[{"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	シナリオ ID。	sc-lpYrjKouRfy3MK-wteJW_Q
Sql	string	クエリ文。	select "event.userIdentity.accountId" as account_id, count(1) as cnt group by account_id limit 1000
TemplateId	string	テンプレート ID。	tpl-wCZAFWx3Spq6CO9Ymp****
TemplateName	string	テンプレート名。	Events of Console Logons by Using Cloud Account
Token	string	テンプレートカテゴリの識別子。	identity.rootLogin
Type	string	テンプレートタイプ。	audit

例

成功レスポンス

JSONJSON

{
  "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"
    }
  ]
}

エラーコード

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

変更履歴

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