Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Managed Service for SQL Server™
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Information about existing clusters
    • Creating clusters
    • Connecting to databases
    • Stopping and starting clusters
    • Changing cluster and database settings
    • Managing SQL Server hosts
    • Managing databases
    • Managing users
    • Granting permissions and roles
    • Managing backups
    • Deleting clusters
  • Concepts
    • Relationship between service resources
    • Host classes
    • Networks in Managed Service for SQL Server
    • Quotas and limits
    • Storage types
    • Backups
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • BackupService
      • ClusterService
      • DatabaseService
      • ResourcePresetService
      • UserService
      • OperationService
    • REST
      • Overview
      • Backup
        • Overview
        • get
        • list
      • Cluster
        • Overview
        • backup
        • create
        • delete
        • get
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • move
        • restore
        • start
        • stop
        • update
      • Database
        • Overview
        • create
        • delete
        • get
        • list
      • ResourcePreset
        • Overview
        • get
        • list
      • User
        • Overview
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
      • Operation
        • Overview
        • get
  • Questions and answers
    • General questions
  1. API reference
  2. REST
  3. Cluster
  4. listLogs

Method listLogs

  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Retrieves logs for the specified SQL Server cluster.

For more information about logs, see the Logs section in the documentation.

HTTP request

GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1alpha/clusters/{clusterId}:logs

Path parameters

Parameter Description
clusterId Required. ID of the SQL Server cluster to request logs for. To get the SQL Server cluster ID, use a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
columnFilter Columns from the logs table to request. If no columns are specified, entire log records are returned.
serviceType Type of the service to request logs about.
  • SQLSERVER_ERROR: SQL Server error log.
  • SQLSERVER_APPLICATION: SQL Server application log.
fromTime Start timestamp for the logs request. String in RFC3339 text format.
toTime End timestamp for the logs request. String in RFC3339 text format.
pageSize The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
alwaysNextPageToken Always return next_page_token, even if current page is empty.
filter A filter expression that filters resources listed in the response. The expression must specify: 1. The field name to filter by. Currently filtering can be applied to the [LogRecord.logs.message.hostname] field. 2. A conditional operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. Must be 1-63 characters long and match the regular expression ^[a-z0-9.-]{1,61}$. Examples of a filter: message.hostname='node1.db.cloud.yandex.net' The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "logs": [
    {
      "timestamp": "string",
      "message": "object"
    }
  ],
  "nextPageToken": "string"
}
Field Description
logs[] object

Requested log records.

logs[].
timestamp
string (date-time)

Log record timestamp.

String in RFC3339 text format.

logs[].
message
object

Contents of the log record.

nextPageToken string

Token that allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the next_page_token as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC