GetSiteCustomLog API リファレンス（カスタムログフィールド設定用） - Edge Security Acceleration

サイトのカスタムログフィールドの構成を照会します。

操作説明

説明：この操作を呼び出して、リクエストヘッダー、レスポンスヘッダー、Cookie 内のカスタムフィールドを含む、サイトのカスタムログフィールドの構成を照会できます。
シナリオ：ログ分析のために特定の HTTP ヘッダーまたは Cookie 情報を取得する必要がある場合に、この操作を呼び出します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:GetSiteCustomLog

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイト ID。ListSites 操作を呼び出すことで取得できます。	11223***

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	6befa4aa-2a94-4f51-a245-295787192d2c
SiteId	integer	サイト ID。	167026711***
ConfigId	integer	カスタムログフィールド構成の ID。	6befa4aa-2a94-4f51-a245-295787192d2c
LogCustomField	object	カスタムフィールド。
RequestHeaders	array	リクエストヘッダーフィールド。
	string	リクエストヘッダー。	x-acs-request-id
ResponseHeaders	array	レスポンスヘッダーフィールド。
	string	レスポンスヘッダー。	X_Swift_Error
Cookies	array	Cookie フィールド。
	string	Cookie。	sessionId
IsExist	boolean	カスタム構成が存在するかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "6befa4aa-2a94-4f51-a245-295787192d2c",
  "SiteId": 0,
  "ConfigId": 0,
  "LogCustomField": {
    "RequestHeaders": [
      "x-acs-request-id"
    ],
    "ResponseHeaders": [
      "X_Swift_Error"
    ],
    "Cookies": [
      "sessionId"
    ]
  },
  "IsExist": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The specified parameter is invalid.
400	InternalError	An internal exception occurred, please try again later.

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

変更履歴

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