查询实例订阅信息 - ListSubscriptions
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
rds:instance:update |
write |
- |
- |
rds:instance:modify |
- |
URI
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
是
参数解释：
实例ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
offset
否
参数解释：
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。
约束限制：
不涉及。
取值范围：
必须为数字，不能为负数。
默认取值：
默认为0（偏移0条数据，表示从第一条数据开始查询）。
limit
否
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
1~100
默认取值：
10
publication_id
否
参数解释：
发布ID。
约束限制：
不涉及。
取值范围：
- 不为空则查询该发布下的订阅。
- 为空（null）则查询实例本地订阅。
默认取值：
null
is_cloud
否
参数解释：
订阅服务器来源。
约束限制：
不涉及。
取值范围：
- true：订阅服务器为云上实例。
- false：订阅服务器非云上实例。
- 不传该参数（null）：全部订阅。
默认取值：
null
publication_name
否
参数解释：
发布名（模糊匹配）。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
subscription_db_name
否
参数解释：
订阅数据库名（模糊匹配）。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
subscriptions
Array of objects
参数解释：
订阅列表。
详情请参见表3。
total_count
Integer
参数解释：
订阅数。
取值范围：
不涉及。
表3 subscriptions元素结构说明 名称
参数类型
说明
id
String
参数解释：
订阅ID。
取值范围：
不涉及。
status
String
参数解释：
订阅状态。
取值范围：
- normal：正常。
- abnormal：异常。
- creating：创建中。
- createfail：创建失败。
publication_id
String
参数解释：
发布ID。
取值范围：
不涉及。
publication_name
String
参数解释：
发布名称。
取值范围：
不涉及。
is_cloud
Boolean
参数解释：
订阅服务器来源。
取值范围：
- true：订阅服务器为云上实例。
- false：订阅服务器非云上实例。
subscription_database
String
参数解释：
目标数据库名。
取值范围：
不涉及。
subscription_type
String
参数解释：
订阅方式。
取值范围：
push：推送。
publication_subscription
Object
参数解释：
发布下的订阅信息。
详情请参见表4。
local_subscription
Object
参数解释：
本地订阅信息。
详情请参见表5。
job_schedule
Object
参数解释：
策略详情。
详情请参见表6。
表4 publication_subscription元素结构说明 名称
参数类型
说明
subscription_instance_name
String
参数解释：
订阅服务器名称。
取值范围：
不涉及。
subscription_instance_ip
String
参数解释：
订阅服务器IP。
取值范围：
不涉及。
subscription_instance_id
String
参数解释：
订阅实例ID。
取值范围：
不涉及。
表5 local_subscription元素结构说明 名称
参数类型
说明
publication_instance_id
String
参数解释：
发布服务器来源为云上实例时的发布实例ID。
取值范围：
不涉及。
publication_instance_name
String
参数解释：
发布服务器名称。
取值范围：
不涉及。
表6 job_schedule元素结构说明 名称
参数类型
说明
id
String
参数解释：
策略ID。
取值范围：
不涉及。
job_schedule_type
String
参数解释：
计划类型。
取值范围：
- automatically：SQL Server代理启动时自动启动。
- cpu_idle：CPU空闲时启动。
- recurring：重复执行。
- one_time：执行一次。
one_time_occurrence
Object
参数解释：
执行一次执行时间。
详情请参见表7。
frequency
Object
参数解释：
策略间隔周期。
详情请参见表8。
daily_frequency
Object
参数解释：
策略每日频率。
详情请参见表9。
duration
Object
参数解释：
策略有效期。
详情请参见表10。
表7 one_time_occurrence元素结构说明 名称
参数类型
说明
active_start_date
String
参数解释：
执行日期，格式：yyyy-MM-dd。
取值范围：
1990-01-01~2099-12-31
active_start_time
String
参数解释：
执行时间，格式：HH:mm:ss。
取值范围：
不涉及。
表8 frequency元素结构说明 名称
参数类型
说明
freq_type
String
参数解释：
策略频率类型。
取值范围：
- daily：按天。
- weekly：按周。
- monthly_day：按月、每月按天。
- monthly_week：按月、每月按周。
freq_interval
Integer
参数解释：
执行间隔。
取值范围：
1~99
freq_interval_weekly
Array of strings
参数解释：
每周执行哪几天。
取值范围：
策略频率类型为按周时返回该参数值，不为按周时不生效。
Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。
freq_interval_day_monthly
Integer
参数解释：
每月执行的日期。
取值范围：
策略频率类型为按月、每月按天时返回该参数值，不为按月、每月按天时不生效。
1~当月总天数，例如1~31。
freq_interval_monthly
String
参数解释：
当月按周执行哪几天。
取值范围：
策略频率类型为按月、每月按周时返回该参数值，不为按月、每月按周时不生效。
Sunday，Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，day，weekday，weekend。
freq_relative_interval_monthly
String
参数解释：
每月在哪周执行。
取值范围：
策略频率类型为按月、每月按周时返回该参数值，不为按月、每月按周时不生效。
first，second，third，fourth，last。
表9 daily_frequency元素结构说明 名称
参数类型
说明
freq_subday_type
String
参数解释：
每日频率类型。
取值范围：
- once：每日一次。
- multiple：每日多次。
active_start_time
String
参数解释：
每日第一次执行时间。每日频率类型为每日一次时，则只执行这一次，格式：HH:mm:ss。
取值范围：
不涉及。
active_end_time
String
参数解释：
最后一次执行时间，格式：HH:mm:ss。
取值范围：
每日执行多次时返回该参数值，每日执行一次时不生效。
freq_subday_interval
Integer
参数解释：
执行间隔。
取值范围：
每日执行多次时返回该参数值，每日执行一次时不生效。
1~99
freq_interval_unit
String
参数解释：
执行间隔的单位。
取值范围：
每日执行多次时返回该参数值，每日执行一次时不生效。
- second：秒。
- minute：分。
- hour：时。
- 正常响应样例
查询实例本地订阅：
{ "subscriptions": [ { "id": "5b7dfa4f-a16e-4588-9d4e-89353f823512", "status": "normal", "publication_id": "959d6fd2-c32f-47fe-a209-7fb6b261a6bb", "publication_name": "pub01", "is_cloud": true, "subscription_database": "tab01", "subscription_type": "push", "job_schedule": { "id": "eb1e69b9-afa3-4169-890e-9449752863d8", "job_schedule_type": "automatically", "one_time_occurrence": { }, "frequency": { }, "daily_frequency": { }, "duration": { } }, "local_subscription": { "publication_instance_id": "422dc09255994da0b40ead6d74af017ein04", "publication_instance_name": "rds-7941" } } ], "total_count": 1 }查询该发布下的订阅：{ "subscriptions": [ { "id": "b60c7d34-2541-4582-bb89-eed9fe81fcae", "status": "normal", "publication_id": "959d6fd2-c32f-47fe-a209-7fb6b261a6bb", "publication_name": "pub01", "is_cloud": true, "subscription_database": "tab01", "subscription_type": "push", "job_schedule": { "id": "eb1e69b9-afa3-4169-890e-9449752863d8", "job_schedule_type": "automatically", "one_time_occurrence": { }, "frequency": { }, "daily_frequency": { }, "duration": { } }, "publication_subscription": { "subscription_instance_id": "baaede94ce354dbfa8eeef7d99550ed4in04", "subscription_instance_name": "rds-31a2", "subscription_instance_ip": "192.168.0.135" } } ], "total_count": 1 } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
