REST API支持以下连接器管理操作:
- 检索源元数据
- 创建一个连接器
- 检索连接器详细信息
- 修改连接器
- SYNC连接器数据
- 重新同步连接器表数据
- 运行连接器设置测试
- 删除连接器
- 检索连接器模式配置
- 检索源表列配置
- 重新加载连接器模式配置
- 修改连接器模式配置
- 修改连接器数据库模式配置
- 修改连接器表配置
- 修改连接器列配置
- 用例:根据现有连接器的参数创建一个新的连接器
- 用例:如何仅为您需要的列启用同步
- 用例:如何设置自定义同步频率
- 用例:如何设置日常同步的时间
- 用例:如何仅在需要时手动触发同步
检索源元数据链接
返回您的Fivetran帐户中所有可用的源类型。这个端点使得在应用程序中显示Fivetran连接器变得更容易,因为它提供了元数据,包括正确的源名称(' Facebook Ad Account '而不是facebook_ad_account)、源图标和指向Fivetran资源的链接。当我们更新源名称和图标时,该元数据将在此端点中自动更新。
要求链接
获取api.www.miaplace.com/v1/metadata/connectors.
查询参数
名称 | 描述 |
---|---|
光标 |
寻呼光标。阅读更多信息在我们的文档中分页 |
限制 |
要获取的记录数量,可接受1 ... 1000范围内的数字。默认值为100 |
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“项目”:[{“ID”:“facebook_ad_account”那“名称”:“Facebook广告帐户”那“类型”:“营销”那“描述”:“Facebook广告账户提供Facebook广告账户属性数据”那“icon_url”:“//www.miaplace.com/integrations/facebook/resources/facebook.svg”那“link_to_docs”:“//www.miaplace.com/docs/pplications/facebook-ad-account”那“link_to_erd”:“//www.miaplace.com/docs/pplications/facebook-ad-account#schemainformation”}),“next_cursor”:“eyjza2lwijoxmdb9”}}
名称 | 描述 |
---|---|
项目 |
描述其元数据的连接器类型的集合。 |
ID |
Fivetran系统中的连接器服务标识符。 |
名称 |
Fivetran系统中的连接器服务名称。 |
类型 |
连接器服务类型 |
描述 |
描述表征连接器目的的说明。 |
icon_url. |
图标资源URL |
link_to_docs. |
连接器文档的链接。 |
link_to_erd |
连接器ERD(实体关系图)的链接。 |
next_cursor. |
价值光标 下一页的参数。 |
创建一个连接器链接
在FiveTran帐户中的指定组中创建一个新连接器。运行安装测试并返回测试结果。
要求链接
帖子api.www.miaplace.com/v1/connectors
{“服务”:“criteo”那“group_id”:“projected_sickle”那“trust_certificates”:真正的那“run_setup_tests”:真正的那“暂停”:真正的那“pause_after_trial”:真正的那“sync_frequency”:1440那“daily_sync_time”:“03:00那“配置”:{“架构”:“criteo”那“用户名”:“myuser”那“密码”:“我的密码”那“app_token”:“myapptoken”},“auth”:{“client_access”:{“client_id”:“my_client_id”那“client_secret”:“my_client_secret”},“refresh_token”:“my_refresh_token”}}
有效载荷参数
名称 | 描述 |
---|---|
group_id. (必需的) |
Fivetran系统内的组的唯一标识符。找你group_id. 取回你的账户组列表. |
服务 (必需的) |
Fivetran系统中连接器类型的名称。 |
配置 (必需的) |
连接器安装配置。格式是特定的每个连接器. |
身份验证 |
连接器授权设置。可用于使用外部客户端凭据对连接器进行授权。格式是特定的每个连接器. |
停顿了一下 |
指定连接器是否暂停。 |
pause_after_trial. |
指定连接器是否应该在免费试用期结束后暂停。如果请求中省略了此参数,则使用默认值错误的 . |
trust_certificates |
指定我们是否应该自动信任证书。仅适用于数据库连接器。默认值是错误的 .如果证书不自动信任,则必须批准证书管理API批准连接器证书. |
trust_fingerrints. |
指定是否应该自动信任SSH指纹。仅适用于数据库连接器。默认值是错误的 .如果指纹不受自动信任,则必须批准证书管理API批准连接器指纹. |
run_setup_tests |
指定是否应该自动运行安装测试。默认值是真正的 . |
sync_fruquency. |
连接器同步频率在分钟内。支持的值是:5. 那15. 那30. 那60. 那120. 那180. 那360. 那480. 那720. 那1440 . |
daily_sync_time. |
定义同步频率已经设置或由当前请求设置的同步开始时间的可选参数1440 .它可以在一小时内指定从00:00 到23:00 .如果没有指定,我们将使用基线同步开始时间.此参数对此没有影响0到60分钟偏移量用于确定实际同步开始时间。 |
响应链接
HTTP 201创建了
{“代码”:“成功”那“信息”:“已创建连接器”那“数据”:{“ID”:“speak_inexpense”那“group_id”:“projected_sickle”那“服务”:“criteo”那“service_version”:0.那“架构”:“criteo”那“暂停”:真正的那“pause_after_trial”:真正的那“connected_by”:“Interment_Burdensome”那“created_at”:“2018-12-01T15:43:29.013729z”那“成功_at”:零那“failed_at”:零那“sync_frequency”:1440那“daily_sync_time”:“03:00那“地位”:{“setup_state”:“不完整”那“sync_state”:“计划”那“update_state”:“按照时间表”那“is_historical_sync”:真正的那“任务”:[],“警告”:[]},“setup_tests”:[{“标题”:“验证登录”那“地位”:“失败的”那“信息”:“无效的登录凭证”}],“配置”:{“用户名”:“myuser”那“密码”:“* * * * * *”那“api_token”:“* * * * * *”那“service_version”:“0”}}}
如果run_setup_tests
被设置为错误的
在请求中,响应不会包含setup_tests
场地。
看到如何基于现有连接器的参数创建新连接器.
请注意配置
参数可以以V2配置格式呈现。有关更多信息,请参阅我们的检索连接器详细信息端点文档.
检索连接器详细信息链接
如果提供有效标识符,则返回连接器对象。
目前,连接器配置响应负载支持两种格式。第一个是配置的默认遗留格式。第二个是我们在2021年1月引入的新配置格式(v2)。
要以v2格式检索连接器配置信息,则应添加版本= 2
到了接受
请求标题:- 主人'接受:application / json;版本= 2'
V2配置格式与用于的配置有效载荷参数一致修改连接器.
连接器配置响应取决于连接器类型。
以下是遗留和新的V2连接器配置请求和响应的示例接受
头值,分别。以下示例基于谷歌Ads连接器:
遗留请求:
get api.www.miaplace.com/v1/connectors/(getsnectors/
遗留回应:
{“代码”:“成功”那“数据”:{......“配置”:{“sync_mode”:“选定的帐户”那“最新版本”:“4”那“配置”:“自定义报告”那“账户”:“0987654321”那“报告类型”:“ad_performance_report”那“service_version”:“4”那“客户ID”:“123-456-7890”那“田野”:“policysummary,adtype,日期”那“转换_window_size”:30.那“historical_sync_timeframe”:“12个月”}}}
新v2请求:
GET api.www.miaplace.com/v1/connectors/{connector_id}——header 'Accept: application/json;version=2'
新v2响应:
{“代码”:“成功”那“数据”:{......“配置”:{“sync_mode”:“特定accounts”那“客户ID”:“123-456-7890”那“账户”: [“0987654321”],“转换_window_size”:30.那“报告类型”:“ad_performance_report”那“田野”: [“policysummary”那“adtype”那“日期”)},“source_sync_details”:{“账户”: [“0987654321”]}}}
我们返回的确切领域集source_sync_details.
参数指定取决于连接器类型。这source_sync_details.
如果请求中省略该参数,则响应中未包含部分。这source_sync_details.
上面的部分中的部分包含有关同步帐户的信息。
在V2配置模式下,我们返回以下连接器的源同步详细信息:
asana源sync_details字段
名称 | 描述 |
---|---|
项目 |
代表同步流程图的项目游标地图。 |
Facebook广告source_sync_details.
领域
名称 | 描述 |
---|---|
account_ids |
Synced帐户列表。 |
Facebook的广告的见解source_sync_details.
领域
名称 | 描述 |
---|---|
account_ids |
Synced帐户列表。 |
谷歌广告source_sync_details.
领域
名称 | 描述 |
---|---|
账户 |
Synced帐户列表。 |
谷歌广告账户source_sync_details.
领域
名称 | 描述 |
---|---|
账户 |
Synced帐户列表。 |
谷歌分析source_sync_details.
领域
名称 | 描述 |
---|---|
profile_ids |
Synced配置文件列表。 |
Google Analytics MCF.source_sync_details.
领域
名称 | 描述 |
---|---|
profile_ids |
Synced配置文件列表。 |
谷歌竞选经理360source_sync_details.
领域
名称 | 描述 |
---|---|
user_profiles. |
Synced用户配置文件列表。 |
谷歌表source_sync_details.
领域
名称 | 描述 |
---|---|
last_synced |
上次同步时间。 |
微软广告source_sync_details.
领域
名称 | 描述 |
---|---|
account_ids |
Synced帐户列表。 |
销售队伍source_sync_details.
领域
名称 | 描述 |
---|---|
connecting_user_email. |
Salesforce用户电子邮件。 |
Organigy_id. |
Salesforce组织ID。 |
用户名 |
Salesforce用户名。 |
要求链接
get api.www.miaplace.com/v1/connectors/(connector_id}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“ID”:“connector_id”那“group_id”:“group_id”那“服务”:“adwords”那“service_version”:4.那“架构”:“adwords.schema”那“暂停”:真正的那“pause_after_trial”:真正的那“connected_by”:“monitor_assure”那“created_at”:“2020-03-11T15:03:55.743708z”那“成功_at”:“2020 - 03 - 17 t12:31:40.870504z”那“failed_at”:“2021 - 01 - 15 t10:55:00.056497z”那“sync_frequency”:360.那“schedule_type”:“汽车”那“地位”:{“setup_state”:“破碎的”那“sync_state”:“计划”那“update_state”:“延迟”那“is_historical_sync”:错误的那“任务”:[{“代码”:“重新连接”那“信息”:“重新连接”}),“警告”:[]},“配置”:{“sync_mode”:“特定accounts”那“客户ID”:“xxx-xxx-xxxx”那“账户”: [“1234567890”],“转换_window_size”:30.那“报告类型”:“ad_performance_report”那“田野”: [“policysummary”那“adtype”那“日期”)},“source_sync_details”:{“账户”: [“1234567890”]}}}
字段
名称 | 描述 |
---|---|
ID |
FiVetran系统内连接器的唯一标识符。 |
group_id. |
Fivetran系统内的组的唯一标识符。 |
服务 |
Fivetran系统中的连接器类型名称。 |
service_version. |
Fivetran系统中的连接器类型版本。 |
架构 |
作为FiveTran系统中的连接器名称,使用的名称和目标中的源架构名称。 |
停顿了一下 |
指定连接器是否暂停。 |
pause_after_trial. |
指定连接器是否应该在免费试用期结束后暂停。 |
连接_By. |
在您的帐户中创建连接器的用户的唯一标识符。 |
created_at. |
在您的帐户中创建连接器的时间戳。 |
succeeded_at |
连接器同步的时间的时间戳上次成功。 |
failed_at. |
连接器同步最后一次失败的时间的时间戳。 |
sync_fruquency. |
连接器同步频率在分钟内。 |
daily_sync_time. |
当同步频率设置为时,我们返回的连接器每日同步开始时间1440 (这意味着24小时)和daily_sync_time. 使用参数使用该参数创建一个连接器或修改连接器请求。 |
schedule_type |
连接器调度配置类型。支持的价值观:汽车 那手动的 . |
status.setup_state. |
连接器的当前设置状态。可用值是:不完整 -安装配置不完整,安装测试从未成功;连接的 - 连接器已正确设置;破碎的 - 连接器设置配置已损坏。 |
status.sync_state |
连接器的电流同步状态。可用值是:预定 同步正在等待运行同步 - 同步目前正在运行;停顿了一下 - 同步当前暂停;重新安排 - SYNC正在等待,直到源服务中提供更多API调用。 |
update_state |
连接器的当前数据更新状态。可用值是:按照时间表 - 同步运行顺利,没有延迟;延迟 - 数据延迟了比更新的更长的时间。 |
是_historical_sync. |
指定连接器是否处于历史数据同步阶段的布尔值(也适用于重新交换连接器)。 |
任务 |
连接器的任务集合。 |
警告 |
连接器的警告收集。 |
配置 |
连接器安装配置。格式是特定的每个连接器. |
source_sync_details. |
(仅为新的V2配置格式)有关连接器状态的其他信息。此参数的格式对于每个连接器类型特定。 |
修改连接器链接
更新FiveTran帐户中现有连接器的信息。
要求链接
补丁api.www.miaplace.com/v1/connectors/ {connector_id}
{“暂停”:错误的那“pause_after_trial”:真正的那“sync_frequency”:60.那“trust_certificates”:真正的那“run_setup_tests”:真正的那“配置”:{“用户名”:“新的用户”那“密码”:“新密码”},“auth”:{“client_access”:{“client_id”:“my_client_id”那“client_secret”:“my_client_secret”},“refresh_token”:“my_refresh_token”},“schedule_type”:“手动的”}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
有效载荷参数
名称 | 描述 |
---|---|
停顿了一下 |
布尔指定连接器是否应暂停 |
pause_after_trial. |
指定连接器是否应该在免费试用期结束后暂停。 |
sync_fruquency. |
连接器同步频率在分钟内。支持的值是:5. 那15. 那30. 那60. 那120. 那180. 那360. 那480. 那720. 那1440 . |
daily_sync_time. |
定义同步频率已经设置或由当前请求设置的同步开始时间的可选参数1440 .它可以在一小时内指定从00:00 到23:00 .如果没有指定,我们将使用基线同步开始时间.此参数对此没有影响0到60分钟偏移量用于确定实际同步开始时间。 |
配置 |
连接器安装配置。格式是特定的每个连接器. |
身份验证 |
连接器授权设置。可用于使用外部客户端凭据对连接器进行授权。格式是特定的每个连接器. |
trust_certificates |
指定我们是否应该自动信任证书。仅适用于数据库连接器和何时配置 部分存在并定义。默认值是错误的 .如果证书不自动信任,则必须使用该证书批准证书管理API批准连接器证书. |
trust_fingerrints. |
指定是否应该自动信任SSH指纹。仅适用于数据库连接器。默认值是错误的 .如果指纹不受自动信任,则必须批准证书管理API批准连接器指纹. |
是_historical_sync. |
指定连接器是否应触发连接器以重新同步所有历史数据。 |
schedule_type |
连接器调度配置类型。支持的价值观:汽车 那手动的 .让您禁用或启用自动数据同步的时间表。如果设置为手动的 ,自动数据同步将被禁用,但您将能够使用SYNC连接器数据端点。 |
run_setup_tests |
指定是否应该自动运行安装测试。默认值是真正的 . |
没有任何一个停顿了一下
那sync_fruquency.
那daily_sync_time.
那配置
那身份验证
那是_historical_sync.
那schedule_type
参数是必需的,但是至少有一个必须出现和定义此类型以成功的请求。
响应链接
HTTP 200好了
{“代码”:“成功”那“信息”:“连接器已更新”那“数据”:{“ID”:“speak_inexpense”那“group_id”:“projected_sickle”那“服务”:“criteo”那“service_version”:0.那“架构”:“criteo”那“暂停”:真正的那“pause_after_trial”:真正的那“connected_by”:“Interment_Burdensome”那“created_at”:“2018-12-01T15:43:29.013729z”那“成功_at”:零那“failed_at”:零那“sync_frequency”:60.那“地位”:{“setup_state”:“不完整”那“sync_state”:“计划”那“update_state”:“按照时间表”那“is_historical_sync”:真正的那“任务”:[],“警告”:[]},“setup_tests”:[{“标题”:“验证登录”那“地位”:“失败的”那“信息”:“无效的登录凭证”}],“配置”:{“用户名”:“新的用户”那“密码”:“* * * * * *”那“api_token”:“* * * * * *”那“service_version”:“0”}}}
如果是run_setup_tests
参数设置为错误的
在请求中,响应不会包含setup_tests
场地。
请注意配置
参数可以以V2配置格式呈现。有关更多信息,请参阅我们的检索连接器详细信息端点文档.
SYNC连接器数据链接
触发FiveTran帐户中现有连接器的数据同步,而无需等待下一个计划的同步。此操作不会覆盖FiveTran仪表板中定义的标准同步频率。
如果有一个数据同步已经在进行中,同步将立即停止并重新启动。如果连接器暂停,则将在重新启用连接器时执行数据同步。
要求链接
post api.www.miaplace.com/v1/connectors/(connector_id)/ forcce.
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
有效载荷
请求主体必须为空。
响应链接
HTTP 200好了
{“代码”:“成功”那“信息”:“已成功触发ID”Connector_id1“的连接器已成功触发}
重新同步连接器表数据链接
触发连接器内单个表的所有数据的历史同步。此操作不会覆盖FiveTran仪表板中定义的标准同步频率。
如果连接器暂停,则将计划在重新启用连接器时调度表同步。如果已经进行了数据同步,我们将尝试完成它。如果失败,请求将被拒绝,并将返回HTTP 409冲突错误。
要求链接
post api.www.miaplace.com/v1/connectors/(conector_id} /schemas/} /tables/ {table)/resync.
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
架构 (必需的) |
目标中的数据库模式名称。 注意:数据库模式与连接器模式是不同的实体。 |
桌子 (必需的) |
数据库模式中的表名。 |
为了使请求成功,您必须正确指定其参数。您可以在连接器的架构选项卡中访问数据库架构和表的确切名称。请参阅以下示例:
有效载荷
请求主体必须为空。
响应链接
HTTP 200好了
{“代码”:“成功”那“信息”:“重新同步已成功触发”Schema1.Table1“}
运行连接器设置测试链接
运行FiveTran帐户中的现有连接器的安装测试。
要求链接
post api.www.miaplace.com/v1/connectors/(connector_id)/test.
{“trust_certificates”:真正的那“trust_fingerrints”:真正的}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
有效载荷参数
名称 | 描述 |
---|---|
trust_certificates |
指定我们是否应该自动信任证书。仅适用于数据库连接器。默认值是错误的 .如果证书不自动信任,则必须使用该证书批准证书管理API批准连接器证书. |
trust_fingerrints. |
指定是否应该自动信任SSH指纹。仅适用于数据库连接器。默认值是错误的 .如果指纹不受自动信任,则必须批准证书管理API批准连接器指纹. |
响应链接
HTTP 200好了
{“代码”:“成功”那“信息”:“设置测试完成”那“数据”:{“ID”:“speak_inexpense”那“group_id”:“projected_sickle”那“服务”:“criteo”那“service_version”:0.那“架构”:“criteo”那“暂停”:错误的那“pause_after_trial”:真正的那“connected_by”:“Interment_Burdensome”那“created_at”:“2018-12-01T15:43:29.013729z”那“成功_at”:零那“failed_at”:零那“sync_frequency”:60.那“地位”:{“setup_state”:“不完整”那“sync_state”:“计划”那“update_state”:“按照时间表”那“is_historical_sync”:真正的那“任务”:[],“警告”:[]},“setup_tests”:[{“标题”:“验证登录”那“地位”:“失败的”那“信息”:“无效的登录凭证”}],“配置”:{“用户名”:“新的用户”那“密码”:“* * * * * *”那“api_token”:“* * * * * *”那“service_version”:“0”}}}
请注意配置
参数可以以V2配置格式呈现。有关更多信息,请参阅我们的检索连接器详细信息端点文档.
删除连接器链接
从FiveTran帐户中删除连接器。
要求链接
删除api.www.miaplace.com/v1/connectors/ {connector_id}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
响应链接
HTTP 200好了
{“代码”:“成功”那“信息”:" id为'speak_inexpensive'的连接器已被删除"}
检索连接器模式配置链接
返回Fivetran帐户中现有连接器的连接器模式配置。
要求链接
获取api.www.miaplace.com/v1/connectors/,以上
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“启用_new_by_default”:错误的那“模式”:{“架构_1”:{“name_in_destination”:“架构_1”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_COLUMN”那“原因”:“列不支持排除,因为它是主要键”}},“column_2”:{“name_in_destination”:“column_2”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:真正的那“哈希”:真正的那“Enabled_patch_settings”:{“允许”:真正的}}}},“table_2”:{“name_in_destination”:“table_2”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_TABLE”}}}},“架构_2”:{“name_in_destination”:“架构_2”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“name_in_destination”:“column_1”那“column_1”:{“启用”:错误的}}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“其他”那“原因”:“没有权限”}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}
字段
名称 | 描述 |
---|---|
启用_new_by_default. |
布尔值,指定是否默认启用新模式和表。 |
schema.name_in_destination. |
根据目的地的模式名称Fivetran常规. |
架构.Enabled. |
指定架构的同步是否已启用目标的布尔值。 |
table.name_in_destination. |
您的目的地内的表名称Fivetran常规. |
table.enabled. |
布尔值,指定是否启用表到目标的同步。 |
table.enabled_patch_settings.allowed. |
布尔值指定是否是table.enabled. 可以修改属性。 |
table.enabled_patch_settings.reason_code. |
原因代码,表示为什么table.enabled. 无法修改属性:SYSTEM_TABLE - 表是一个系统表;删除了 - 该表已删除在源中;其他 - 由于某种原因,系统被系统排除在外。此字段显示在响应时table.enabled_patch_settings.allowed. 物业价值是错误的 . |
table.enabled_patch_settings.Reason. |
附加消息,指示为什么table.enabled. 财产无法修改。此字段仅在响应中显示table.enabled_patch_settings.reason_code. 值是其他 . |
column.name_in_destination. |
您的目的地中的列名按照Fivetran常规. |
列 |
布尔值,指定是否启用将列同步到目标。 |
column.enabled_patch_settings.allowed |
布尔值指定是否是列 可以修改属性。 |
column.enabled_patch_settings.reason_code. |
原因代码,表示为什么列 无法修改属性:system_column. - 列是一个系统列;删除了 - 在源中删除该列;其他 - 由于某种原因,系统被系统排除了该列。 |
column.enabled_patch_settings.Reason. |
附加消息,指示为什么列 财产无法修改。该字段仅在column.enabled_patch_settings.reason_code. 物业价值是system_column. 或其他 . |
柱子 |
指定列是否为的布尔值哈希或不。 |
响应仅包含您的选择与模式配置之间的差异。架构配置包括模式,表和列。如果未指定与默认值不同的任何模式配置,则响应将仅包含顶部架构级别。
检索源表列配置链接
返回Fivetran帐户中现有连接器的源表列配置。
要求链接
得到api.www.miaplace.com/v1/connectors/ {connector_id} /模式/ /{表}/{模式}/表列
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
架构 (必需的) |
源中的数据库模式名称。 注意:数据库模式与连接器模式是不同的实体。 |
桌子 (必需的) |
源模式中的表名。 |
响应链接
HTTP 200好了
{“代码”:“成功”那“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_COLUMN”那“原因”:“列不支持排除,因为它是主要键”}},“column_2”:{“name_in_destination”:“column_2”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:错误的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的} } } }
响应包含一列列,每个列具有FiveTran Sync设置。
字段
名称 | 描述 |
---|---|
name_in_destination |
您的目的地中的列名按照Fivetran常规. |
启用 |
布尔值,指定是否启用将列同步到目标。 |
哈希 |
指定列是否应散列列的布尔值。 |
列 |
布尔值,指定是否启用将列同步到目标。 |
Enabled_patch_settings.Allowed. |
布尔值指定是否是列 可以修改属性。 |
Enabled_patch_settings.reason_code. |
原因代码,表示为什么列 无法修改属性:system_column. - 列是一个系统列;删除了 - 在源中删除该列;其他 - 由于某种原因,系统被系统排除了该列。此字段显示在响应时Enabled_patch_settings.Allowed. 场价值是错误的 . |
提取数据可能需要很长时间,因为我们与源相互作用。响应时间取决于与源的连接。
重新加载连接器模式配置链接
重新加载Fivetran帐户中现有连接器的连接器模式配置。
我们建议您使用此方法如果最近创建连接器,或者其架构过时。
要求链接
post api.www.miaplace.com/v1/connectors/(conector_id} / schemas/reload.
{“complude_mode”:“保存”}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
有效载荷
名称 | 描述 | 可能的价值 |
---|---|---|
exclude_mode |
指定是否在标准配置中启用或禁用所有模式和表。注意:默认情况下,这不排除列。 | 排除 那包括 和保存 .默认值是保存 . |
请求主体可以是空的,因为它只包含一个可选参数exclude_mode
那有价值保存
默认设置。
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“启用_new_by_default”:错误的那“模式”:{“架构_1”:{“name_in_destination”:“架构_1”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_COLUMN”那“原因”:“列不支持排除,因为它是主要键”}},“column_2”:{“name_in_destination”:“column_2”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:真正的那“哈希”:真正的那“Enabled_patch_settings”:{“允许”:真正的}}}},“table_2”:{“name_in_destination”:“table_2”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_TABLE”}}}},“架构_2”:{“name_in_destination”:“架构_2”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:错误的}}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“其他”那“原因”:“没有权限”}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}
字段
名称 | 描述 |
---|---|
启用_new_by_default. |
布尔值,指定是否默认启用新模式和表。 |
模式 |
连接器模式配置中的模式集将同步到目标。 |
schema.name_in_destination. |
根据目的地的模式名称Fivetran常规. |
架构.Enabled. |
指定模式是否在目标中的同步的布尔值。 |
桌子 |
将被同步到目标的数据库模式配置中的一组表。 |
table.name_in_destination. |
您的目的地内的表名称Fivetran常规. |
table.enabled. |
布尔值,指定是否启用表到目标的同步。 |
table.enabled_patch_settings.allowed. |
指定属性的布尔值table.enabled. 可以修改。 |
table.enabled_patch_settings.reason_code. |
原因代码,指示为什么要使用属性table.enabled. 不能修改:SYSTEM_TABLE - 表是一个系统表;删除了 - 该表已删除在源中;其他 - 由于某种原因,系统被系统排除在外。该字段仅在table.enabled_patch_settings.allowed. 物业价值是错误的 . |
table.enabled_patch_settings.Reason. |
附加消息指示属性的原因table.enabled. 不能修改。该字段仅在table.enabled_patch_settings.reason_code. 物业价值是其他 . |
列 |
表格架构配置中的列集将同步到目标。 |
column.name_in_destination. |
您的目的地中的列名按照Fivetran常规. |
列 |
布尔值,指定是否启用将列同步到目标。 |
column.enabled_patch_settings.allowed |
布尔值指定是否是列 可以修改属性。 |
column.enabled_patch_settings.reason_code. |
原因代码,表示为什么列 无法修改属性:system_column. - 列是一个系统列;删除了 - 在源中删除该列;其他 - 由于某种原因,系统被系统排除了该列。 |
column.enabled_patch_settings.Reason. |
附加消息,指示为什么列 财产无法修改。该字段仅在column.enabled_patch_settings.reason_code. 物业价值是system_column. 或其他 . |
柱子 |
指定列是否为的布尔值哈希或不。 |
此方法从连接器的数据源重新加载完整的架构。完成请求可能需要很长时间。方法执行速度取决于模式大小和数据库,表和列的数量。要检索连接器模式配置而不重新加载,请使用检索连接器模式配置端点。
通过指定exclude_mode
参数值,您可以在重新加载连接器模式配置时启用或禁用所有模式和表的同步。默认值保存
设置值,标准配置中的所有选定模式和表保留其状态。当。。。的时候排除
设置值,尚未由用户修改的列不被从同步中排除。这些列可以存在于源中而不是在响应中显示,但默认情况下,它们被认为被包括在同步中。如果启用其表的同步,则来自源中的所有列将在下一个同步周期中同步。也可以看看用例:如何仅为您需要的列启用同步.
响应仅包含您的选择与模式配置之间的差异。架构配置包括模式,表和列。如果未指定与默认值不同的任何模式配置,则响应将仅包含顶部架构级别。
修改连接器模式配置链接
更新FiveTran帐户中现有连接器的模式配置(对于具有多个模式的连接器的单个架构)。
要求链接
补丁api.www.miaplace.com/v1/connectors/ {connector_id} /模式
{“启用_new_by_default”:真正的那“模式”:{“架构_1”:{“启用”:真正的那“表”:{“table_1”:{“启用”:真正的},“table_2”:{“启用”:错误的那“列”:{“column_2”:{“启用”:真正的那“哈希”:错误的},“column_3”:{“哈希”:真正的}}}}},“架构_2”:{“启用”:错误的}}}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
有效载荷参数
名称 | 描述 |
---|---|
启用_new_by_default. |
布尔值,指定是否默认启用新模式,表和列。 |
架构.Enabled. |
指定架构的同步是否已启用目标的布尔值。 |
table.enabled. |
布尔值,指定是否启用表到目标的同步。 |
列 |
布尔值,指定是否启用将列同步到目标。 |
柱子 |
指定列是否应为的布尔值哈希. |
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“启用_new_by_default”:真正的那“模式”:{“架构_1”:{“name_in_destination”:“架构_1”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_COLUMN”那“原因”:“列不支持排除,因为它是主要键”}},“column_2”:{“name_in_destination”:“column_2”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:真正的那“哈希”:真正的那“Enabled_patch_settings”:{“允许”:真正的}}}}}},“架构_2”:{“name_in_destination”:“架构_2”那“启用”:错误的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_TABLE”}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}
响应仅包含您的选择与模式配置之间的差异。架构配置包括模式,表和列。如果未指定与默认值不同的任何模式配置,则响应将仅包含顶部架构级别。
修改连接器数据库模式配置链接
更新FiveTran帐户中现有连接器的数据库架构配置(对于具有多种模式的连接器中的单个架构)。
要求链接
patch api.www.miaplace.com/v1/connectors/(connectors/,schemas/ {schemaname}
{“启用”:真正的那“表”:{“table_1”:{“启用”:真正的},“table_2”:{“启用”:错误的那“列”:{“column_2”:{“启用”:真正的那“哈希”:错误的},“column_3”:{“哈希”:真正的}}}}}}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
架构 (必需的) |
目标中的数据库模式名称(与连接器模式不同)。 |
有效载荷参数
名称 | 描述 |
---|---|
启用 |
指定架构的同步是否已启用目标的布尔值。 |
table.enabled. |
布尔值,指定是否启用表到目标的同步。 |
列 |
布尔值,指定是否启用将列同步到目标。 |
柱子 |
指定列是否应该是的布尔值哈希. |
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“启用_new_by_default”:真正的那“模式”:{“架构_1”:{“name_in_destination”:“架构_1”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_COLUMN”那“原因”:“列不支持排除,因为它是主要键”}},“column_2”:{“name_in_destination”:“column_2”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:真正的那“哈希”:真正的那“Enabled_patch_settings”:{“允许”:真正的}}}}}},“架构_2”:{“name_in_destination”:“架构_2”那“启用”:错误的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_TABLE”}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}
响应仅包含您的选择与模式配置之间的差异。架构配置包括模式,表和列。如果未指定与默认值不同的任何模式配置,则响应将仅包含顶部架构级别。
修改连接器表配置链接
更新数据库架构中的表配置,以为FiveTran帐户中的现有连接器。
要求链接
patch api.www.miaplace.com/v1/connectors/ onconnector_id }/schemas/ {schema} /tables/
{“启用”:错误的那“列”:{“column_2”:{“启用”:真正的那“哈希”:错误的},“column_3”:{“哈希”:真正的}}}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
架构 (必需的) |
目标中的数据库模式名称(与连接器模式不同)。 |
桌子 (必需的) |
数据库模式中的表名。 |
有效载荷参数
名称 | 描述 |
---|---|
启用 |
布尔值,指定是否启用表到目标的同步。 |
列 |
布尔值,指定是否启用将列同步到目标。 |
柱子 |
指定列是否应该是的布尔值哈希. |
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“启用_new_by_default”:真正的那“模式”:{“架构_1”:{“name_in_destination”:“架构_1”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_COLUMN”那“原因”:“列不支持排除,因为它是主要键”}},“column_2”:{“name_in_destination”:“column_2”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:真正的那“哈希”:真正的那“Enabled_patch_settings”:{“允许”:真正的}}}}}},“架构_2”:{“name_in_destination”:“架构_2”那“启用”:错误的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_TABLE”}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}
响应仅包含您的选择与模式配置之间的差异。架构配置包括模式,表和列。如果未指定与默认值不同的任何模式配置,则响应将仅包含顶部架构级别。
修改连接器列配置链接
更新您的表中的表中的列配置,以适用于FiveTran帐户中的现有连接器。
要求链接
patch api.www.miaplace.com/v1/connectors/ {onconector_id }/schemas/ {schema} /tables/ {table} / columns/ {column}
{“启用”:真正的那“哈希”:错误的}
路径参数
名称 | 描述 |
---|---|
connector_id. (必需的) |
FiVetran系统内连接器的唯一标识符。 |
架构 (必需的) |
目标中的数据库模式名称(与连接器模式不同)。 |
桌子 (必需的) |
数据库模式中的表名。 |
柱子 (必需的) |
表中的列名。 |
有效载荷参数
名称 | 描述 |
---|---|
启用 |
布尔值,指定是否启用了将列同步到目标的功能。 |
哈希 |
指定列是否应为的布尔值哈希. |
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“启用_new_by_default”:真正的那“模式”:{“架构_1”:{“name_in_destination”:“架构_1”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_COLUMN”那“原因”:“列不支持排除,因为它是主要键”}},“column_2”:{“name_in_destination”:“column_2”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:真正的那“哈希”:真正的那“Enabled_patch_settings”:{“允许”:真正的}}}}}},“架构_2”:{“name_in_destination”:“架构_2”那“启用”:错误的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的}},“table_2”:{“name_in_destination”:“table_2”那“启用”:错误的那“Enabled_patch_settings”:{“允许”:错误的那“原因_code”:“SYSTEM_TABLE”}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}
响应仅包含您的选择与模式配置之间的差异。架构配置包括模式,表和列。如果未指定与默认值不同的任何模式配置,则响应将仅包含顶部架构级别。
用例:根据现有连接器的参数创建一个新的连接器链接
您可以使用现有连接器的参数创建新连接器。也就是说,您可以克隆一个Fivetran连接器。
检索连接器对象详细信息。看检索连接器详细信息.
要求链接
get api.www.miaplace.com/v1/connectors/(connector_id}
路径参数
名称 描述 connector_id.
(必需的)FiVetran系统内连接器的唯一标识符。 响应链接
HTTP 200好了
从API响应中记下以下字段:
{“group_id”:“projected_sickle”那“服务”:“criteo”那“配置”:{“用户名”:“myuser”那“密码”:“* * * * * *”那“api_token”:“* * * * * *”那“service_version”:“0”}}
使用上一步中的字段创建新连接器。看创建一个连接器.
要求链接
帖子api.www.miaplace.com/v1/connectors
{“服务”:“criteo”那“group_id”:“projected_sickle”那“trust_certificates”:真正的那“run_setup_tests”:真正的那“配置”:{“架构”:“criteo”那“用户名”:“myuser”那“密码”:“我的密码”那“app_token”:“myapptoken”}}
有效载荷参数
名称 描述 group_id.
(必需的)Fivetran系统内的组的唯一标识符。找你 group_id.
取回你的账户组列表.服务
(必需的)Fivetran系统中连接器类型的名称。 配置
(必需的)连接器安装配置。格式是特定的每个连接器. trust_certificates
指定我们是否应该自动信任证书。仅适用于数据库连接器。默认值是 错误的
.如果证书不自动信任,则必须使用该证书批准证书管理API..run_setup_tests
指定是否应该自动运行安装测试。默认值是 真正的
.响应链接
HTTP 201创建了
用例:如何仅为您需要的列启用同步链接
连接器标准配置仅将信息存储有关源中的架构配置之间的差异以及用户所做的更改。为了澄清这一点,让我们看看这个例子:
要求链接
获取api.www.miaplace.com/v1/connectors/connector_id_1/schemas/schema_1/stables/table_1/columns.
响应链接
HTTP 200好了
{“代码”:“成功”那“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:错误的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的} } } }
此示例显示我们只有一个禁用的同步column_1.
,但它并不一定意味着我们在源中没有其他列。例如,源可能有column_2.
和column_3.
在这张表中。默认情况下,所有表列都启用了同步,它们将在下一个连接器SYNC周期中同步。
假设我们只想为列启用同步column_3.
.首先,要排除其他不需要的列,你需要知道表的所有列名:
我们可以使用检索源表列配置终点为此目的。
要求链接
获取api.www.miaplace.com/v1/connectors/connector_id_1/schemas/schema_1/stables/table_1/columns.
响应链接
HTTP 200好了
{“代码”:“成功”那“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:错误的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_2”:{“name_in_destination”:“column_2”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的} } } }
一旦我们知道列名,我们就可以从我们不想同步的列中明确排除,并包括我们所需的列修改连接器表配置端点。
要求链接
patch api.www.miaplace.com/v1/connectors/connector_id_1/schemas/schema_1/tables/table_1.
{“启用”:真正的那“列”:{“column_1”:{“启用”:错误的那“哈希”:错误的},“column_2”:{“启用”:错误的那“哈希”:错误的},“column_3”:{“启用”:真正的那“哈希”:错误的}}}
响应链接
HTTP 200好了
{“代码”:“成功”那“数据”:{“启用_new_by_default”:错误的那“模式”:{“架构_1”:{“name_in_destination”:“架构_1”那“启用”:真正的那“表”:{“table_1”:{“name_in_destination”:“table_1”那“启用”:真正的那“Enabled_patch_settings”:{“允许”:真正的},“列”:{“column_1”:{“name_in_destination”:“column_1”那“启用”:错误的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_2”:{“name_in_destination”:“column_2”那“启用”:错误的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的}},“column_3”:{“name_in_destination”:“column_3”那“启用”:真正的那“哈希”:错误的那“Enabled_patch_settings”:{“允许”:真正的} } } } } } } } }
用例:如何设置自定义同步频率链接
您可以覆盖连接器的Fivetran默认同步频率。的值指定同步之间选择的时间间隔(以分钟为单位)来设置自定义同步频率sync_fruquency.
参数在修改连接器端点请求。
假设我们想为连接器设置一个自定义频率connector_id_1
每小时同步一次。
补丁api.www.miaplace.com/v1/connectors/connector_id_1
{“sync_frequency”:60.}
要了解如何在Fivetran中运行的同步调度如何,请阅读我们的同步频率和调度文档.
用例:如何设置日常同步的时间链接
如果您不想使用Fivetran的默认午夜开始时间,您可以选择您的日常同步开始的时间。
假设我们想设置一个03:00
连接器启动时间connector_id_1
.
有两种方法可以做到这一点:
- 为了确定
connector_id_1
已经具有同步频率等于1440
并提出要求:
补丁api.www.miaplace.com/v1/connectors/connector_id_1
{“daily_sync_time”:“03:00}
- 确定
sync_fruquency.
和daily_sync_time.
在一个请求:
补丁api.www.miaplace.com/v1/connectors/connector_id_1
{“sync_frequency”:1440那“daily_sync_time”:“03:00}
用例:如何仅在需要时触发同步链接
您只能在需要时启用手动同步调度并触发数据同步。要为连接器启用手动同步调度,请指定手动的
作为一个值schedule_type
参数使用这件修改连接器端点。手动同步调度忽略该集sync_fruquency.
.
重要提示:在进行此更改后,您需要手动触发同步。
假设我们想要为连接器启用手动同步调度connector_id_1
触发它的同步。
使用下面的示例请求来切换连接器
schedule_type
到手动的
:补丁api.www.miaplace.com/v1/connectors/connector_id_1
{“schedule_type”:“手动的”那“run_setup_tests”:错误的}
接下来,使用SYNC连接器数据端点根据自己的计划触发数据同步。或者,您可以在FiveTran仪表板中触发同步。
post api.www.miaplace.com/v1/connectors/connector_id_1/force.
注意:此请求的有效载荷应为空。