华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 data_sources Array of LdDatasourceInfo objects 数据源列表 表5 LdDatasourceInfo 参数 参数类型 描述 name String 数据源名称 type String 数据源类型： oracle：oracle数据源类型 mysql：mysql数据源类型 mongodb：mongodb数据源类型 redis：redis数据源类型 postgresql：postgresql/opengauss数据源类型 hive：hive数据源类型 mssql：sqlserver数据源类型 sqlserver：sqlserver数据源类型 dws：dws数据源类型 gauss100：gauss100数据源类型 zenith：zenith数据源类型 hana: hana数据源类型 clickhouse: clickhouse数据源类型 mrshive: mrshive数据源类型(tag:Site_hybrid) description String 数据源描述 url String 数据源连接字符串 user String 用户名 password String 密码。 敏感信息不作为响应返回 remotepath String ftp上传路径 预留字段，暂不支持。 id String 数据源ID status String 数据源状态： old：存量数据源 new：ROMA数据源 created_time String 数据源创建时间 modified_time String 数据源更新时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "available_zone_ids" : "[region01, region02]", "bandwidth_size" : 5, "description" : "test create instance", "enterprise_project_id" : "0", "instance_name" : "apig-demo", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7", "spec" : "PROFESSIONAL", "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5", "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763" } 状态码： 401 Unauthorized { "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method" } 状态码： 404 Not Found { "error_code" : "APIC.7302", "error_msg" : "Instance not found" } 状态码： 500 Internal Server Error { "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 实例编号 project_id String 实例所属项目编号 instance_name String 实例名称 status String 实例状态： Creating：创建中 CreateSuccess：创建成功 CreateFail：创建失败 Initing：初始化中 Registering：注册中 Running：运行中 InitingFailed：初始化失败 RegisterFailed：注册失败 Installing：安装中 InstallFailed：安装失败 Updating：升级中 UpdateFailed：升级失败 Rollbacking：回滚中 RollbackSuccess：回滚成功 RollbackFailed：回滚失败 Deleting：删除中 DeleteFailed：删除失败 Unregistering：注销中 UnRegisterFailed：注销失败 CreateTimeout：创建超时 InitTimeout：初始化超时 RegisterTimeout：注册超时 InstallTimeout：安装超时 UpdateTimeout：升级超时 RollbackTimeout：回滚超时 DeleteTimeout：删除超时 UnregisterTimeout：注销超时 Starting：启动中 Freezing：冻结中 Frozen：已冻结 Restarting：重启中 RestartFail：重启失败 Unhealthy：实例异常 RestartTimeout：重启超时 instance_status Integer 实例状态对应编号 1：创建中 2：创建成功 3：创建失败 4：初始化中 5：注册中 6：运行中 7：初始化失败 8：注册失败 10：安装中 11：安装失败 12：升级中 13：升级失败 20：回滚中 21：回滚成功 22：回滚失败 23：删除中 24：删除失败 25：注销中 26：注销失败 27：创建超时 28：初始化超时 29：注册超时 30：安装超时 31：升级超时 32：回滚超时 33：删除超时 34：注销超时 35：启动中 36：冻结中 37：已冻结 38：重启中 39：重启失败 40：实例异常 41：重启超时 type String 实例类型 暂不支持 spec String 实例规格： ROMA_BASIC：基础版实例 ROMA_PROFESSIONAL：专业版实例 ROMA_ENTERPRISE：企业版实例 ROMA_PLATINUM：铂金版实例 create_time Long 实例创建时间。unix时间戳格式。 enterprise_project_id String 企业项目ID，企业账号必填 eip_address String 实例绑定的弹性IP地址 charging_mode Integer 实例计费方式 0：按需计费 1：包周期计费 cbc_metadata String 计费订单编号，包周期计费时使用。 cbc_operation_locks Array of CbcOperationLock objects 云运营限制操作锁 暂不支持 description String 实例描述 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID。 security_group_id String 实例所属的安全组。 maintain_begin String '维护时间窗开始时间。时间格式为 xx:00:00，xx取值为02,06,10,14,18,22。' '在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次。' maintain_end String '维护时间窗结束时间。时间格式为 xx:00:00，与维护时间窗开始时间相差4个小时。' '在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次'。 ingress_ip String 实例入口，虚拟私有云访问地址 user_id String 实例所属用户ID nat_eip_ipv6_cidr String 出公网网段 (IPv6) 。 当前仅部分region部分可用区支持IPv6 eip_ipv6_address String 弹性IP地址(IPv6)。 当前仅部分region部分可用区支持IPv6 nat_eip_address String 实例出公网IP bandwidth_size Integer 出公网带宽 available_zone_ids String 可用区 instance_version String 实例版本编号 virsubnet_id String 子网的网络ID。 暂不支持 roma_eip_address String ROMA弹性公网IP。 暂不支持 listeners Array of Listener objects 监听信息，暂不支持 supported_features Array of strings 实例支持的特性列表 ingress_ip_v6 String 实例入口（IPv6） 当前仅部分region部分可用区支持IPv6 node_ips NodeIps object 节点内部ip信息 ingress_ips String 实例集群全量入口（多入口实例） cipher_type String 实例算法类型： generalCipher：通用加密算法 SMCompatible：SM系列商密算法兼容 SMOnly：SM系列商密算法 暂不支持 表4 CbcOperationLock 参数 参数类型 描述 lock_scene String 限制操作场景： TO_PERIOD_LOCK：按需转包周期场景锁，不允许进行删除、规格变更、按需转包周期等 SPEC_CHG_LOCK：包周期规格变更场景锁，不允许进行删除、规格变更等 lock_source_id String 发起限制操作对象的标志 表5 Listener 参数 参数类型 描述 name String 监听器名称 port Integer 监听器对外提供服务端口 backend Backend object 后端服务定义 ip_version Integer 创建负载均衡器的IP协议类型 缺省值：4 表6 Backend 参数 参数类型 描述 ip Array of strings 后端主机地址列表 port Integer 后端服务端口，不存在时使用监听器端口 health_check HealthCheck object 健康检查配置 表7 HealthCheck 参数 参数类型 描述 protocol String 当前LVS只支持TCP_CHECK port Integer 健康检查端口 unhealthy Integer 判定后端不健康的阈值，连续探测失败次数 缺省值：3 timeout Integer 探测后端的超时时间，单位秒 缺省值：3 interval Integer 探测后端的间隔时间，单位秒 缺省值：3 表8 NodeIps 参数 参数类型 描述 livedata Array of strings 自定义后端服务livedta组件节点ip列表 shubao Array of strings API网关shubao组件节点ip列表 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 app_quota_id String 客户端配额编号 name String 配额名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3-255字符 call_limits Integer 客户端配额的访问次数限制 time_unit String 限定时间单位：SECOND:秒、MINUTE:分、HOUR:时、DAY:天 time_interval Integer 配额的限定时间值 remark String 参数说明和描述 最大长度：255 reset_time String 首次配额重置时间点，不配置默认为首次调用时间计算 create_time String 创建时间 bound_app_num Integer 配额策略已绑定应用数量 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3", "name" : "ClientQuota_demo", "call_limits" : 1000, "time_unit" : "DAY", "time_interval" : 1, "remark" : "remark", "reset_time" : "2020-09-20 00:00:00 +0000 +0000", "create_time" : "2020-09-19T07:27:47Z", "bound_app_num" : 0 } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3002", "error_msg" : "App 98df09fb-d459-4cbf-83a7-2b55ca6f3d5d does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表4 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

