Querying Monitoring Information of a Publication

Function

This API is used to query monitoring information of a DB instance's publication.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:instance:update	write	-	-	rds:instance:modify	-

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/replication/publications/{publication_id}/monitor

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints The value cannot be empty. Range N/A Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range N/A Default Value N/A
publication_id	Yes	Definition Publication ID. Constraints The value cannot be empty. Range N/A Default Value N/A

Request

Request parameters
None
URI example
GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/publications/8c2b39b8-4480-4181-a37e-20d2f267b95e/monitor

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
status	String	Definition Status of the snapshot agent associated with the publication. Range started succeeded in_progress idle retrying failed
worst_latency	Integer	Definition Maximum latency for data changes, in seconds. Range N/A
best_latency	Integer	Definition Minimum latency for data changes, in seconds. Range N/A
average_latency	Integer	Definition Average latency for data changes, in seconds. Range N/A
last_dist_sync	String	Definition Last run time of the distribution agent. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800. Range N/A
replicated_transactions	Integer	Definition Number of transactions in the log awaiting delivery to the distribution database. Range N/A
replication_rate_trans	Double	Definition Average number of transactions delivered per second to the distribution database. Range N/A

Example normal response

{
    "status": "idle",
    "last_dist_sync": "2025-11-04T03:51:54+0000",
    "worst_latency": 30,
    "best_latency": 2,
    "average_latency": 16,
    "replicated_transactions": 0,
    "replication_rate_trans": 62.5
}