Adds the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.
Operation description
- Custom field limits: The key name of a custom field can contain only letters, digits, underscores (_), and spaces. The key name cannot contain other characters. Otherwise, errors may occur.
- Parameter passing: Submit
SiteId,RequestHeaders,ResponseHeaders, andCookiesby usingformData. Each array element matches a custom field name. - (Required) SiteId: Although
SiteIdis not marked as required in the Required column, you must specify a website ID by using this parameter when you can call this API operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| esa:CreateSiteCustomLog | none | *Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SiteId | long | No | The website ID, which can be obtained by calling the ListSites operation. | 11223 |
| RequestHeaders | array | No | The request header fields. | |
| string | No | The request header field. | x-acs-request-id | |
| ResponseHeaders | array | No | The response header fields. | |
| string | No | The response header field. | X_Swift_Error | |
| Cookies | array | No | The cookie fields. | |
| string | No | The cookie field. | sessionId |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "073bd613-6e72-4461-b6bc-19326dfc6a9c"
}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. |
| 403 | RealTimeLog.RegexpCheckFail | Invalid characters exist in your parameter configurations. Check your configurations and try again. | Invalid characters exist in your parameter configurations. Check your configurations and try again. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-27 | The Error code has changed | View Change Details |
