AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页 API 网关 原API网关 开发参考 API参考指南 API目录 日志 QueryRequestLogs - 获取请求日志

QueryRequestLogs - 获取请求日志

更新时间：
复制为 MD 格式
产品详情
我的收藏

查询用户的操作日志记录。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:QueryRequestLogs

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RequestLogId

string

是

请求 requestId

95657ED9-2F6F-426F-BD99-79C8********

返回参数

名称

类型

描述

示例值

object

返回内容

RequestId

string

请求 id

CE5722A6-AE78-4741-A9B0-6C81********
RequestLogs

object

RequestLog

array<object>

请求日志集合

object

请求日志

ApiId

string

API 的 ID

4b83229ebcab4ecd88956fb3********
ApiName

string

API 名称

ApiName
ConsumerAppKey

string

调用方的 App Key

20412****
TotalLatency

string

总耗时，单位：ms

1345
HttpMethod

string

请求使用的 HTTP 方法

POST
Domain

string

请求的域名

360bdd88695c48ae8085c7f2********-ap-southeast-1.alicloudapi.com
ErrorMessage

string

调用失败时，返回的出错信息。

Backend service connect failed `Timeout connecting to [/1XX.20.0.XX:8080]`
ConsumerAppId

string

调用者应用 ID

11096****
InstanceId

string

API 服务所在的网关实例 ID

apigateway-bj-ab2b********
ClientNonce

string

客户端 X-Ca-Nonce 头

d43df9db-3b05-4cd6-888a-1c0b********
RequestSize

string

请求大小，单位：字节

1923
StageId

string

API 环境 ID

8a305b7f10334052a52d9156********
StageName

string

API 环境名称

RELEASE
HttpPath

string

请求的 PATH

/testPath
RequestId

string

请求 ID

95657ED9-2F6F-426F-BD99-79C8********
GroupId

string

API 的分组 ID

dc024277fe6c4cada79ba0bd6********
GroupName

string

API 分组名称

GroupName
ErrorCode

string

错误码

X500ER
ResponseSize

string

返回数据大小，单位：字节

23441
Region

string

区域

cn-hangzhou
StatusCode

string

请求状态码

200
ClientIp

string

调用者客户端 IP

21.237.XXX.XXX
ServiceLatency

string

访问后端资源耗时总和，包括申请连接资源耗时，建立连接耗时，调用后端服务耗时，单位：毫秒

324
RequestTime

string

请求时间，UTC

2022-10-29T03:59:59Z
Exception

string

后端返回的具体错信息

error msg
CustomTraceId

string

自定义 API 调用链 id

95657ED9-2F6F-426F-BD99-79C8********
JwtClaims

string

从 JWT 中解析出来的 Claim，可以在分组上配置

{}
RequestProtocol

string

客户端请求协议：HTTP/HTTPS/WS

HTTP
RequestHeaders

string

客户端请求的 header 内容

content-type: application/x-www-form-urlencoded
RequestQueryString

string

客户端请求的 queryString

username=name
RequestBody

string

客户端请求的 body 内容，最多 1024 个字节

param=paramName
ResponseHeaders

string

API 响应的 header 内容

content-type: application/x-www-form-urlencoded

ResponseBody

string

API 响应的 response 内容，最多 1024 个字节

param=paramName

plugin

string

API 请求命中的插件列表及相关上下文

[]
InitialRequestId

string

API 网关自调用时，例如 API-1 调用 API-2 ，那么 API-2 的日志中会用 initialRequestId 来记录 API-1 的 requestid

95657ED9-2F6F-426F-BD99-79C8********
AppName

string

APP 名称

VIPROOM_VIPROOM
FrontRequestStart

integer

API 网关开始接收到客户端请求的时间点

1731487224968
FrontRequestEnd

integer

API 网关完成接收客户端请求的时间点

1731487224968
BackendRequestStart

integer

API 网关开始向后端服务发起请求的时间点

1731487224969
BackendRequestEnd

integer

API 网关完成向后端服务发起请求的时间点

1731487224969
BackendResponseStart

integer

API 网关开始接收到后端服务响应的时间点

1731487224989
BackendResponseEnd

integer

API 网关完成接收后端服务响应的时间点

1731487224989
FrontResponseStart

integer

API 网关开始向客户端发送响应的时间点

1731487224989
FrontResponseEnd

integer

API 网关完成向客户端发送响应的时间点

1731487224989

示例

正常返回示例

JSON格式

{
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C81********",
  "RequestLogs": {
    "RequestLog": [
      {
        "ApiId": "4b83229ebcab4ecd88956fb3********",
        "ApiName": "ApiName",
        "ConsumerAppKey": "20412****",
        "TotalLatency": "1345",
        "HttpMethod": "POST",
        "Domain": "360bdd88695c48ae8085c7f2********-ap-southeast-1.alicloudapi.com",
        "ErrorMessage": "Backend service connect failed `Timeout connecting to [/1XX.20.0.XX:8080]`",
        "ConsumerAppId": "11096****",
        "InstanceId": "apigateway-bj-ab2b********",
        "ClientNonce": "d43df9db-3b05-4cd6-888a-1c0b********",
        "RequestSize": "1923",
        "StageId": "8a305b7f10334052a52d9156********",
        "StageName": "RELEASE",
        "HttpPath": "/testPath",
        "RequestId": "95657ED9-2F6F-426F-BD99-79C8********",
        "GroupId": "dc024277fe6c4cada79ba0bd6********",
        "GroupName": "GroupName",
        "ErrorCode": "X500ER",
        "ResponseSize": "23441",
        "Region": "cn-hangzhou",
        "StatusCode": "200",
        "ClientIp": "21.237.XXX.XXX",
        "ServiceLatency": "324",
        "RequestTime": "2022-10-29T03:59:59Z",
        "Exception": "error msg",
        "CustomTraceId": "95657ED9-2F6F-426F-BD99-79C8********",
        "JwtClaims": "{}",
        "RequestProtocol": "HTTP",
        "RequestHeaders": "content-type: application/x-www-form-urlencoded",
        "RequestQueryString": "username=name",
        "RequestBody": "param=paramName",
        "ResponseHeaders": "content-type: application/x-www-form-urlencoded\n",
        "ResponseBody": "param=paramName\n",
        "plugin": "[]",
        "InitialRequestId": "95657ED9-2F6F-426F-BD99-79C8********",
        "AppName": "VIPROOM_VIPROOM",
        "FrontRequestStart": 1731487224968,
        "FrontRequestEnd": 1731487224968,
        "BackendRequestStart": 1731487224969,
        "BackendRequestEnd": 1731487224969,
        "BackendResponseStart": 1731487224989,
        "BackendResponseEnd": 1731487224989,
        "FrontResponseStart": 1731487224989,
        "FrontResponseEnd": 1731487224989
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：ModifyLogConfig - 修改日志配置下一篇：DescribeLogConfig - 获取日志配置