响应示例 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device-groups.delete]. Parameter is [group_id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

请求示例 根据指定源端和目标端数据源初始化组合任务 { "ext_info" : null, "source_datasource_id" : "30969b205e8f4392a25fb321112d1753", "target_datasource_id" : "30969b205e8f4392a25fb321112d1753", "task_id" : null, "auto_mapping" : false }

响应示例 状态码： 400 Bad Request { "error_code" : "FDI.3150", "error_msg" : "The task list is empty." } 状态码： 404 Not Found { "error_code" : "FDI.3083", "error_msg" : "One or more scheduled tasks are not configured with scheduled plans." }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of MultiTaskInitElement objects OK 表6 MultiTaskInitElement 参数 参数类型 描述 ext_info ext_info object 扩展属性，目前只支持server_id。 task_id String 任务ID 最小长度：1 最大长度：64 source_datasource_id String 源端数据源ID。 最小长度：1 最大长度：64 target_datasource_id String 目标端数据源ID。 最小长度：1 最大长度：64 source_group String 源端组。 最小长度：1 最大长度：64 target_group String 目标端组。 最小长度：1 最大长度：64 source_ds_id String 源端数据源ID。 最小长度：1 最大长度：64 target_ds_id String 目标端数据源ID。 最小长度：1 最大长度：64 source_instance_id String 源端实例ID。 最小长度：1 最大长度：64 target_instance_id String 目标端实例ID。 最小长度：1 最大长度：64 source_app_id String 源端数据源所属集成应用ID。 最小长度：1 最大长度：64 target_app_id String 目标端数据源所属集成应用ID。 最小长度：1 最大长度：64 source_datasource_name String 源端数据源的名称。 最小长度：1 最大长度：64 target_datasource_name String 目标端数据源的名称。 最小长度：1 最大长度：64 source_datasource_type String 源端数据源的类型。 最小长度：1 最大长度：64 target_datasource_type String 目标端数据源的类型。 最小长度：1 最大长度：64 mappings Array of MultiTaskMappingElement objects 映射关系列表，只返回前10条。 数组长度：1 - 9999 schema_mappings Array of MultiTaskSchemaMappingElement objects schema映射关系列表，只返回前10条。 数组长度：1 - 9999 mappings_total_count Integer 映射关系总数 最小值：0 最大值：1000000 表7 ext_info 参数 参数类型 描述 server_id String MySQL的ServerID。 最小长度：1 最大长度：20 表8 MultiTaskMappingElement 参数 参数类型 描述 id String 映射唯一ID。 最小长度：1 最大长度：64 source_table String 源表名。 最小长度：1 最大长度：256 target_table String 目标表名。 最小长度：1 最大长度：256 updated_time Long 上次修改时间。 最小值：1 最大值：9999999999999999999 mapping_percent Integer 匹配度。 最小值：0 最大值：100 status String 映射状态。 AUTO (自动映射) MANUAL (手工新增) ADD (自动新增) UPDATE (更新) DELETE (删除) USING (使用中) 最小长度：1 最大长度：10 source_columns Array of MultiTaskColumnInfo objects 源端字段列表。 数组长度：1 - 9999 target_columns Array of MultiTaskColumnInfo objects 目标端字段列表。 数组长度：1 - 9999 mapping Array of MappingInfo objects 字段映射列表。 数组长度：1 - 9999 表9 MultiTaskColumnInfo 参数 参数类型 描述 field_name String 字段名。 最小长度：1 最大长度：256 field_type String 字段类型。 最小长度：1 最大长度：256 field_length String 字段长度。 最小值：0 最大值：10000000 表10 MappingInfo 参数 参数类型 描述 source_column String 源端字段。 最小长度：1 最大长度：256 source_column_type String 源端字段类型。 最小长度：1 最大长度：256 source_column_length String 源端字段长度。 最小值：0 最大值：10000000 target_column String 目标端字段。 最小长度：1 最大长度：256 target_column_type String 目标端字段类型。 最小长度：1 最大长度：256 target_column_length String 目标端字段长度。 最小值：0 最大值：10000000 表11 MultiTaskSchemaMappingElement 参数 参数类型 描述 id String 映射唯一ID。 最小长度：1 最大长度：64 source_schema String 源schema名。 最小长度：1 最大长度：256 target_schema String 目标schema名。 最小长度：1 最大长度：256 updated_time Long 上次修改时间。 最小值：1 最大值：9999999999999999999 status String 映射状态。 AUTO (自动映射) MANUAL (手工新增) ADD (自动新增) UPDATE (更新) DELETE (删除) USING (使用中) 最小长度：1 最大长度：10 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 ext_info 否 ext_info object 扩展属性，目前支持server_id，允许为空。 source_datasource_id 否 String 源端数据源ID。 最小长度：1 最大长度：64 target_datasource_id 否 String 目标端数据源ID。 最小长度：1 最大长度：64 task_id 否 String 任务ID，可以为空，为空时自动分配任务ID。 最小长度：3 最大长度：50 auto_mapping 否 Boolean 是否自动建立源端到目标端映射。 表4 ext_info 参数 是否必选 参数类型 描述 server_id 否 String Mysql的ServerID 最小长度：1 最大长度：20

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "run_env_name" : "RELEASE", "group_name" : "api_group_001", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "throttle_apply_id" : "3e06ac135e18477e918060d3c59d6f6a", "name" : "Api_http", "apply_time" : "2020-08-03T12:25:52Z", "remark" : "Web backend Api", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "5f918d104dc84480a75166ba99efff21", "type" : 1, "throttle_name" : "throttle_demo", "auth_type" : "APP", "req_uri" : "/test/http" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:throttle_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3005", "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiForThrottle objects 本次查询返回的API列表 表5 ApiForThrottle 参数 参数类型 描述 auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark String API描述 run_env_id String 发布的环境ID id String API编号 req_uri String API的请求地址 type Integer API类型 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time String 已绑定的流控策略的绑定时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 id String 编号 name String API分组名称 status Integer 状态 1： 有效 2: 锁定 sl_domain String 系统默认分配的子 域名 register_time String 创建时间 update_time String 最近修改时间 on_sell_status Integer 是否已上架云市场： 1：已上架 2：未上架 3：审核中 ROMA Connect暂未对接云市场，此字段默认返回2 url_domains Array of UrlDomain objects 分组上绑定的独立域名列表 sl_domain_access_enabled Boolean 调试域名是否可以访问，true表示可以访问，false表示禁止访问 缺省值：true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer 是否为默认分组 version String 分组版本 V1：全局分组 V2：应用级分组 roma_app_id String 分组归属的集成应用编号。 分组版本V2时必填。 roma_app_name String 分组归属的集成应用名称 表5 UrlDomain 参数 参数类型 描述 id String 域名编号 domain String 访问域名 cname_status Integer 域名cname状态： 1：未解析 2：解析中 3：解析成功 4：解析失败 ssl_id String SSL证书编号 ssl_name String SSL证书名称 min_ssl_version String 最小ssl协议版本号。支持TLSv1.1或TLSv1.2 缺省值：TLSv1.1 verified_client_certificate_enabled Boolean 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 缺省值：false is_has_trusted_root_ca Boolean 是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。 缺省值：false ssl_infos Array of SslInfo objects SSL证书列表 暂不支持 表6 SslInfo 参数 参数类型 描述 ssl_id String SSL证书编号 ssl_name String SSL证书名称 algorithm_type String 证书算法类型： RSA ECC SM2 暂不支持 type String 证书可见范围： instance：当前实例 global：全局 缺省值：global 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 201 Created { "update_time" : "2020-07-31T06:55:55.383169299Z", "name" : "api_group_001", "on_sell_status" : 2, "remark" : "group1", "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ], "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "register_time" : "2020-07-31T06:55:55.383169068Z", "status" : 1, "is_default" : 2, "version" : "V1" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String API分组的名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。 说明： 中文字符必须为UTF-8或者unicode编码。 最小长度：3 最大长度：255 remark 否 String API分组描述。 说明： 中文字符必须为UTF-8或者unicode编码。 最大长度：1000 roma_app_id 否 String 分组归属的集成应用编号。 分组版本V2时必填。 version 否 String 分组版本 V1：全局分组 V2：应用级分组

响应示例 状态码： 200 OK { "task" : { "task_id" : "9496207a5d6b44b486d79005b5815bd4", "task_name" : "fdi_task_pzy4m5", "task_type" : "timing", "project_id" : "c53626012ba84727b938ca8bf03108ef", "source_datasource_id" : "d3412230cff8449e92c8ff8f74d1157d", "target_datasource_id" : "d3412230cff8449e92c8ff8f74d1157d", "source_datasource_name" : "100.85.221.77", "target_datasource_name" : "100.85.221.77", "source_app_id" : "7f245167-ac84-4b2e-bbea-f0988a4bf6f4", "target_app_id" : "7f245167-ac84-4b2e-bbea-f0988a4bf6f4", "source_app_name" : "app-fdi-ttt", "target_app_name" : "app-fdi-ttt", "status" : "stop", "created_date" : 1666772375897, "last_modified_date" : 1666772375897, "task_mode" : "NORMAL", "enterprise_project_id" : "0", "source_datasource_type" : "MYSQL", "target_datasource_type" : "MYSQL", "source_instance_name" : "roma-z00617033-not-delete", "target_instance_name" : "roma-z00617033-not-delete", "execute_status" : "SUC CES S", "repulling_snapshot" : false }, "task_detail" : "{\"needAPI\":false,\"targetDsId\":\"d3412230cff8449e92c8ff8f74d1157d\",\"sourceSelectedDatasource\":{\"extend_meta_data\":[],\"orderType\":\"ASC\",\"sourceDateColumn\":\"\",\"dataTimestamp\":\"\",\"sourceTable\":\"zhenghaotest.zh_sss01\",\"sourceSelectedColumnList\":[{\"null_able\":\"0\",\"unique\":\"1\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"255\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"}],\"isParse\":\"true\",\"querySql\":\"\",\"whereOptions\":[],\"instanceId\":\"db93bfe1-c660-4c9e-82b6-388e44662cc8\",\"sourceMetaData\":{\"dataSource\":[]},\"isAddSql\":false,\"meta_data\":[],\"where\":[],\"need_inc_migration\":false,\"textInputValue\":\"\",\"orderColumn\":\"\",\"isTextInput\":false},\"targetDatasource\":\"100.85.221.77\",\"needEmailNew\":false,\"description\":\"\",\"taskTag\":\"\",\"mappingTableProperties\":[{\"sourceNullable\":\"0\",\"sourceUnique\":\"1\",\"targetUnique\":\"1\",\"targetNullable\":\"0\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"}],\"sourceDatasourceType\":\"MYSQL\",\"taskType\":2,\"sourceDatasource\":\"100.85.221.77\",\"targetDatasourceType\":\"MYSQL\",\"mappingSourceTextOrNot\":[{\"flag\":false},{\"flag\":false}],\"mappingTable\":[{\"targetColumnType\":\"INT\",\"isAddDateMapping\":false,\"targetColumnLength\":\"11\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"11\",\"targetColumn\":\"id\",\"sourceColumnType\":\"INT\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"id\"},{\"targetColumnType\":\"VARCHAR\",\"isAddDateMapping\":false,\"targetColumnLength\":\"255\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"255\",\"targetColumn\":\"name\",\"sourceColumnType\":\"VARCHAR\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"name\"}],\"targetSelectedDatasource\":{\"targetNeedCreateTable\":false,\"targetSelectedColumnList\":[{\"null_able\":\"0\",\"unique\":\"1\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"255\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"64\",\"field_type\":\"VARCHAR\",\"field_name\":\"bunum\"}],\"supportPartUpdate\":false,\"targetTable\":\"zhenghaotest.zh_sss02\",\"instanceId\":\"db93bfe1-c660-4c9e-82b6-388e44662cc8\",\"batch_number_style\":\"UUID\",\"isSupportClearTab\":false,\"batchNumber\":\"\"},\"taskName\":\"fdi_task_pzy4m5\",\"sourceDsId\":\"d3412230cff8449e92c8ff8f74d1157d\",\"projectId\":\"c53626012ba84727b938ca8bf03108ef\",\"needMQS\":false,\"mappingInput\":{},\"mappingRequired\":true}" }

