更新时间:2024-05-07 GMT+08:00

查看API调用日志

ROMA Connect提供了API的可视化分析和统计能力,支持查看API的调用日志。

操作步骤

  1. 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
  2. 在左侧的导航栏选择“服务集成 APIC > 监控分析”。
  3. 开启日志分析。
    1. 在“日志分析”页签单击“配置访问日志”。
    2. 在配置访问日志弹窗配置日志接入信息,完成后单击“确定”。
      表1 配置访问日志

      参数

      说明

      启动日志记录

      选择是否启用日志记录,仅启用后才能查看API的调用日志。

      日志组

      选择日志流所在的日志组。

      如果没有可选的日志组,单击“查看日志组”,跳转到云日志服务管理控制台,并创建一个日志组,具体操作请参考创建日志组

      日志流

      选择API调用日志要存储的日志流。

      如果没有可选的日志流,单击“查看日志流”,跳转到云日志服务管理控制台,并创建一个日志流,具体操作请参考创建日志流

  4. 日志分析开启后,可以在界面上实时查看所有开放API的调用日志,日志字段说明请参见日志字段说明
    • 在界面右上角,可选择要查看的日志时间段范围。
    • 单击“查看详细日志”,可前往云日志服务控制台查看日志的详细信息和下载日志到本地。
      日志详情中的自定义字段说明:
      • _resource_id:ROMA Connect实例ID。
      • _service_type:来源服务。

日志字段说明

序号

字段

说明

1

remote_addr

客户端地址。

2

request_id

请求ID。

3

api_id

API ID。

4

user_id

当使用IAM认证访问时,请求方提供的项目ID。

5

app_id

当使用APP认证访问时,请求方提供的APP ID。

6

time_local

请求时间。

7

request_time

请求时延(单位:s)。

8

request_method

HTTP请求方法。

9

host

请求域名。

10

router_uri

请求URI。

11

server_protocol

请求协议。

12

status

响应状态码。

13

bytes_sent

响应大小(包含状态行、响应头、响应体),单位:字节。

14

request_length

请求长度(包含起始行、请求头、请求体),单位:字节。

15

http_user_agent

用户代理标识。

16

http_x_forwarded_for

X-Forwarded-For头。

17

upstream_addr

后端地址。

18

upstream_uri

后端URI。

19

upstream_status

后端响应状态码。

20

upstream_connect_time

与后端建立连接所用时间。

21

upstream_header_time

从开始与后端建立连接到从后端获取到首字节所用时间,单位秒。

22

upstream_response_time

从开始与后端建立连接到从后端获取到最后一个字节所用时间,单位秒。

23

region_id

可用区ID。

24

all_upstream_response_time

从开始与后端建立连接到从后端获取到最后一个字节所用时间,单位秒。发生重试时,为所用时间总和。

25

errorType

API请求的错误类型。

  • 0:非流控错误。
  • 1:流控错误。

26

auth_type

API认证类型。

27

access_model1

认证模式1。

28

access_model2

认证模式2,开启双重认证时,为自定义认证编号。

29

inner_time

APIC的内部处理时长,单位秒。

30

proxy_protocol_vni

VPC终端节点的虚拟网络标识。

31

proxy_protocol_vpce_id

VPC终端节点的ID。

32

proxy_protocol_addr

客户端源IP地址。

33

body_bytes_sent

API请求的Body体大小,单位字节。

34

api_name

API名称。

35

app_name

当使用APP认证访问时,请求方使用的APP名称。

36

provider_app_id

API所属的APP ID。

37

provider_app_name

API所属的APP名称。

38

custom_data_log1

用户自定义日志字段值1。

39

custom_data_log2

用户自定义日志字段值2。

40

custom_data_log3

用户自定义日志字段值3。

41

custom_data_log4

用户自定义日志字段值4。

42

custom_data_log5

用户自定义日志字段值5。

43

custom_data_log6

用户自定义日志字段值6。

44

custom_data_log7

用户自定义日志字段值7。

45

custom_data_log8

用户自定义日志字段值8。

46

custom_data_log9

用户自定义日志字段值9。

47

custom_data_log10

用户自定义日志字段值10。

48

response_source

请求响应来源。

  • local:APIG。
  • remote:后端服务。