查询实例发布信息
调试
您可以在API Explorer中调试该接口。
URI
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
是
参数解释：
实例ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
offset
否
参数解释：
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。
约束限制：
不涉及。
取值范围：
必须为数字，不能为负数。
默认取值：
默认为0（偏移0条数据，表示从第一条数据开始查询）。
limit
否
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
1~100
默认取值：
默认为10。
publication_name
否
参数解释：
发布名（模糊匹配）。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
publication_db_name
否
参数解释：
发布数据库名（模糊匹配）。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
subscriber_instance_id
否
参数解释：
订阅实例ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
publications
Array of objects
参数解释：
实例发布列表。
详情请参见表3。
total_count
Integer
参数解释：
实例发布数。
取值范围：
不涉及。
表3 publications元素结构说明 名称
参数类型
说明
id
String
参数解释：
发布ID。
取值范围：
不涉及。
status
String
参数解释：
发布状态。
取值范围：
- normal：正常。
- abnormal：异常。
- creating：创建中。
- modifying：修改中。
- createfail：创建失败。
publication_name
String
参数解释：
发布名。
取值范围：
不涉及。
publication_database
String
参数解释：
发布数据库名。
取值范围：
不涉及。
subscription_count
Integer
参数解释：
订阅数。
取值范围：
不涉及。
subscription_options
Object
参数解释：
订阅选项。
详情请参见表4。
job_schedule
Object
参数解释：
策略详情。
详情请参见表5。
is_select_all_table
Boolean
参数解释：
是否选择所有数据表。
取值范围：
- true：选择所有数据表。
- false：不选择所有数据表。
extend_tables
Array of strings
参数解释：
全选所有表后需要去除的表。
取值范围：
不涉及。
tables
Array of objects
参数解释：
发布数据表。
详情请参见表10。
表4 subscription_options元素结构说明 名称
参数类型
说明
independent_agent
Boolean
参数解释：
独立的分发代理。
取值范围：
- true：使用。
- false：不使用。
snapshot_always_available
Boolean
参数解释：
快照始终可用。需要开启“独立的分发代理”。
取值范围：
- true：可用。
- false：不可用。
replicate_ddl
Boolean
参数解释：
复制架构更改。
取值范围：
- true：可更改。
- false：不可更改。
allow_initialize_from_backup
Boolean
参数解释：
允许使用备份文件初始化。
取值范围：
- true：允许。
- false：不允许。
表5 job_schedule元素结构说明 名称
参数类型
说明
id
String
参数解释：
策略ID。
取值范围：
仅支持OBS或BACKUP。
job_schedule_type
String
参数解释：
计划类型。
取值范围：
- automatically：SQL Server代理启动时自动启动。
- cpu_idle：CPU空闲时启动。
- recurring：重复执行。
- one_time：执行一次。
one_time_occurrence
Object
参数解释：
执行一次执行时间。
详情请参见表6。
frequency
Object
参数解释：
策略间隔周期。仅当策略ID为空时生效。
详情请参见表7。
daily_frequency
Object
参数解释：
策略每日频率。仅当策略ID为空时生效。
详情请参见表8。
duration
Object
参数解释：
策略有效期。仅当策略ID为空时生效。
详情请参见表9。
表6 one_time_occurrence元素结构说明 名称
参数类型
说明
active_start_date
String
参数解释：
执行日期，格式：yyyy-MM-dd。
取值范围：
1990-01-01~2099-12-31
active_start_time
String
参数解释：
执行时间，格式：HH:mm:ss。
取值范围：
不涉及。
表7 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。
表8 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：时。
表9 duration元素结构说明 名称
参数类型
说明
active_start_date
String
参数解释：
第一次执行日期，格式：yyyy-MM-dd。
取值范围：
1990-01-01~2099-12-31
active_end_date
String
参数解释：
最后一次执行日期，默认不会结束，格式：yyyy-MM-dd。
取值范围：
不涉及。
表10 tables元素结构说明 名称
参数类型
说明
table_name
String
参数解释：
表名。
取值范围：
不涉及。
schema
String
参数解释：
命名空间。
取值范围：
不涉及。
columns
Array of strings
参数解释：
发布的字段。
取值范围：
不涉及。
primary_key
Array of strings
参数解释：
主键。
取值范围：
不涉及。
filter_statement
String
参数解释：
筛选语句。
取值范围：
不涉及。
filter
Object
参数解释：
筛选器。
详情请参见表11。
article_properties
Object
参数解释：
项目属性。
详情请参见表12。
表11 filter元素结构说明 名称
参数类型
说明
relation
String
参数解释：
筛选关系。为空时表示当前为最下级筛选器，不为空时表示当前项还有下级筛选器。
取值范围：
不涉及。
column
String
参数解释：
筛选字段。
取值范围：
不涉及。
condition
String
参数解释：
筛选条件。
取值范围：
不涉及。
value
String
参数解释：
筛选值。
取值范围：
不涉及。
filters
Array of objects
参数解释：
下级筛选器。
详情请参见表11。
表12 article_properties元素结构说明 名称
参数类型
说明
destination_object_name
String
参数解释：
目标对象名称。
取值范围：
不涉及。
destination_object_owner
String
参数解释：
目标对象命名空间。
取值范围：
不涉及。
insert_delivery_format
String
参数解释：
插入交付格式。
取值范围：
- do_not_insert：不执行插入语句。
- insert：执行插入语句。
- insert_without_column_list：插入语句字段保持原来顺序。
- call_procedure：执行存储过程传递所有列的所有值。
insert_stored_procedure
String
参数解释：
插入存储过程。
取值范围：
不涉及。
update_delivery_format
String
参数解释：
更新交付格式。
取值范围：
- do_not_update：不执行更新语句。
- update：执行更新语句。
- call_procedure：执行存储过程传递所有列的所有值。
- mcall_procedure：执行存储过程只传递受影响列的值，它还包含一个表示已更改列的位掩码。
- xcall_procedure：执行存储过程传递所有列（无论是否受影响）以及每列的旧数据值。
- scall_procedure：执行存储过程只传递受更新实际影响的列的值。
update_stored_procedure
String
参数解释：
更新存储过程。
取值范围：
不涉及。
delete_delivery_format
String
参数解释：
删除交付格式。
取值范围：
- do_not_delete：不执行删除语句。
- delete：执行删除语句。
- call_procedure：执行存储过程传递所有列的所有值。
- xcall_procedure：执行存储过程传递所有列（无论是否受影响）以及每列的旧数据值。
delete_stored_procedure
String
参数解释：
删除存储过程。
取值范围：
不涉及。
- 正常响应样例
{ "publications": [ { "id": "942d9062-4fb9-48ce-bfe1-15655560ad56", "status": "normal", "publication_name": "pub001", "publication_database": "db01", "subscription_count": 1, "subscription_options": { "independent_agent": true, "snapshot_always_available": true, "replicate_ddl": true, "allow_initialize_from_backup": true }, "job_schedule": { "id": "3d85677d-e0c7-4a19-a2b6-106589ecd151", "job_schedule_type": "recurring", "frequency": { "freq_type": "weekly", "freq_interval": 1, "freq_interval_weekly": [ "Sunday" ] }, "daily_frequency": { "freq_subday_type": "once", "active_start_time": "02:00:00" }, "duration": { "active_start_date": "1990-01-01", "active_end_date": "2099-12-31" } }, "is_select_all_table": false, "extend_tables": [ ], "tables": [ { "table_name": "tab02", "schema": "dbo", "columns": [ ], "primary_key": [ "id" ], "article_properties": { "destination_object_name": "tab02", "destination_object_owner": "dbo", "insert_delivery_format": "call_procedure", "insert_stored_procedure": "sp_MSins_dbotab02", "update_delivery_format": "scall_procedure", "update_stored_procedure": "sp_MSupd_dbotab02", "delete_delivery_format": "call_procedure", "delete_stored_procedure": "sp_MSdel_dbotab02" } } ] } ], "total_count": 1 } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
