All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeRunningLogRecords

    Document Center

    Tair (Redis® OSS-Compatible):DescribeRunningLogRecords

    Last Updated:Oct 13, 2026

    Queries the running logs of an ApsaraDB Tair (Redis® OSS-Compatible) database instance.

    Operation description

    For the corresponding console operation of this API, refer to Query running logs. The maximum call rate for DescribeRunningLogRecords is 100 calls per minute.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    kvstore:DescribeRunningLogRecords

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    r-bp1zxszhcgatnx****
    NodeId

    string

    No

    The ID of the node in the instance. Specify this parameter to query the running logs of a specific node.

    Note

    • This parameter is available only when the instance uses the read/write splitting or cluster architecture.

    • If you specify this parameter, you must also specify the CharacterType parameter.

    r-bp1zxszhcgatnx****-db-0
    StartTime

    string

    Yes

    The start time of the query. You can view the running logs generated within the last 72 hours. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

    2018-12-03T07:01Z
    EndTime

    string

    Yes

    The end time of the query. The end time must be later than the start time, and the time range cannot exceed one day. We recommend that you set the time range to one hour. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

    2018-12-03T08:01Z
    DBName

    string

    No

    The name of the database.

    0
    RoleType

    string

    No

    The role type of the data shard. Valid values:

    • master (default): primary node.

    • slave: secondary node.

    master
    PageSize

    integer

    No

    The maximum number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

    Valid values:

    • 30 :

      30 entries per page.

    • 50 :

      50 entries per page.

    • 100 :

      100 entries per page.

    30
    PageNumber

    integer

    No

    The page number. The value must be greater than 0 and less than or equal to the maximum value of the Integer data type. Default value: 1.

    1
    ResourceGroupId

    string

    No

    The ID of the resource group.

    rg-acfmyiu4ekp****
    CharacterType

    string

    No

    The shard type of the cluster instance. Valid values:

    • proxy: proxy node.

    • db: data node.

    • cs: config server node.

    Note

    If you specify this parameter, you must also specify the NodeId parameter.

    Valid values:

    • cs :

      Config server node.

    • proxy :

      Proxy node.

    • db :

      Data node.

    proxy
    QueryKeyword

    string

    No

    The keyword used to query the running logs.

    aof
    OrderType

    string

    No

    The sort order of the query results. Valid values:

    • asc: ascending order

    • desc: descending order

    asc

    Response elements

    Element

    Type

    Description

    Example

    object

    StartTime

    string

    The start time of the query.

    The time is in the YYYY-MM-DDTHH:mmZ format and displayed in UTC.

    2018-12-03T07:01Z
    RequestId

    string

    The ID of the request.

    093B8579-9264-43A0-ABA9-AA86****
    PageRecordCount

    integer

    The number of entries returned on the current page.

    5
    TotalRecordCount

    integer

    The total number of entries.

    5
    PageSize

    integer

    The maximum number of entries returned per page.

    30
    InstanceId

    string

    The instance ID.

    r-bp1zxszhcgatnx****
    Engine

    string

    The database engine.

    Redis
    PageNumber

    integer

    The current page number.

    1
    Items

    object

    LogRecords

    array<object>

    The log details.

    object

    CreateTime

    string

    The time when the log was generated. The time is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.

    2018-12-03T07:07:30Z
    InstanceId

    string

    The instance ID.

    r-bp1zxszhcgatnx****
    Content

    string

    The log content.

    CONFIG REWRITE executed with success.
    NodeId

    string

    The ID of the node.

    Note

    If the instance uses the standard architecture, this parameter returns (null).

    r-bp1zxszhcgatnx****-db-0

    Examples

    Success response

    JSON format

    {
  "StartTime": "2018-12-03T07:01Z",
  "RequestId": "093B8579-9264-43A0-ABA9-AA86****",
  "PageRecordCount": 5,
  "TotalRecordCount": 5,
  "PageSize": 30,
  "InstanceId": "r-bp1zxszhcgatnx****",
  "Engine": "Redis",
  "PageNumber": 1,
  "Items": {
    "LogRecords": [
      {
        "CreateTime": "2018-12-03T07:07:30Z",
        "InstanceId": "r-bp1zxszhcgatnx****",
        "Content": "CONFIG REWRITE executed with success.",
        "NodeId": "r-bp1zxszhcgatnx****-db-0"
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid.
    400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.
    404 InvalidDbInstanceId.NotFound Specified instance does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.