文档首页/ 云数据库 RDS/ API参考/ API v3(推荐)/ 发布订阅(SQL Server)/ 查询发布监控信息 - CollectPublicationMonitor
更新时间:2025-11-21 GMT+08:00
分享

查询发布监控信息 - CollectPublicationMonitor

功能介绍

查询当前实例的发布监控信息。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:update

write

-

-

rds:instance:modify

-

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释:

    租户在某一region下的project ID。

    获取方法请参见获取项目ID

    约束限制:

    非空。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    instance_id

    参数解释:

    实例ID。

    约束限制:

    非空。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    publication_id

    参数解释:

    发布ID。

    约束限制:

    非空。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求消息

  • 请求参数

    无。

  • URI样例

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

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    status

    String

    参数解释:

    发布关联的快照代理的运行状态。

    取值范围:

    • started:已启动。
    • succeeded:成功。
    • in_progress:正在运行。
    • idle:空闲。
    • retrying:重试中。
    • failed:失败。

    worst_latency

    Integer

    参数解释:

    数据更改的最长延迟时间(以秒为单位)。

    取值范围:

    不涉及。

    best_latency

    Integer

    参数解释:

    数据更改的最短延迟时间(以秒为单位)。

    取值范围:

    不涉及。

    average_latency

    Integer

    参数解释:

    数据更改的平均延迟时间(以秒为单位)。

    取值范围:

    不涉及。

    last_dist_sync

    String

    参数解释:

    上一次分发代理运行时间,格式:yyyy-mm-ddThh:mm:ssZ。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

    取值范围:

    不涉及。

    replicated_transactions

    Integer

    参数解释:

    等待传送到分发数据库的事务数。

    取值范围:

    不涉及。

    replication_rate_trans

    Double

    参数解释:

    平均每秒传送到分发数据库的事务数。

    取值范围:

    不涉及。

  • 正常响应样例
    {
        "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
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档