文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 发布订阅（SQL Server）/ 查询实例可选发布 - ListPublications4Subscription
更新时间：2025-11-21 GMT+08:00
查看PDF
分享

查询实例可选发布 - ListPublications4Subscription

功能介绍

查询实例可选的RDS for SQL Server实例的发布。

调试

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

授权信息

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

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:update

write

-

-

rds:instance:modify

-

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/replication/publication-candidates

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

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

    约束限制：

    非空。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

publication_instance_id

否

String

参数解释：

发布实例ID。若不为空，优先查该实例下的发布。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

publication_instance_name

否

String

参数解释：

发布实例名称（模糊匹配）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

publication_name

否

String

参数解释：

发布名称（模糊匹配）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

不涉及。

取值范围：

必须为数字，不能为负数。

默认取值：

默认为0（偏移0条数据，表示从第一条数据开始查询）。

limit

否

Integer

参数解释：

查询记录数。

约束限制：

不涉及。

取值范围：

1~1000

默认取值：

10

请求示例

查询实例可选的RDS for SQL Server实例的发布。

POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/publication-candidates

{
    "limit": 1000,
    "offset": 0,
    "publication_instance_name": "rds"
}

响应消息

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

    名称

    参数类型

    说明

    instance_publications

    Array of objects

    参数解释：

    实例发布列表。

    详情请参见表4

    取值范围：

    不涉及

    total_count

    Integer

    参数解释：

    发布总数。

    取值范围：

    不涉及
    表4 instance_publications元素结构说明

    名称

    参数类型

    说明

    instance_id

    String

    参数解释：

    实例id。

    取值范围：

    不涉及

    instance_name

    String

    参数解释：

    实例名称。

    取值范围：

    不涉及

    publication_id

    String

    参数解释：

    发布id。

    取值范围：

    不涉及

    publication_name

    String

    参数解释：

    发布名称。

    取值范围：

    不涉及
  • 正常响应样例 
    {
    "instance_publications": [
        {
            "instance_id": "422dc09255994da0b40ead6d74af017ein04",
            "instance_name": "rds-7941",
            "publication_id": "959d6fd2-c32f-47fe-a209-7fb6b261a6bb",
            "publication_name": "pub01"
        }
    ],
    "total_count": 1
}

状态码

错误码

请参见错误码。

相关文档