Help Center/ Database Security Service/ API Reference/ API/ Data Reports/ Obtaining SQL Distribution Statistics in a Specified Period
Updated on 2025-09-10 GMT+08:00

Obtaining SQL Distribution Statistics in a Specified Period

Function

This API is used to query the SQL distribution statistics in a specified period.

URI

POST /v1/{project_id}/audit/{instance_id}/statistics/trend/sql-type

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Specifies the project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user.

Constraints

N/A

Range:

The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters.

Default Value:

N/A

instance_id

Yes

String

Definition:

Instance ID. The value can be obtained from the ID field of the API for querying the instance list.

Constraints

N/A

Range:

The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters.

Default Value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range:

The value is subject to the user token query interface of the IAM service.

Default Value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

db_id

No

String

The database record ID.

regenerate

Yes

Integer

Regenerate

  • 1: yes

  • 0: no

time

Yes

Duration object

Query time range. time_range takes precedence over start_time/end_time.

Table 4 Duration

Parameter

Mandatory

Type

Description

end_time

No

String

End time

start_time

No

String

Start time

time_range

No

String

time_range

  • HALF_HOUR: half an hour

  • HOUR: 1 hour

  • THREE_HOUR: 3 hours

  • TWELVE_HOUR: 12 hours

  • DAY: 1 day

  • WEEK: 1 week

  • MONTH: 1 month

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

generate_time

String

Created

sql_statistics

Array of SQLStatisticsBean objects

SQL statistics

status

String

Alarm status.

  • FINISHED: completed

  • RUNNING: The instance is running.

Table 6 SQLStatisticsBean

Parameter

Type

Description

delete_num

Long

Number of deleted items.

insert_num

Long

Number of inserted items.

other_num

Long

Number of other items.

period

String

Period

select_num

Long

Number of queried items.

update_num

Long

Number of updated items.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 8 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 10 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 11 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 12 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 14 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v1/{project_id}/audit/{instance_id}/statistics/trend/sql-type

{
  "regenerate" : 0,
  "time" : {
    "time_range" : "HOUR"
  }
}

Example Responses

Status code: 200

OK

{
  "status" : "finished",
  "generate_time" : "2025-08-20 07:58:58",
  "sql_statistics" : [ {
    "period" : "2025-08-19 17:03:52",
    "update_num" : 0,
    "insert_num" : 0,
    "delete_num" : 0,
    "select_num" : 0,
    "other_num" : 0
  }, {
    "period" : "2025-08-19 18:07:44",
    "update_num" : 0,
    "insert_num" : 0,
    "delete_num" : 0,
    "select_num" : 0,
    "other_num" : 0
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.