响应示例 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device-groups.deleteDeviceRelFromGroup]. Parameter is [group_id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表4 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

响应示例 状态码： 200 OK { "id" : 2235, "name" : "template", "description" : "description", "status" : 0, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "created_datetime" : 1607303564596, "last_updated_datetime" : 1607571061057 } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-producttemplate.update]. Parameter is [id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 产品模板名称，支持中文、英文大小写、数字、下划线和中划线，长度2-64。 最小长度：2 最大长度：64 description 否 String 产品模板描述，长度0-200。 最小长度：0 最大长度：200 status 是 Integer 产品模板状态，0-启用，1-禁用。 最小值：0 最大值：10 缺省值：0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id Integer 产品模板ID。 最小值：1 最大值：99999999999999999 name String 产品模板名称。 最小长度：1 最大长度：64 description String 产品模板描述。 最小长度：0 最大长度：200 status Integer 产品模板状态，0-启用，1-停用。 最小值：0 最大值：10 created_user CreatedUser object 创建时的用户。 last_updated_user LastUpdatedUser object 最后更新时的用户。 created_datetime Long 创建时间，timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 last_updated_datetime Long 最后修改时间，timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 表5 CreatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 最小长度：0 最大长度：64 user_name String 用户名。 最小长度：0 最大长度：64 表6 LastUpdatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 最小长度：0 最大长度：64 user_name String 用户名。 最小长度：0 最大长度：64 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

响应示例 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device.delete]. Parameter is [deviceOid]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表4 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 topics Array of topics objects 待删除的Topic列表。 表5 topics 参数 参数类型 描述 id String Topic名称。 success Boolean 是否删除成功。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

响应示例 状态码： 200 OK { "topics" : [ { "id" : "topic-test-2", "success" : true } ] } 状态码： 400 Bad Request { "error_code" : 400, "error_msg" : "Bad Request" } 状态码： 403 Forbidden { "error_code" : 403, "error_msg" : "Forbidden" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 message String 任务重置结果。 最小长度：3 最大长度：50 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

请求示例 重置指定数据集成组合任务的进度到指定时间点 https://{{ServerHost}}/v2/c53626012ba84727b938ca8bf03108ef/fdi/instances/fae7ff6c-8e07-4cf8-9e67-589cab2f017c/multi-tasks/15366328208d4d77b76532fe9f4006a6/reset { "date_from" : 1630052714000 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 date_from 否 Long 任务重置开始时间，UTC时间戳，允许为空。 最小值：1 最大值：9999999999999999999

响应示例 状态码： 200 OK { "message" : "Reset Success" } 状态码： 400 Bad Request { "error_code" : "FDI.3150", "error_msg" : "The task list is empty." } 状态码： 404 Not Found { "error_code" : "FDI.3083", "error_msg" : "One or more scheduled tasks are not configured with scheduled plans." }