华为云用户手册

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "items" : [ { "permissions" : [ "read", "access", "delete", "modify" ], "id" : 120671, "product_serial" : "Dd1bRt122894", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "name" : "pro-opcua", "manufacturer_id" : "pro-opcua", "manufacturer_name" : "pro-opcua", "model" : "pro-opcua", "product_type" : 0, "description" : "opcua product", "protocol_type" : 4, "device_type" : "default", "version" : "version", "created_datetime" : 1607481372416, "last_updated_datetime" : 1607481372416, "app_name" : "app-link", "data_format" : 0, "created_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "last_updated_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "authentication" : { "user_name" : "4MjxbCl4q461", "password" : "********" } } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.search]. Parameter is [product_type]. Processor is [query].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "SCB.00000000", "error_msg" : "Not Found", "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" }

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "entities" : { "task_id" : "15366328208d4d77b76532fe9f4006a6", "task_name" : "task_cdc_oracle2oracle", "task_type" : "TIMING", "status" : 0, "created_date" : "1605288733684", "version" : "2", "last_modified_time" : 456223355566, "execute_status" : "ERROR", "source_app_id" : "73b7f7a6-d1b8-4806-a0f8-278fe7186592", "target_app_id" : "73b7f7a6-d1b8-4806-a0f8-278fe7186592", "source_instance_id" : "fae7ff6c-8e07-4cf8-9e67-589cab2f017c", "target_instance_id" : "fae7ff6c-8e07-4cf8-9e67-589cab2f017c", "ext_type" : "cdc", "enterprise_project_id" : "0", "task_tag" : "fdi_autotest" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Long 查询任务列表任务总个数。 size Integer 查询任务列表返回的当前页的任务个数。 entities Array of BriefTaskRespBean objects 查询任务列表返回的对象。 表5 BriefTaskRespBean 参数 参数类型 描述 task_id String 任务ID。 task_name String 任务名称。 task_type String 任务类型。 REALTIME (实时) TIMING (定时) status Integer 任务状态。 0 (停止/未启动) 1 (运行中) created_date String 创建时间。 version String 任务的版本。 last_modified_time Long 上次修改时间。 execute_status String 任务执行状态。 UNSTARTED (未启动) WAITING (等待执行) RUNNING (执行中) SUC CES S (执行成功) CANCELLED (任务取消) ERROR (执行异常) source_app_id String 源端数据源所属应用ID。 target_app_id String 目标端数据源所属应用ID。 source_instance_id String 源端实例ID。 target_instance_id String 目标端实例ID。 ext_type String 组合任务类型, 可为空。 enterprise_project_id String 企业项目ID。 task_tag String 任务标签。 状态码： 400 表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 { "permissions" : [ "read", "access", "delete", "modify" ], "id" : 120671, "product_serial" : "Dd1bRt122894", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "name" : "pro-opcua", "manufacturer_id" : "pro-opcua", "manufacturer_name" : "pro-opcua", "model" : "pro-opcua", "product_type" : 0, "description" : "opcua product", "protocol_type" : 4, "device_type" : "default", "version" : "version", "created_datetime" : 1607481372416, "last_updated_datetime" : 1607481372416, "app_name" : "app-link", "data_format" : 0, "created_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "last_updated_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "authentication" : { "user_name" : "4MjxbCl4q461", "password" : "********" } } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.searchProductDetails]. Parameter is [product_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 ff38023c-0854-4779-847d-72528e1f5da5 is correct.", "request_id" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-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" }

