GetSiteCustomLog - 获取自定义日志字段

更新时间:
复制 MD 格式

查询指定站点的自定义日志字段配置详情。

接口说明

  • 功能描述:此接口用于获取指定站点 ID(SiteId)下的自定义日志字段配置信息,包括请求头、响应头及 Cookie 中的自定义字段。

  • 使用场景:当需要在日志分析中引用特定的 HTTP 头或 Cookie 信息时,可通过此接口获取已配置的自定义日志字段列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

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

自定义字段配置 Configid。

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

示例

正常返回示例

JSON格式

{
  "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 status code

错误码

错误信息

描述

400 InvalidParameter The specified parameter is invalid. 输入参数规范校验失败。
400 InternalError An internal exception occurred, please try again later. 触发内部异常,请稍后再试。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情