查询OpenApi调用记录
功能介绍
查询OpenApi调用记录
URI
GET /v1/{project_id}/openapi/called-records
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 分页大小，默认1000，最大2000。 |
| called_url | 否 | String | 需要查询调用记录的URL，例如：/v1/{project_id}/sdg/database/watermark/embed。 |
| start_time | 否 | Long | 开始时间（Unix timestamp），单位：毫秒，例如：0 |
| end_time | 否 | Long | 结束时间（Unix timestamp），单位：毫秒，例如：1638515803572 |
| marker | 否 | String | 指定一个标识符。获取第一页时不用赋值，获取下一页时取上页查询结果的返回值。 |
请求参数
无
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 调用API总次数 |
| succeed | Integer | 调用API成功次数 |
| failed | Integer | 调用API失败次数 |
| openapi_called_records | Array of OpenApiCalledRecord objects | API调用记录列表 |
| next_marker | String | 获取下一页所需的标识符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| user_name | String | 调用API的user_name |
| user_id | String | 调用API的user_id |
| domain_name | String | 调用API的domain_name |
| domain_id | String | 调用API的domain_id |
| request_url | String | 调用API的URL |
| request_method | String | http请求方法 |
| response_code | String | http状态码 |
| fail_reason | String | 调用API失败原因 |
| timestamp | Long | 调用API的时间（Unix timestamp），单位：毫秒 |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
请求示例
查询OpenAPI调用记录
GET /v1/{project_id}/openapi/called-records 响应示例
状态码： 200
OK
{
"total" : 11,
"succeed" : 11,
"failed" : 0,
"openapi_called_records" : [ {
"user_name" : "xxxxxxxxxxxxx",
"user_id" : "xxxxxxxxxxxxxxxxx",
"domain_name" : "xxxxxxxxxxxxxxxxx",
"domain_id" : "xxxxxxxxxxxxxxxxxxx",
"request_url" : "/v1/xxxxxxxxxxxxxxxxxxxxxxxxxxx/sdg/doc/watermark/embed",
"request_method" : "POST",
"response_code" : "200",
"fail_reason" : "",
"timestamp" : 1638427576524
} ],
"next_marker" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
} 状态码： 400
无效请求
{
"error_code" : "dsc.40000011",
"error_msg" : "Invalid parameter"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | 无效请求 |
错误码
请参见错误码。
