QueryRequestLogs - 获取请求日志_API 网关-阿里云帮助中心

查询用户的请求日志记录。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RequestLogId	string	是	请求requestId	95657ED9-2F6F-426F-BD99-79C8********

返回参数

名称	类型	描述	示例值
	object	返回内容
RequestId	string	请求id	CE5722A6-AE78-4741-A9B0-6C81********
RequestLogs	array	请求日志集合
	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********

示例

正常返回示例

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": "",
        "FrontRequestStart": 0,
        "FrontRequestEnd": 0,
        "BackendRequestStart": 0,
        "BackendRequestEnd": 0,
        "BackendResponseStart": 0,
        "BackendResponseEnd": 0,
        "FrontResponseStart": 0,
        "FrontResponseEnd": 0
      }
    ]
  }
}

错误码

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