doc-exports/docs/rds/api-ref/rds_06_0102.html

Querying Slow Query Log Files (SQL Server)

Function

This API is used to query slow query log files.

• Before calling an API, you need to understand the API in Authentication.
• Before calling this API, obtain the required region and endpoint.

Constraints

This API is available only for Microsoft SQL Server.

URI

• URI format

  GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog-files?offset={offset}&limit={limit}

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Type	Description
  project_id	Yes	String	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  instance_id	Yes	String	Specifies the DB instance ID.
  offset	No	Integer	Index offset. The query starts from the next piece of data indexed by this parameter. The value must be a non-negative number. The default value is 0, indicating that the query starts from the first data record.
  limit	No	Integer	Number of records to be queried. The value ranges from 1 (inclusive) to 100 (inclusive). The default value is 10.

Request

• Request parameters

  Table 2 Request header parameters

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. The user token is a response to the API used to obtain a user token.

• URI example

  GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog-files

Response

• Normal response

  Table 3 Parameter description

  Name	Type	Description
  list	Array of objects	Slow log file information. For details, see Table 4.
  total_count	Integer	Total number of files.

  Table 4 SlowLogFile field data structure description

  Parameter	Type	Description
  file_name	String	File name.
  file_size	String	File size in bytes.

• Example normal response

  {
    "total_count" : 1,
    "list" : [ {
      "file_name" : "SQLTrace.trc",
      "file_size" : "1024"
    } ]
  }

• Abnormal Response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Log Information Queries