DescribeAdvancedQueryTemplate で保存されたクエリテンプレートを取得 - 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:DescribeAdvancedQueryTemplate

list

*AdvancedQueryTemplate

acs:actiontrail:{#regionId}:{#accountId}:advancedquerytemplate/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TemplateName	string	任意	テンプレートの名前です。部分的な名前を入力して、一致するすべてのテンプレートを取得できます。値が複数のテンプレート名の一部に一致する場合、一致するすべてのテンプレートのリストが返されます。名前を指定しない場合、利用可能なすべてのテンプレートが返されます。例：入力：a。出力：[a1, a2]。入力：`` (入力なし)。出力：[a1, a2, b1, c1]。	example-template
PageNumber	integer	任意	テンプレートリストのページ番号です。値は 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	返す結果の最大数です。デフォルト値：20。	20

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	1EC1FDC7-6D01-559F-852C-30D86E9EEB3F
TemplatePage	object	ページ分割されたテンプレートリストです。
PageNumber	string	テンプレートリストのページ番号です。	1
PageSize	string	返す結果の最大数です。デフォルト値：20。	20
TemplateList	array<object>	テンプレートの詳細リストです。
	object
SimpleQuery	boolean	シンプルクエリモードが有効かどうかを示します。	false
TemplateId	string	テンプレート ID です。	utpl-7OaxbyJATDaoLOgZRc****
TemplateName	string	テンプレート名です。	example-template
TemplateSql	string	検索文です。	event.userIdentity.type: root-account AND event.userIdentity.accessKeyId: *
Total	integer	レコードの総数です。	5

例

成功レスポンス

JSONJSON

{
  "RequestId": "1EC1FDC7-6D01-559F-852C-30D86E9EEB3F",
  "TemplatePage": {
    "PageNumber": "1",
    "PageSize": "20",
    "TemplateList": [
      {
        "SimpleQuery": false,
        "TemplateId": "utpl-7OaxbyJATDaoLOgZRc****",
        "TemplateName": "example-template",
        "TemplateSql": "event.userIdentity.type: root-account AND event.userIdentity.accessKeyId: *"
      }
    ],
    "Total": 5
  }
}

エラーコード

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

変更履歴

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