GetSiteCustomLog API Reference for Custom Log Field Configuration - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Operation description

Description: Queries the custom log field configuration for a website, including custom fields in request headers, response headers, and cookies.
Scenarios: Retrieve specific HTTP header or cookie information for log analysis.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:GetSiteCustomLog

none

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The website ID, which can be obtained by calling the ListSites operation.	11223***

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6befa4aa-2a94-4f51-a245-295787192d2c
SiteId	integer	The website ID.	167026711***
ConfigId	integer	The ID of the custom log field configuration.	6befa4aa-2a94-4f51-a245-295787192d2c
LogCustomField	object	The custom fields.
RequestHeaders	array	The request header fields.
	string	The request header.	x-acs-request-id
ResponseHeaders	array	The response header fields.
	string	The response header.	X_Swift_Error
Cookies	array	The cookie fields.
	string	The cookie.	sessionId
IsExist	boolean	Indicates whether the custom configuration exists.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalError	An internal exception occurred, please try again later.	An inner exception was triggered. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.