华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 succ_num Integer 导入成功的产品数。 fail_num Integer 导入失败的产品数。 fail_objects_ids Array of strings 导入失败的产品名称列表。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。

响应示例 状态码： 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." }

请求参数 表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，不可为空。 target_datasource_id 是 String 目标端数据源ID，不可为空。 source_columns 否 Array of MultiTaskColumnInfo objects 源端字段列表。 target_columns 否 Array of MultiTaskColumnInfo objects 目标端字段列表。 source_table 否 String 源表名。 target_table 否 String 目标表名。 mapping_columns 否 Array of MappingInfo objects 字段映射列表。 表4 ext_info 参数 是否必选 参数类型 描述 server_id 否 String MySQL的serverId。数据源为MySQL时，ServerID必填。 表5 MultiTaskColumnInfo 参数 是否必选 参数类型 描述 field_name 否 String 字段名。 field_type 否 String 字段类型。 field_length 否 String 字段长度。 表6 MappingInfo 参数 是否必选 参数类型 描述 source_column 否 String 源端字段。 source_column_type 否 String 源端字段类型。 source_column_length 否 String 源端字段长度。 target_column 否 String 目标端字段。 target_column_type 否 String 目标端字段类型。 target_column_length 否 String 目标端字段长度。

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 mapping_id String 映射唯一ID。 状态码： 400 表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 { "total" : 1, "size" : 1, "items" : [ { "id" : 1528605, "name" : "/v1/devices/device/datas", "description" : "Device data report", "permission" : 0, "is_private" : 0 } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device-topics.queryTopics]. 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" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数。 size Integer 本次返回数量。 items Array of Topic objects 主题列表。 表5 Topic 参数 参数类型 描述 id Integer Topic的ID。 name String Topic的名称。 description String Topic描述。 permission Integer Topic权限，主题权限，0-发布，1-订阅。 is_private Integer Topic类型，0-基础Topic，1-用户自定义Topic。 状态码： 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。

响应示例 状态码： 400 Bad Request { "error_code" : "string", "error_msg" : "string", "request_id" : "string" } 状态码： 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" : "string", "error_msg" : "string", "request_id" : "string" }

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

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "name" : "Api_http", "type" : 1, "version" : "V0.0.1", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "auth_type" : "AUTHORIZER", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "cors" : false, "match_mode" : "NORMAL", "backend_type" : "HTTP", "remark" : "Web backend API", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "body_remark" : "", "result_normal_sample" : "", "result_failure_sample" : "", "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac", "tags" : [ "webApi" ], "roma_app_id" : "f37f5e81d9cb4424bf704ef2b0ac7600", "domain_name" : "", "id" : "5f918d104dc84480a75166ba99efff21", "status" : 1, "arrange_necessary" : 2, "register_time" : "2020-07-31T12:42:51Z", "update_time" : "2020-08-02T16:32:47.046289Z", "group_name" : "api_group_001", "group_version" : "V1", "run_env_name" : "RELEASE", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id" : "6f918d104dc84480a75166ba99efff41", "publish_time" : "2020-07-31 12:42:51", "roma_app_name" : "roma-3xfg", "ld_api_id" : "", "backend_api" : null, "api_group_info" : null, "req_params" : null } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "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" }

响应示例 状态码： 200 OK { "dispatch_id" : "a0f7fa9897da423dadbe8391d7ea7a43", "task_id" : "15366328208d4d77b76532fe9f4006a6", "start_datetime" : 1605339505609, "period" : "DAY", "dispatch_interval" : 1, "created_date" : 1605311230685, "last_modified_date" : 1605311230685, "remark" : "123", "use_quartz_cron" : false }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 dispatch_id String 调度计划ID。 task_id String 调度计划关联的任务ID。 start_datetime Integer 调度计划的执行开始时间，上限2147512447000，下限946684800000。 period String 调度计划执行周期的时间单位，当使用cron表达式时，为空。 MIN (分钟) HOUR (小时) DAY (日) WEEK (周) MON (月) dispatch_interval Integer 调度计划的执行间隔时间周期。 created_date Integer 调度计划的创建时间。 last_modified_date Integer 调度计划最近一次的修改时间。 remark String 调度计划的备注信息。 use_quartz_cron Boolean 调度计划是否使用cron表达式，允许如下值： true (使用cron表达式) false (不使用cron表达式) cron String 调度计划的cron表达式。 cron_timezone String 时区信息 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 201 OK { "app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3", "call_limits" : 1000, "create_time" : "2020-09-19T15:27:47.60571141+08:00", "name" : "ClientQuota_demo", "reset_time" : "2020-09-20 00:00:00", "time_interval" : 1, "time_unit" : "DAY" } 状态码： 400 Bad Request { "error_code" : "APIG.3325", "error_msg" : "The API quota name already exists" } 状态码： 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参数 参数 参数类型 描述 app_quota_id String 凭据配额编号 name String 配额名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3-255字符 call_limits Integer 凭据配额的访问次数限制 time_unit String 限定时间单位：SECOND:秒、MINUTE:分、HOUR:时、DAY:天 time_interval Integer 配额的限定时间值 remark String 参数说明和描述 reset_time String 首次配额重置时间点，不配置默认为首次调用时间计算 create_time String 创建时间 bound_app_num Integer 配额策略已绑定应用数量 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 { "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "match_mode" : "NORMAL", "name" : "Api_http", "auth_type" : "APP", "backend_type" : "HTTP", "backend_api" : { "vpc_status" : 1, "vpc_info" : { "vpc_id" : "56a7d7358e1b42459c9d730d65b14e59", "vpc_proxy_host" : "www.example.com" }, "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/benchmark", "timeout" : 5000 }, "cors" : false, "req_protocol" : "HTTPS", "req_uri" : "/test/http", "remark" : "Web API", "type" : 1, "req_method" : "GET", "result_normal_sample" : "normal result", "result_failure_sample" : "failure result", "backend_params" : [ { "name" : "X-CONSTANT-HEADER", "value" : "demo", "location" : "HEADER", "origin" : "CONSTANT", "remark" : "constant_demo" }, { "name" : "app-id", "value" : "$context.appId", "location" : "HEADER", "origin" : "SYSTEM", "remark" : "provider roma app id" } ], "tags" : [ "webApi" ] }

响应示例 状态码： 200 OK { "id" : "5f918d104dc84480a75166ba99efff21", "tags" : [ "webApi" ], "arrange_necessary" : 2, "backend_type" : "HTTP", "auth_type" : "APP", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "backend_api" : { "update_time" : "2020-08-02T16:32:47.077028841Z", "vpc_status" : 1, "vpc_info" : { "vpc_id" : "56a7d7358e1b42459c9d730d65b14e59", "vpc_proxy_host" : "www.example.com" }, "url_domain" : "56a7d7358e1b42459c9d730d65b14e59", "req_protocol" : "HTTPS", "id" : "1ce8fda3586d4371bd83c955df37e102", "req_method" : "GET", "register_time" : "2020-07-31T12:42:51Z", "req_uri" : "/test/benchmark", "timeout" : 5000, "status" : 1 }, "cors" : false, "status" : 1, "group_name" : "api_group_001", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "group_version" : "V1", "match_mode" : "NORMAL", "name" : "Api_http", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "type" : 1, "version" : "V0.0.1", "result_normal_sample" : "normal result", "result_failure_sample" : "failure result", "register_time" : "2020-07-31T12:42:51Z", "update_time" : "2020-08-02T16:32:47.046288842Z", "remark" : "Web backend API", "backend_params" : [ { "name" : "X-CONSTANT-HEADER", "value" : "demo", "location" : "HEADER", "origin" : "CONSTANT", "remark" : "constant_demo", "id" : "8cb2eba19e7a4423a4e835647a8b8d76" }, { "name" : "app-id", "value" : "$context.appId", "location" : "HEADER", "origin" : "SYSTEM", "remark" : "provider roma app id", "id" : "216ddda836e74d528f364ff589d9dd21" } ] } 状态码： 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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应示例 状态码： 200 OK { "user_name" : "4MjxbCl4q461", "password" : "*************" } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device.queryAuthentication]. 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" }

响应示例 状态码： 201 Created { "config" : "on", "enable" : true, "id" : "db9a9260cd3e4a16a9b5747a65d3ffaa", "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e", "name" : "app_api_key", "update_time" : "2020-08-24T01:17:31.041984021Z" } 状态码： 400 Bad Request { "error_code" : "APIG.2000", "error_msg" : "unrecognized feature app-api-key" } 状态码： 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-9892951c620e" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 id String 特性编号 name String 特性名称 enable Boolean 是否开启特性 config String 特性参数配置 instance_id String 实例编号 update_time String 实例特性更新时间 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 特性名称 enable 是 Boolean 是否开启特性 config 否 String 特性参数配置

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 apps 是 Array of apps objects 应用列表。 tasks 是 Array of tasks objects 任务列表。 表4 apps 参数 是否必选 参数类型 描述 id 否 String 应用ID。 表5 tasks 参数 是否必选 参数类型 描述 id 否 String 任务ID。

请求示例 批量导出集成资产，导出多个集成应用和数据集成任务。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/assets/export { "apps" : [ { "id" : "b1e6b1e6-4f3f-4a80-bb45-f4b9039f95a3" }, { "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a4" } ], "tasks" : [ { "id" : "b2e6a456-1234-4a80-aa45-f4b8029f95a4" }, { "id" : "123456648-4f3f-4a80-aa45-f4b00005a42" } ] }

响应示例 状态码：200 OK { "job_id" : "ff8080814dbd65d7014dbe0d84db0013" } 状态码：403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 job_id String 资产导出作业的ID，可用于查询作业进度，获取导出作业进度。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

请求示例 { "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37", "auth_type" : "APP", "backend_timeout" : 5000, "cors" : false, "deploy_front_api" : true, "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "group_id" : "01ce7564a2544713b80c7c08eb85f5d0", "method" : "GET", "path" : "/test/function", "protocol" : "HTTPS", "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 ld_api_id 否 String 部署的后端API编号 deploy_front_api 否 Boolean 是否自动发布API true：部署完成后自动创建并发布前端API。此时auth_type，group_id，env_id，protocol必填。 false：部署完成后不创建前端API auth_type 否 String 认证方式 NONE：无认证 APP：APP认证 IAM：IAM认证 AUTHORIZER：自定义认证 authorizer_id 否 String 自定义认证编号。 认证方式auth_type = AUTHORIZER时必填 group_id 否 String 部署的前端API分组编号 env_id 否 String 部署的环境编号 protocol 否 String 请求协议 backend_timeout 否 Integer 超时时间 path 否 String 请求路径 method 否 String 请求方式 cors 否 Boolean 是否支持跨域 true：支持 false：不支持 roma_app_id 否 String 部署到前端的api归属的应用编号，与后端归属的应用编号保持一致

响应示例 状态码： 200 OK { "api_definition" : { "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-19T06:29:35Z", "name" : "livedata_api_demo", "parameters" : [ ], "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "roma_app_name" : "app-demo", "scripts" : [ { "type" : "SQL", "object_name" : "fun", "content" : "ZnVuY3Rpb24gZXhlY3V0ZShkYXRhKSB7CiAgICByZXR1cm4gIkhlbGxvIHdvcmxkISIKfQ==", "created_time" : "2020-09-19T06:29:35Z", "modified_time" : "2020-09-19T06:29:35Z" } ], "status" : 4, "type" : "function", "version" : "1.0.1" }, "api_id" : "1d0432f1a82a49d08b9308ae7bd96ca6", "deploy_time" : "2020-09-19T06:58:13Z", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "group_id" : "01ce7564a2544713b80c7c08eb85f5d0", "id" : "5e19590f54444d8a9b8fe698ce26e9fe", "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:auth_type. 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" } 状态码： 409 Conflict { "error_code" : "APIG.3479", "error_msg" : "the roma app used for deploy must be the same as the roma app of the ld api" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应示例 状态码： 200 OK { "user_name" : "4MjxbCl4q461", "password" : "*************" } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.queryAuthentication]. Parameter is [productId]. 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 { "total" : 91, "size" : 1, "permissions" : [ "modify" ], "topics" : [ { "policiesOnly" : false, "name" : "topic-test", "replication" : 3, "partition" : 3, "retention_time" : 72, "sync_replication" : false, "sync_message_flush" : false, "app_id" : "ba1408c8-xxxx-xxxx-xxxx-21a218f4xxxx", "app_name" : "app-test", "permissions" : [ "read", "access", "delete", "modify" ], "external_configs" : { }, "description" : "", "sensitive_word" : "", "topic_type" : 0 } ], "remain_partitions" : 37, "max_partitions" : 300 } 状态码：400 Bad Request { "error_code" : 400, "error_msg" : "Bad Request" } 状态码：403 Forbidden { "error_code" : 403, "error_msg" : "Forbidden" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer Topic的总数。 size Integer 当前查询的Topic数量。 permissions Array of strings 允许操作的权限。 topics Array of topics objects Topic列表。 remain_partitions Integer 剩余分区数。 max_partitions Integer 分区总数。 表5 topics 参数 参数类型 描述 policiesOnly Boolean 是否只更新策略。 name String Topic名称。 replication Integer 副本数，配置数据的可靠性。 partition Integer Topic分区数，设置消费的并发数。 retention_time Integer 消息老化时间。 sync_message_flush Boolean 是否使用同步落盘。默认值为false。同步落盘会导致性能降低。 sync_replication Boolean 是否开启同步复制，开启后，客户端生产消息时相应的也要设置acks=-1，否则不生效,默认关闭。 app_id String 集成应用Key。 app_key String 集成应用Key。 app_name String 应用名称。 permissions Array of strings 允许操作的权限。 external_configs Object 其他配置。 description String 描述。 sensitive_word String 敏感字段。 topic_type Integer Topic类型。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

响应示例 状态码： 400 Bad Request { "error_code" : "APIG.2012", "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.3009", "error_msg" : "The app authorization record does not exist,id:dd29b33ae4394e3b924b582c6b40880b" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }