华为云用户手册

响应示例 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services.deleteCommand]. Parameter is [service_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" : "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" }

请求示例 为指定自定义后端创建脚本，后端类型为函数后端，脚本类型为SQL { "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" : "function", "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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_type 否 String API类型 data：数据API function：函数API scripts 否 Array of LdApiScriptBase objects API脚本信息列表 表4 LdApiScriptBase 参数 是否必选 参数类型 描述 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) type 否 String 脚本类型 SQL：SQL语句 SP：存储过程 object_name 是 String 返回对象。 最小长度：1 最大长度：32 content 是 String API脚本内容 请对脚本进行base64编码 最小长度：1 最大长度：100000 enable_result_paging 否 Boolean 数据脚本是否结果分页，当api_type = data时有效 缺省值：false enable_preparestatement 否 Boolean 数据脚本是否预编译，当api_type = data时有效 缺省值：false

响应示例 状态码： 200 OK { "total" : 2, "size" : 2, "apis" : [ { "run_env_name" : "RELEASE", "group_name" : "api_group_001", "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_mock", "remark" : "Mock backend API", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "3a955b791bd24b1c9cd94c745f8d1aad", "type" : 1, "auth_type" : "IAM", "req_uri" : "/test/mock" }, { "run_env_name" : "RELEASE", "group_name" : "APIGroup_d00511069", "publish_id" : "0c613568c8644a1b92172156f77a5759", "group_id" : "d7d0b9a54469424f942e16a6b6026936", "name" : "API_nevj", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "9e07bc00a1864ab4aafd4a23d19dd1c2", "type" : 1, "auth_type" : "APP", "req_uri" : "/fdasf" } ] } 状态码： 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 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" }

响应参数 状态码： 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_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 错误描述

请求参数 表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 { "total" : 1, "size" : 1, "plugins" : [ { "plugin_attach_id" : "8aa097b00e9843efacb9c593d11b769e", "plugin_id" : "5b729aa252764739b3s237ef0d66dc63", "plugin_name" : "跨域插件", "plugin_type" : "cors", "plugin_scope" : "global", "plugin_content" : "{\"allow_origin\": \"*\",\"allow_methods\": \"GET,POST,PUT\",\"allow_headers\": \"Content-Type,Accept,Accept-Ranges,Cache-Control\",\"expose_headers\": \"X-Request-Id,X-Apig-Latency\",\"max_age\": 172800,\"allow_credentials\": true}", "remark" : "CORS跨域资源访问", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name" : "RELEASE", "attached_time" : "2022-11-02T12:31:23.353Z", "create_time" : "2022-11-02T12:31:23.353Z", "update_time" : "2022-11-02T12:31:23.353Z" } ] } 状态码： 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" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins Array of AttachedPluginInfo objects 绑定API的插件列表。 表5 AttachedPluginInfo 参数 参数类型 描述 plugin_attach_id String 插件绑定编码。 plugin_id String 插件编码。 plugin_name String 插件名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3-255字符 说明： 中文字符必须为UTF-8或者unicode编码。 plugin_type String 插件类型 cors：跨域资源共享 set_resp_headers：HTTP响应头管理 kafka_log：Kafka日志推送 breaker：断路器 rate_limit: 流量控制 third_auth: 第三方认证 plugin_scope String 插件可见范围 global：全局可见 app：集成应用可见 env_id String 绑定API的环境编码。 env_name String API授权绑定的环境名称 attached_time String 绑定时间。 plugin_content String 插件定义内容，支持json。 最大长度：65535 remark String 插件描述，255字符。 说明： 中文字符必须为UTF-8或者unicode编码。 最大长度：255 create_time String 创建时间。 update_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 错误描述

响应消息 响应参数 表3 响应参数 名称 类型 描述 clientId string 设备的客户端ID。 dataFormatTrans string 转发消息的数据传输格式。如果开启base64加密，则传输格式为base64/raw；如果不开启base64加密，则传输格式为json/raw。 deviceOid integer 设备ID。 instanceNo integer 数据源端实例的编号。 productOid integer 产品ID。 ruleOid integer 规则ID。 ruleSrcLevel integer 规则的级别，0为产品级，1为设备级。 ruleSrcOid integer 规则源ID。 topicName string 主题名。 响应示例 { "clientId": "D5695180f67c7200", "topicName": "7aANi9569518/out/ device01", "ruleSrcOid": 38, "ruleOid": 600004, "ruleSrcLevel": 1, "productOid": 569518, "deviceOid": 354769, "instanceNo": 1212, "dataFormatTrans": "json/raw" }

请求消息 请求参数 表2 Body参数 参数 类型 是否必填 说明 app_id string 否 应用ID，当系统中规则不存在，则该参数为必选。 rule_name string 是 系统中已经创建好的规则名称，如果规则不存在，默认创建该规则。 level string 是 规则的级别，产品级填‘product’，设备级填‘device’。 product_name string 是 系统中已经创建好的产品的产品名。 device_name string 否 系统中已经创建的设备名，当规则级别是产品级时，不用传设备名的参数。 topic string 否 设备对应的Topic的名称，只能使用pub权限的Topic，每个设备的Topic只能添加到一个规则下面，不能重复添加到不同的规则，当规则的级别是产品级时，不用传Topic的参数。 is_base64 boolean 是 转发的消息是否要进行base64编码，传入true会对消息进行base64编码。 contain_deviceinfo boolean 否 转发的消息是否要包含设备的信息，传入true会在原始消息的基础上增加额外设备的信息。 请求示例 https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1/rules/sources { "app_id" : "app01", "rule_name" : "rule01", "product_name" : "product01", "device_name" : "device01", "topic" : "7aANi9569518/out/ device01", "is_base64" : false, "contain_deviceinfo" : false, "level" : "device" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 topic 是 String Topic名称。 partition 是 Integer 分区。 message_offset 是 Number 消息偏移量。 consumer_key 否 String 应用Key。在该消息头中添加一个consumer_key的消息头。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 topic String Topic名称。 partition Integer 分区。 message_offset Integer 消息偏移量。 consumer_key String 应用Key。在该消息头中添加一个consumer_key的消息头。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

响应示例 状态码： 200 OK { "topic" : "topic-test", "partition" : 0, "message_offset" : 4, "consumer_key" : "keyA" } 状态码： 400 Bad Request { "error_code" : 400, "error_msg" : "Bad Request" } 状态码： 403 Forbidden { "error_code" : 403, "error_msg" : "Forbidden" }

请求示例 重发偏移量为4的消息，并为该消息添加指定消息头 POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messages/action?action_id=resend { "topic" : "topic-test", "partition" : 0, "message_offset" : 4, "consumer_key" : "keyA" }

响应示例 状态码： 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" } } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.update]. 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 表4 响应Body参数 参数 参数类型 描述 permissions Array of strings 权限。 id Integer 产品ID 最小值：1 最大值：99999999999999999 product_serial String 产品唯一序列（系统唯一值，用于MQS的TOPIC中标记产品）。 最小长度：0 最大长度：64 app_id String 应用ID。 最小长度：0 最大长度：64 name String 产品名称，创建产品时租户内唯一，长度最大64，仅支持中文、英文字母、数字、下划线和中划线。 最小长度：0 最大长度：64 manufacturer_id String 产品供应商ID。 最小长度：0 最大长度：64 manufacturer_name String 厂商名称。 最小长度：0 最大长度：64 model String 产品型号。 最小长度：0 最大长度：64 product_type Integer 产品类型，0-普通产品(不支持子设备) 1-网关产品。 最小值：0 最大值：10 description String 产品描述，长度0-200。 最小长度：0 最大长度：200 protocol_type Integer 产品的协议类型，0-mqtt 1-CoAP 2-modbus 4-opcua 5-扩展协议。 最小值：0 最大值：10 device_type String 产品的设备类型（默认Default）。 最小长度：0 最大长度：64 version String 产品版本。 最小长度：0 最大长度：64 created_user CreatedUser object 创建时的用户。 last_updated_user LastUpdatedUser object 最后更新时的用户。 created_datetime Long 创建时间，timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 app_name String 应用名称。 最小长度：0 最大长度：256 data_format Integer data_format 0-JSON 1-USER_DEFINED 最小值：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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 产品名称，创建产品时租户内唯一，长度1-64，仅支持中文、英文字母、数字、下划线和中划线。 最小长度：0 最大长度：64 description 否 String 产品描述，长度0-200。 最小长度：0 最大长度：200 manufacturer_id 是 String 产品供应商ID，支持英文大小写、数字、下划线和中划线，长度2-50。 最小长度：0 最大长度：64 manufacturer_name 是 String 厂商名称，支持长度2-64。 最小长度：0 最大长度：64 model 是 String 产品型号，支持英文大小写、数字、下划线、中划线和空格(首尾空格会被忽略)，长度2-50。 最小长度：0 最大长度：64 device_type 是 String 产品的设备类型（默认Default Type）。 最小长度：0 最大长度：64 version 否 String 模型版本。 最小长度：0 最大长度：64

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 destination_id Integer 目标数据源ID。 最小值：1 最大值：99999999999999999 destination_type Integer 操作类型，枚举值：0-目标端为本ROMA实例内MQS；7-目标端为设备。 最小值：0 最大值：10 app_id String 应用ID，目标端为0时需明确对方的APP_ID。 最小长度：0 最大长度：64 destination_name String 目标数据源名称。 最小长度：0 最大长度：255 topic String 目标数据源主题。 最小长度：0 最大长度：64 server String 目标端数据源服务。 最小长度：0 最大长度：200 token String 目标端数据源Token。 最小长度：0 最大长度：1000 tag String 目标数据源标签。 最小长度：0 最大长度：200 mqs_sasl_ssl Boolean 目标端数据源MQS的SASL字段是否需要支持SSL加密。 user_name String 目标数据源用户名。 最小长度：0 最大长度：80 password String 目标数据源密码。 最小长度：0 最大长度：500 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

请求示例 为指定规则添加目标端数据源，目标类型为MQS，目标端不支持SSL加密。 { "destination_type" : 0, "app_id" : "ef3845be-091a-4ab5-869a-9de0025e2165", "destination_name" : "destination", "topic" : "/target_topic1", "server" : "xx.xx.xx.xx", "token" : "sd123r12312w12wdrfvgrt4t34t", "tag" : "tag1", "mqs_sasl_ssl" : false, "user_name" : "user1", "password" : "**********" }

响应示例 状态码： 201 Created { "destination_id" : 27678, "destination_type" : 7, "app_id" : null, "destination_name" : null, "topic" : "8si8ST122893/in/214", "server" : "server", "token" : "token", "tag" : "device", "mqs_sasl_ssl" : "false", "user_name" : null, "password" : null } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-ruledest.save]. 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 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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 destination_type 是 Integer 操作类型，枚举值：0-目标端为ROMA实例MQS；1-目标端为本ROMA实例内FI KAFKA数据源； 2-目标端为本ROMA实例内 MRS KAFKA数据源；3-目标端为本ROMA实例内KAFKA数据源；6-目标端为DIS数据源；7-目标端为设备。 最小值：0 最大值：7 app_id 否 String 应用ID，destination_type值为0时，为MQS的Topic所属集成应用APP_ID；destination_type值为1、2或3时，为对应KAFKA类数据源所属集成应用APP_ID，destination_type值为7时，为设备所属集成应用APP_ID。 最小长度：0 最大长度：64 destination_name 否 String 目标数据源名称，destination_type值为1、2或3时， 为对应KAFKA类数据源的名称。 最小长度：0 最大长度：255 topic 是 String 目标数据源主题，destination_type值为0时，从MQS服务中获取已有Topic；destination_type值为1、2或3时， 从对应KAFKA类数据源中获取已有Topic。 最小长度：0 最大长度：64 server 否 String 目标端数据源服务，如下情况时server字段必填：destination_type值为0时， 为MQS连接地址；destination_type值为1、2或3时， 为KAFKA类数据源的连接地址，destination_type值为7时，为设备所属产品的产品名。 最小长度：0 最大长度：64 token 否 String 目标端数据源token，destination_type值为7时，为设备的ClientID。 最小长度：0 最大长度：1000 tag 否 String 目标数据源标签，destination_type值为7时，为设备的设备名。 最小长度：0 最大长度：64 mqs_sasl_ssl 否 Boolean 目标端数据源MQS的SASL字段是否需要支持SSL加密。 user_name 否 String 目标数据源用户名。 最小长度：0 最大长度：64 password 否 String 目标数据源密码。 最小长度：0 最大长度：64

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 mapping_id String 映射唯一ID。 最小长度：1 最大长度：64 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

响应参数 状态码： 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 错误描述

响应示例 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:domain_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.3020", "error_msg" : "The URL domain does not exist" } 状态码： 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参数 参数 是否必选 参数类型 描述 certificate_ids 是 Array of strings 证书的ID集合 verified_client_certificate_enabled 否 Boolean 是否开启客户端证书校验。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。

响应示例 状态码： 200 OK { "property_id" : 3320, "property_name" : "p2", "description" : null, "data_type" : "datetime", "required" : 0, "min" : 0, "max" : 65536, "step" : 1, "max_length" : "10", "unit" : "yuan", "enum_list" : null } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services-responses.queryCommandResponseDetail]. Parameter is [command_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" : "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 表3 响应Body参数 参数 参数类型 描述 property_id Integer 属性ID。 最小值：1 最大值：99999999999999999 property_name String 属性名称，首位必须为字母，支持大小写字母、数字、中划线及下划线，长度2-50。 最小长度：2 最大长度：50 description String 属性描述，长度0-200。 最小长度：0 最大长度：200 data_type String 属性数据类型，boolean枚举值大小写敏感；number格式为数字，范围±1.0 x 10^-28 to ±7.9228 x 10^28；string为字符串；integer为整数；datetime为时间，格式为yyyyMMddTHHmmss；json为自定义json格式； array为数组类型。 最小长度：0 最大长度：10 required Integer 是否必填，0-非必填，1-必填。 最小值：0 最大值：10 min String 最小值，当data_type为integer或number时有效。 缺省值：0 最小长度：0 最大长度：10 max String 最大值，当data_type为integer或number时有效。 缺省值：65536 最小长度：0 最大长度：10 step String 步长，当data_type为integer或number时有效。 缺省值：1 最小长度：0 最大长度：10 max_length Integer 字符串最大长度，当data_type为string、datetime、json时有效。 最小值：1 最大值：99999999 缺省值：10 unit String 属性单位。 最小长度：0 最大长度：10 enum_list String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 最小长度：0 enum_dict Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64