Querying OpenAPI Calls
Function
This API is used to query OpenAPI calling records.
URI
GET /v1/{project_id}/openapi/called-records
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
limit | No | Integer | Page size. The default value is 1000, and the maximum value is 2000. |
called_url | No | String | URL of the calling records. Example: /v1/{project_id}/sdg/database/watermark/embed |
start_time | No | Long | Start time of the calling records (Unix timestamp in milliseconds). Example: 0 |
end_time | No | Long | End time of the calling records (Unix timestamp in milliseconds). Example: 1638515803572 |
marker | No | String | Marker of the next page. This parameter is not required for the first page. You need to set this parameter to a return value in the first page of the query results for the next page. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
total | Integer | Total number of API calls |
succeed | Integer | Number of successful calls |
failed | Integer | Number of failed calls |
openapi_called_records | Array of OpenApiCalledRecord objects | List of OpenAPI calls |
next_marker | String | Marker of the next page |
Parameter | Type | Description |
|---|---|---|
user_name | String | Name of the user that called the APIs |
user_id | String | ID of the user that called the APIs |
domain_name | String | Domain name of the API calls |
domain_id | String | Domain IDs of the API calls |
request_url | String | URL of the API calls |
request_method | String | HTTP request method |
response_code | String | HTTP request code |
fail_reason | String | Failure cause |
timestamp | Long | Time of the calls (Unix timestamp, in milliseconds) |
Status code: 400
Parameter | Type | Description |
|---|---|---|
error_code | String | Error Code |
error_msg | String | Error Message |
Example Requests
Querying OpenAPI Calls
GET /v1/{project_id}/openapi/called-records Example Responses
Status code: 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"
} Status code: 400
Invalid request
{
"error_code" : "dsc.40000011",
"error_msg" : "Invalid parameter"
} Status Codes
Status Code | Description |
|---|---|
200 | OK |
400 | Invalid request |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