响应示例 状态码： 200 OK { "name" : "Authorizer_demo", "type" : "FRONTEND", "authorizer_type" : "LD", "authorizer_uri" : "/test", "network_type" : "", "authorizer_version" : "", "authorizer_alias_uri" : "", "identities" : [ { "name" : "header", "location" : "HEADER" } ], "ttl" : 5, "need_body" : true, "id" : "0d982c1ac3da493dae47627b6439fc5c", "create_time" : "2020-09-23T02:32:10Z", "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "roma_app_name" : "app-demo" } 状态码： 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.3081", "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 修改指定的自定义认证，修改认证来源参数 { "name" : "Authorizer_demo", "type" : "FRONTEND", "authorizer_type" : "LD", "ld_api_id" : "6f8e61317e4e4fbf8e8220cc19fcced9", "authorizer_uri" : "/test", "network_type" : "", "authorizer_version" : "", "authorizer_alias_uri" : "", "identities" : [ { "name" : "header", "location" : "HEADER" } ], "ttl" : 5 }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 name String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type String 自定义认证类型 FRONTEND：前端 BACKEND：后端 authorizer_type String 自定义认证函数类型： LD：自定义后端函数 FUNC：函数服务函数 authorizer_uri String 函数地址。 注意：使用自定义后端的函数API，API请求方法必须为POST，且API状态必须为已部署。 network_type String 对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构 注意：该字段在APIC场景下不生效 authorizer_version String 函数版本。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN authorizer_alias_uri String 函数别名地址。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN identities Array of Identity objects 认证来源 ttl Integer 缓存时间 user_data String 用户数据 ld_api_id String 自定义后端服务ID。 自定义认证函数类型为LD时必填 need_body Boolean 是否发送body auth_downgrade_enabled Boolean 宽松模式，连接函数鉴权服务失败或者函数鉴权服务返回5XX，网关是否接受客户端请求。 id String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 roma_app_name String 自定义认证所属应用名称 表6 Identity 参数 参数类型 描述 name String 参数名称。 支持数字，英文，下划线，中划线，点，且只能以数字或英文开头。 location String 参数位置 validation String 参数校验表达式，默认为null，不做校验 状态码： 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 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型 FRONTEND：前端 BACKEND：后端 authorizer_type 是 String 自定义认证函数类型： LD：自定义后端函数 FUNC：函数服务函数 authorizer_uri 是 String 函数地址。 注意：使用自定义后端的函数API，API请求方法必须为POST，且API状态必须为已部署。 network_type 否 String 对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构 注意：该字段在APIC场景下不生效 authorizer_version 否 String 函数版本。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN authorizer_alias_uri 否 String 函数别名地址。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN identities 否 Array of Identity objects 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据 ld_api_id 否 String 自定义后端服务ID。 自定义认证函数类型为LD时必填 need_body 否 Boolean 是否发送body auth_downgrade_enabled 否 Boolean 宽松模式，连接函数鉴权服务失败或者函数鉴权服务返回5XX，网关是否接受客户端请求。 表4 Identity 参数 是否必选 参数类型 描述 name 是 String 参数名称。 支持数字，英文，下划线，中划线，点，且只能以数字或英文开头。 location 是 String 参数位置 validation 否 String 参数校验表达式，默认为null，不做校验

响应示例 状态码： 200 OK { "content_type" : "json", "created_time" : "2020-09-18T09:25:59Z", "description" : "", "id" : "bd42841c20184da6bbf457c6d8a06e37", "instance" : "f0fa1789-3b76-433b-a787-9892951c620e", "method" : "GET", "modified_time" : "2020-09-18T09:25:59Z", "name" : "livedata_api_demo", "parameters" : [ ], "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "scripts" : [ ], "status" : 1, "type" : "", "version" : "1.0.1" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "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.3084", "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37" } 状态码： 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参数 参数 是否必选 参数类型 描述 api_id 否 String 后端API编号 api_type 否 String API类型 data：数据API function：函数API scripts 否 Array of LdApiScript objects API脚本信息列表 表4 LdApiScript 参数 是否必选 参数类型 描述 ds_id 否 String 数据源编号，当api_type = data时，必选 ds_name 否 String 数据源名称 ds_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) dm : dameng数据源类型(tag:hcs) opengauss : opengauss数据源类型(tag:hcs) type 否 String 脚本类型 SQL：sql语句 SP：存储过程 object_name 是 String 返回对象。 content 是 String API脚本内容 请对脚本进行base64编码 enable_result_paging 否 Boolean 数据脚本是否结果分页，当api_type = data时有效 enable_preparestatement 否 Boolean 数据脚本是否预编译，当api_type = data时有效 created_time 否 String 后端API脚本创建时间 modified_time 否 String 后端API脚本修改时间

请求示例 { "api_id" : "bd42841c20184da6bbf457c6d8a06e37", "api_type" : "function", "scripts" : [ { "type" : "SQL", "object_name" : "fun", "content" : "ZnVuY3Rpb24gZXhlY3V0ZShkYXRhKSB7CiAgICByZXR1cm4gIkhlbGxvIHdvcmxkISIKfQ==" } ] }

响应示例 状态码： 200 OK { "content_type" : "json", "created_time" : "2020-09-18T09:25:59Z", "description" : "", "id" : "bd42841c20184da6bbf457c6d8a06e37", "instance" : "f0fa1789-3b76-433b-a787-9892951c620e", "method" : "GET", "modified_time" : "2020-09-18T09:25:59Z", "name" : "livedata_api_demo", "parameters" : [ ], "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "scripts" : [ { "type" : "SQL", "object_name" : "fun", "content" : "ZnVuY3Rpb24gZXhlY3V0ZShkYXRhKSB7CiAgICByZXR1cm4gIkhlbGxvIHdvcmxkISIKfQ==", "created_time" : "2020-09-19T06:29:35Z", "modified_time" : "2020-09-19T06:29:35Z" } ], "status" : 1, "type" : "", "version" : "1.0.1" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName: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.3081", "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数。 size Integer 本次返回数量。 items Array of Source objects 数据源列表。 表5 Source 参数 参数类型 描述 source_id Integer 源数据源ID。 product_id Integer 产品ID group_id Integer 设备分组ID device_id Integer 设备ID，不填为全部设备。 topic String 主题，当设备ID为空时为产品级主题，设备ID不为空时为设备级主题。 device_name String 设备名称。 product_name String 产品名称。 group_name String 设备分组名称。 is_base64 Integer 是否payload使用base64，0-是，1-否。 contain_device_info Integer 是否包含设备信息，0-是，1-否。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "items" : [ { "source_id" : 35296, "product_id" : 122893, "device_id" : 711568, "topic" : "/v1/devices/214/datas", "device_name" : "device", "product_name" : "product", "is_base64" : 0, "contain_device_info" : 0 } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-rulesrc.query]. Parameter is [rule_oid]. 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" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-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" }

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "items" : [ { "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.pageQuery]. Parameter is [status]. Processor is [query].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "SCB.00000000", "error_msg" : "Not Found", "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" }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 task_name 是 String 任务名称，只能以字母、数字为开头，包含字母、数字和 . _ - 3~100个字符。 task_id 否 String 任务ID，可以为空。 task_type 否 String 任务类型，目前组合任务仅支持实时任务。 REALTIME (实时) TIMING (定时) description 否 String 描述信息。 task_tag 否 String 任务标签，只能包含字母、数字、中划线、下划线。 operation_types 是 Array of strings 需要支持的操作类型，支持多选，至少需要选择以下一种： INSERT UPDATE DELETE source_app_id 否 String 源端数据源所属集成应用ID。 target_app_id 否 String 目标端数据源所属集成应用ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 task_id String 任务ID, 可为空。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 创建一个数据集成组合任务，任务类型为实时任务，包含插入、更新和删除操作 { "task_name" : "cdctest1", "task_id" : "a9fe65f41****6a5d646477c52", "task_type" : "REALTIME", "description" : "create", "task_tag" : "combination", "operation_types" : [ "INSERT", "UPDATE", "DELETE" ], "source_app_id" : "d5afd9af-a8fe-47f6-a98c-edbcba11a0da", "target_app_id" : "d5afd9af-a8fe-47f6-a98c-edbcba11a0da" }

响应示例 状态码： 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 OK { "histories" : { "api_id" : "1d0432f1a82a49d08b9308ae7bd96ca6", "deploy_time" : "2020-09-28T11:01:09Z", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "group_id" : "01ce7564a2544713b80c7c08eb85f5d0", "id" : "abbe44b56eda428d84172343674c9cd6", "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37" } } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "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.3084", "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应示例 状态码：200 ROMA实例连接数信息 { "fdi" : { "connect_count" : 0, "all_datasource_count" : 7, "all_tasks_count" : 0, "all_running_tasks_count" : 0, "all_common_tasks_count" : 0, "running_common_tasks_count" : 0, "abnormal_common_tasks_count" : 0, "terminated_common_tasks_count" : 0, "completed_common_tasks_count" : 0, "all_cdc_tasks_count" : 0, "running_cdc_tasks_count" : 0, "abnormal_cdc_tasks_count" : 0, "terminated_cdc_tasks_count" : 0, "completed_cdc_tasks_count" : 0, "all_flow_tasks_count" : 0, "running_flow_tasks_count" : 0, "abnormal_flow_tasks_count" : 0, "terminated_flow_tasks_count" : 0, "completed_flow_tasks_count" : 0 }, "apic" : { "connection_num" : 7, "api_num" : 37, "api_num_without_livedata" : 26, "livedata_api_num" : 18 }, "mqs" : { "connection_numbers" : 2, "topic_numbers" : 4, "partition_numbers" : 10, "consumer_group_numbers" : 0, "total_queue_numbers" : 0 }, "link" : { "products" : { "total" : 1, "normal_products_numbers" : 1, "gateway_products_numbers" : 0 }, "connections" : { "connection_numbers" : 1 }, "product_templates" : { "product_templates_numbers" : 0 }, "devices" : { "total" : 1, "normal_devices" : { "total" : 1, "never_connected" : 1, "online" : 0, "offline" : 0 }, "gateway_devices" : { "total" : 0, "never_connected" : 0, "online" : 0, "offline" : 0 }, "subsets_devices" : { "total" : 0, "never_connected" : 0, "online" : 0, "offline" : 0 } } } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 fdi fdi object fdi连接数信息 apic apic object apic连接数信息 mqs mqs object mqs连接数信息 link link object link连接数信息 表4 fdi 参数 参数类型 描述 connect_count Integer 连接数 all_datasource_count Integer 数据源总数量 all_tasks_count Integer 总任务数量 all_running_tasks_count Integer 运行中的任务总数量 all_common_tasks_count Integer 普通任务总数量 running_common_tasks_count Integer 运行中的普通任务数量 abnormal_common_tasks_count Integer 异常的普通任务数量 terminated_common_tasks_count Integer 中止的普通任务数量 completed_common_tasks_count Integer 已完成的普通任务数量 all_cdc_tasks_count Integer cdc任务总数量 running_cdc_tasks_count Integer 运行中cdc任务数量 abnormal_cdc_tasks_count Integer 异常cdc任务数量 terminated_cdc_tasks_count Integer 中止的cdc任务数量 completed_cdc_tasks_count Integer 已完成的cdc任务数量 all_flow_tasks_count Integer 编排任务总数量 running_flow_tasks_count Integer 运行中的编排任务数量 abnormal_flow_tasks_count Integer 异常的编排任务数量 terminated_flow_tasks_count Integer 停止的编排任务数量 completed_flow_tasks_count Integer 已完成的编排任务数量 表5 apic 参数 参数类型 描述 connection_num Integer 连接数 api_num Integer api数量 api_num_without_livedata Integer 托管类API（非自定义后端发布生成的API）数量 livedata_api_num Integer 自定义后端（函数后端或者数据后端）数量 表6 mqs 参数 参数类型 描述 connection_numbers Integer 连接数 topic_numbers Integer topic数量 partition_numbers Integer 分区数量 consumer_group_numbers Integer 消费组数量 total_queue_numbers Integer 队列数量 表7 link 参数 参数类型 描述 products products object 产品连接数信息 connections connections object 连接数信息 product_templates product_templates object 产品模板 devices devices object 设备信息 表8 products 参数 参数类型 描述 total Integer 总量 normal_products_numbers Integer 普通产品数量 gateway_products_numbers Integer 网关产品数量 表9 connections 参数 参数类型 描述 connection_numbers Integer 连接数数量 表10 product_templates 参数 参数类型 描述 product_templates_numbers Integer 产品模板数量 表11 devices 参数 参数类型 描述 total Integer 设备总量 normal_devices normal_devices object 普通设备信息 gateway_devices gateway_devices object 网关设备信息 subsets_devices subsets_devices object 网关子设备信息 表12 normal_devices 参数 参数类型 描述 total Integer 总量 never_connected Integer 未连接普通设备 online Integer 在线普通设备 offline Integer 离线普通设备 表13 gateway_devices 参数 参数类型 描述 total Integer 总量 never_connected Integer 未连接网关设备 online Integer 在线网关设备 offline Integer 离线网关设备 表14 subsets_devices 参数 参数类型 描述 total Integer 总量 never_connected Integer 未连接网关子设备 online Integer 在线网关子设备 offline Integer 离线网关子设备

响应示例 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device.batchDelete]. Parameter is [request]. Processor is [body].", "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 表4 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 code String 响应码 start_time Long 统计起始时间UTC的时间戳 end_time Long 统计结束时间UTC的时间戳 list Array of StatisticsRomaApp objects APP维度下不同周期指标列表 表5 StatisticsRomaApp 参数 参数类型 描述 max_latency Integer 最大延时 avg_latency Float 平均延时 req_count Integer 请求总次数 req_count2xx Integer 2xx响应码总次数 req_count4xx Integer 4xx响应码总次数 req_count5xx Integer 5xx响应码总次数 req_count_error Integer 错误次数 max_inner_latency Integer 最大网关内部延时 avg_inner_latency Float 平均网关内部延时 max_backend_latency Integer 最大后端延时 avg_backend_latency Float 平均后端延时 output_throughput Long 下行吞吐量（byte） input_throughput Long 上行吞吐量（byte） current_minute Long 当前时间的UTC格式的时间戳 req_time String 请求时间 cycle String 查询统计周期 roma_app_id String 集成应用编号 provider String 项目编号 register_time String 注册时间 status Integer 状态值： 1：调度中，未上报CES 2：已经成功上报CES 预留字段，暂不支持 状态码： 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 { "code" : "APIG.0000", "start_time" : 1599112186, "end_time" : 1599616186, "list" : [ { "current_minute" : 1599552000, "max_latency" : 0, "avg_latency" : 0, "max_inner_latency" : 0, "avg_inner_latency" : 0, "max_backend_latency" : 0, "avg_backend_latency" : 0, "req_count" : 5, "req_count2xx" : 0, "req_count4xx" : 0, "req_count5xx" : 5, "req_count_error" : 5, "output_throughput" : 1695, "input_throughput" : 2990, "req_time" : "" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 orchestrations Array of OrchestrationBaseResp objects 本次查询到的编排规则列表。 表5 OrchestrationBaseResp 参数 参数类型 描述 orchestration_name String 编排映射规则名称。 支持英文，数字，下划线，且只能以英文开头，3-64个字符，同一实例下不允许重名。 orchestration_strategy String 编排策略，有以下几种策略类型： list：列表； hash：哈希； range：区间； hash_range: 哈希+区间； none_value: 空值映射； default: 默认值映射； head_n: 截取前n项； tail_n: 截取后n项； 当编排策略为list时，orchestration_map列表长度*map_param_list长度不超过3000。 orchestration_mapped_param OrchestrationMappedParam object 编排后的参数配置，isPreprocessing为false时必填。 is_preprocessing Boolean 是否为预处理策略，预处理策略只会生成临时参数作为后面参数编排规则的入参标记。当为预处理策略时，该编排规则不能作为除default之外的最后一个编排规则。 orchestration_id String 编排规则编号。 orchestration_create_time String 编排规则创建时间。 orchestration_update_time String 编排规则更新时间。 表6 OrchestrationMappedParam 参数 参数类型 描述 mapped_param_name String 编排后的请求参数名，只支持英文，数字，中划线，必须以英文开头，1-128个字符，不能与已有的参数重名，默认会透传到后端。 mapped_param_type String 编排后的参数类型，支持string和number。 mapped_param_location String 编排后的参数位置，支持query和header。 状态码： 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 错误描述

响应示例 状态码： 200 OK { "total" : 2, "size" : 2, "orchestrations" : [ { "orchestration_id" : "76545e81d9cb4424bf704ef2b0ac7600", "orchestration_name" : "orchestration_demo_1", "orchestration_create_time" : "2023-07-02T12:31:23.353Z", "orchestration_update_time" : "2023-07-02T13:31:23.353Z", "orchestration_strategy" : "list", "orchestration_mapped_param" : { "mapped_param_name" : "shared-tag", "mapped_param_type" : "number", "mapped_param_location" : "header" } }, { "orchestration_id" : "yt655e81d9cb4424bf704ef2b0ac7600", "orchestration_name" : "orchestration_demo_2", "orchestration_create_time" : "2023-07-02T12:31:23.353Z", "orchestration_update_time" : "2023-07-02T13:31:23.353Z", "orchestration_strategy" : "range", "orchestration_mapped_param" : { "mapped_param_name" : "shared-tag", "mapped_param_type" : "number", "mapped_param_location" : "header" } } ] } 状态码： 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.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" }

响应示例 状态码： 200 OK { "code" : "APIG.0000", "start_time" : 1599508511, "end_time" : 1599616511, "app_req_count" : [ { "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0", "app_name" : "ycs-product", "req_count" : 5 } ], "app_req_count_error" : [ { "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0", "app_name" : "ycs-product", "req_count" : 5 } ], "app_input_throughput" : [ { "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0", "app_name" : "ycs-product", "input_throughput" : 2990 } ], "app_output_throughput" : [ { "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0", "app_name" : "ycs-product", "output_throughput" : 1695 } ], "app_avg_latency" : [ { "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0", "app_name" : "ycs-product", "avg_latency" : 0 } ], "app_avg_backend_latency" : [ { "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0", "app_name" : "ycs-product", "avg_backend_latency" : 0 } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }