All Products
Search

This Product

    ApsaraDB RDS:DescribeReadDBInstanceDelay

    Document Center

    ApsaraDB RDS:DescribeReadDBInstanceDelay

    Last Updated:Apr 17, 2024

    Queries the latency of data replication between a primary instance and its read-only instance.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:DescribeReadDBInstanceDelayREAD
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    DBInstanceIdstringYes

    The primary instance ID. You can call the DescribeDBInstances operation to query the primary instance ID.

    		rm-bp*****
    ReadInstanceIdstringYes

    The read-only instance ID. You can call the DescribeDBInstances operation to query the read-only instance ID.

    		rr-bp*****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    DBInstanceIdstring

    The primary instance ID.

    		rm-bp*****
    RequestIdstring

    The request ID.

    		F1BDDEA8-452D-450B-AB10-CD5C5BAFC5DF
    DelayTimeinteger

    The latency of data replication. Unit: seconds.

    		0
    ReadDBInstanceIdstring

    The read-only instance ID.

    		rr-bp*****
    Itemsobject []

    The latency information.

    DBInstanceIdstring

    The primary instance ID.

    		rm-bp*****
    ReadonlyInstanceDelayobject []

    The information about the write-ahead log (WAL) latency.

    Note This parameter is returned only when the primary instance runs PostgreSQL.
    WriteLatencystring

    The data size that is allowed for the latency in the write-back of WAL data. Unit: MB.

    		0
    FlushLatencystring

    The data size that is allowed for the latency in the persistence of WAL data. Unit: MB.

    		0
    ReadDBInstanceNamestring

    The read-only instance ID.

    		rr-bp*****
    WriteLagstring

    The duration that is allowed for the latency in the write-back of WAL data. Unit: seconds.

    		0
    FlushLagstring

    The duration that is allowed for the latency in the persistence of WAL data. Unit: seconds.

    		0
    SendLatencystring

    The data size that is allowed for the latency in the sending of WAL data. Unit: MB.

    		0
    ReplayLagstring

    The duration that is allowed for the latency in the playback of WAL data. Unit: seconds.

    		0
    ReplayLatencystring

    The data size that is allowed for the latency in the playback of WAL data. Unit: MB.

    		0
    ReadDelayTimesarray

    The latency of data replication.

    string

    The consumption latency.

    Note This parameter is returned only when the primary instance runs MySQL.
    		0
    ReadDBInstanceNamesarray

    An array that consists of information about the read-only instance.

    string

    The read-only instance name.

    Note This parameter is returned only when the primary instance runs MySQL.
    		rr-bp*****

    Examples

    Sample success responses

    JSONformat

    {
  "DBInstanceId": "rm-bp*****",
  "RequestId": "F1BDDEA8-452D-450B-AB10-CD5C5BAFC5DF",
  "DelayTime": 0,
  "ReadDBInstanceId": "rr-bp*****",
  "Items": {
    "Items": [
      {
        "DBInstanceId": "rm-bp*****",
        "ReadonlyInstanceDelay": {
          "ReadonlyInstanceDelay": [
            {
              "WriteLatency": "0",
              "FlushLatency": "0",
              "ReadDBInstanceName": "rr-bp*****",
              "WriteLag": "0",
              "FlushLag": "0",
              "SendLatency": "0",
              "ReplayLag": "0",
              "ReplayLatency": "0"
            }
          ]
        },
        "ReadDelayTimes": {
          "ReadDelayTime": [
            "0"
          ]
        },
        "ReadDBInstanceNames": {
          "ReadDBInstanceName": [
            "rr-bp*****"
          ]
        }
      }
    ]
  }
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2022-06-17The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.