DescribeCommonLogFields API の WAF ログフィールド - WAF

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-waf:DescribeCommonLogFields

list

*All Resource

*

acs:ResourceGroupId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 WAF インスタンスの ID をクエリするには、DescribeInstance を呼び出します。	waf_v3prepaid_public_cn-l*****
IsRequired	boolean	任意	必須のログフィールドをクエリするかどうかを指定します。 true：必須のログフィールドをクエリします。 false：必須ではないログフィールドをクエリします。	false
IsDefault	boolean	任意	デフォルトのログフィールドをクエリするかどうかを指定します。 true：デフォルトのログフィールドをクエリします。 false：デフォルトではないログフィールドをクエリします。	true
LogKeyList	array	任意	クエリするログフィールドのリスト。
	string	任意	クエリするログフィールド。	final_action
RegionId	string	任意	WAF インスタンスが存在するリージョン。有効な値： cn-hangzhou：中国本土。 ap-southeast-1：中国本土以外。	cn-hangzhou
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-aek2sxgs*****

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	ログフィールドの総数。	6
RequestId	string	リクエスト ID。	AB0775EB-2594-598A-97E1-51B1*******
LogFieldList	array<object>	ログフィールドのリスト。
	object	ログフィールドの詳細。
Status	boolean	ログフィールドのステータス。有効な値： 0：オフライン。 1：オンラインまたは使用中。 2：公開終了予定。 3：公開予定。	1
IsDefault	boolean	ログフィールドがデフォルトフィールドであるかどうかを示します。 true：ログフィールドはデフォルトフィールドです。 false：ログフィールドはデフォルトフィールドではありません。	true
IsRequired	boolean	ログフィールドが必須であるかどうかを示します。 true：ログフィールドは必須です。 false：ログフィールドは必須ではありません。	true
LogKey	string	ログフィールド。説明ログフィールドの詳細については、「ログフィールドの説明」をご参照ください。	final_action

例

成功レスポンス

JSONJSON

{
  "TotalCount": 6,
  "RequestId": "AB0775EB-2594-598A-97E1-51B1*******",
  "LogFieldList": [
    {
      "Status": true,
      "IsDefault": true,
      "IsRequired": true,
      "LogKey": "final_action"
    }
  ]
}

エラーコード

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

変更履歴

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