DescribeResourceLogFieldConfig API リファレンス - 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:DescribeResourceLogFieldConfig

get

*All Resource

*

acs:ResourceGroupId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 WAF インスタンスの ID をクエリするには、DescribeInstance 操作を呼び出してください。	waf_v3prepaid_public_cn-zpr3*******
DeliveryType	string	必須	ログ配信タイプ。有効な値： sls：Alibaba Cloud Simple Log Service。 kafka：ログを Kafka に配信します。 syslog：ログを Syslog に配信します。	sls
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfm***q
RegionId	string	任意	WAF インスタンスがデプロイされているリージョン。有効な値： cn-hangzhou：中国本土。 ap-southeast-1：中国本土以外。	cn-hangzhou
Resource	string	必須	クエリする保護対象オブジェクト。	test.waf.com-waf

レスポンスフィールド

フィールド	型	説明	例
	object
AddList	string	デフォルトのログフィールドに追加で構成されるログフィールドです。フィールドは、コンマ区切りの文字列で指定されます。	acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type
RequestId	string	リクエスト ID。	7B53B47C-D368-5344-BB5E-79******
LogDeliveryStrategy	string	ログ配信ポリシー。複数のポリシーがサポートされています。値は、パラメーターの JSON 配列から変換された文字列です。説明パラメーターの詳細については、「ModifyResourceLogFieldConfig」の LogDeliveryStrategy パラメーターの説明をご参照ください。	[{\"logType\":\"blockLog\",\"rate\":100},{\"logType\":\"normalRequestLog\",\"rate\":100},{\"logType\":\"checkLog\",\"rate\":100}]
ExtendConfig	string	ログ配信の拡張構成。値は、パラメーターの JSON オブジェクトから変換された文字列です。説明パラメーターの詳細については、「ModifyResourceLogFieldConfig」の ExtendConfig パラメーターの説明をご参照ください。	{\"request_header\":\"Ali-Cdn-Real-Ip\"}
DelList	string	デフォルトのログフィールドから削除されるログフィールドです。フィールドは、コンマ区切りの文字列で指定されます。	waf_rule_id,waf_rule_type
FieldList	string	配信されるログフィールドのリストです。フィールドは、コンマ区切りの文字列で指定されます。	account,acl_action,acl_rule_id,acl_rule_type,acl_test,antiscan_action,antiscan_rule_id,antiscan_rule_type,antiscan_test,body_bytes_sent,bypass_matched_ids
DeliveryType	string	ログ配信タイプ。有効な値： sls：Alibaba Cloud Simple Log Service。 kafka：ログを Kafka に配信します。 syslog：ログを Syslog に配信します。	sls

例

成功レスポンス

JSONJSON

{
  "AddList": "acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type",
  "RequestId": "7B53B47C-D368-5344-BB5E-79******",
  "LogDeliveryStrategy": "[{\\\"logType\\\":\\\"blockLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"normalRequestLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"checkLog\\\",\\\"rate\\\":100}]",
  "ExtendConfig": "{\\\"request_header\\\":\\\"Ali-Cdn-Real-Ip\\\"}",
  "DelList": "waf_rule_id,waf_rule_type",
  "FieldList": "account,acl_action,acl_rule_id,acl_rule_type,acl_test,antiscan_action,antiscan_rule_id,antiscan_rule_type,antiscan_test,body_bytes_sent,bypass_matched_ids",
  "DeliveryType": "sls"
}

エラーコード

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

変更履歴

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