DescribeReadDBInstanceDelay - ApsaraDB RDS - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBInstanceId	string	Yes	The primary instance ID. You can call the DescribeDBInstances operation to query the primary instance ID.	rm-bp*****
ReadInstanceId	string	Yes	The read-only instance ID. You can call the DescribeDBInstances operation to query the read-only instance ID.	rr-bp*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
DBInstanceId	string	The primary instance ID.	rm-bp*****
RequestId	string	The request ID.	F1BDDEA8-452D-450B-AB10-CD5C5BAFC5DF
DelayTime	integer	The latency of data replication. Unit: seconds.	0
ReadDBInstanceId	string	The read-only instance ID.	rr-bp*****
Items	array<object>	The latency information.
	object
DBInstanceId	string	The primary instance ID.	rm-bp*****
ReadonlyInstanceDelay	array<object>	The information about the write-ahead log (WAL) latency. Note This parameter is returned only when the primary instance runs PostgreSQL.
	object
WriteLatency	string	The data size that is allowed for the latency in the write-back of WAL data. Unit: MB.	0
FlushLatency	string	The data size that is allowed for the latency in the persistence of WAL data. Unit: MB.	0
ReadDBInstanceName	string	The read-only instance ID.	rr-bp*****
WriteLag	string	The duration that is allowed for the latency in the write-back of WAL data. Unit: seconds.	0
FlushLag	string	The duration that is allowed for the latency in the persistence of WAL data. Unit: seconds.	0
SendLatency	string	The data size that is allowed for the latency in the sending of WAL data. Unit: MB.	0
ReplayLag	string	The duration that is allowed for the latency in the playback of WAL data. Unit: seconds.	0
ReplayLatency	string	The data size that is allowed for the latency in the playback of WAL data. Unit: MB.	0
ReadDelayTimes	array	The latency of data replication.
	string	The consumption latency. Note This parameter is returned only when the primary instance runs MySQL.	0
ReadDBInstanceNames	array	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 time	Summary of changes	Operation
2022-06-17	The internal configuration of the API is changed, but the call is not affected	View Change Details