华为云用户手册

响应示例 状态码： 200 OK { "product_id" : 122888, "topic_id" : 17, "permission" : 1, "topic_name" : "/3.0/${deviceId}/t1", "version" : "3.0", "description" : "description" } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product-topic.updateProductTopic]. 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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 permission 是 Integer 主题权限，0-发布，1-订阅。 name 是 String 主题名称，Topic类格式必须以“/”进行分层，区分每个类目。其中第一个为用户自定义的版本号；第二个已经规定好，为${deviceId}通配设备ID；第三个为用户自定义的Topic类名。Topic类组成即为：/${version}/${deviceId}/${customizePart}。简单来说，Topic类：/v1/${deviceId}/customizePart是具体Topic：/v1/deviceid1/customizePart1和/v1/deviceid2/customizePart2等的集合。 version 是 String 版本号，输入2-50个字符。值以字母或数字开头和结尾。仅允许使用字母、数字、中划线和点号。 description 否 String 描述，长度0-200。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 product_id Integer 归属产品ID。 topic_id Integer 产品主题ID。 permission Integer 主题权限，0-发布，1-订阅。 topic_name String 主题名称。 version String 版本号。 description String 描述。 状态码： 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。

请求参数 表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。

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

请求示例 批量删除集成资产，删除多个集成应用和数据集成任务。 { "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 OK { "name" : "Authorizer_demo", "type" : "FRONTEND", "authorizer_type" : "LD", "authorizer_uri" : "/test", "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" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName: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.3081", "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表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，网关是否接受客户端请求。 id String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 roma_app_name String 自定义认证所属应用名称 表4 Identity 参数 参数类型 描述 name String 参数名称。 支持数字，英文，下划线，中划线，点，且只能以数字或英文开头。 location String 参数位置 validation String 参数校验表达式，默认为null，不做校验 状态码： 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 错误描述

响应示例 状态码： 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.3001", "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist" } 状态码： 412 PreconditionFailed { "error_code" : "APIG.3415", "error_msg" : "The API group cannot be deleted because it contains APIs,id:47eaed4659db4e99ba2e1b642d5d1323" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 401 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 412 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 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.3001", "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 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参数 参数 是否必选 参数类型 描述 app_id 否 String API所属的应用ID format 否 String 导出的API定义的格式 apis 否 Array of strings 导出的自定义后端API ID列表 status 否 Integer 导出的后端API状态： 1：待开发 3：开发中 4：已部署

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 - File 状态码： 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 错误描述

响应示例 状态码：200 OK { "total" : 1, "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "users" : [ { "id" : "string", "name" : "string", "roles" : [ "read, access, delete, modify, admin" ] } ] } 状态码：403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 total Integer 应用的总成员数量。 id String 应用ID。 users Array of users objects 用户成员列表。 表6 users 参数 参数类型 描述 id String 用户ID。 name String 用户名称。 roles Array of strings 应用权限角色。 read：应用下资源只读权限，至少要存在此权限，包括API调试。 access：应用下资源的访问管理权限。 delete：应用下资源的删除权限。 modify：应用下资源的修改权限，包括API发布、下线。 admin：应用和应用下资源的权限。 仅提供admin时，会自动应用其它所有权限。 未提供read时会自动应用read权限。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 users 否 Array of User objects 要添加的用户成员列表，空列表时代表清空应用的所有成员。 表4 User 参数 是否必选 参数类型 描述 id 否 String 用户ID。 roles 否 Array of strings 应用权限角色。 read：应用下资源只读权限，至少要存在此权限，包括API调试。 access：应用下资源的访问管理权限。 delete：应用下资源的删除权限。 modify：应用下资源的修改权限，包括API发布、下线。 admin：应用和应用下资源的权限。 仅提供admin时，会自动应用其它所有权限。 未提供read时会自动应用read权限。

数据集成API错误码 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 FDI.3002 Invalid parameters. 存在非法参数。 参考API文档修改非法参数。 400 FDI.3016 Failed to test the connectivity. 测试连通性失败。 检查数据源配置是否有问题，或联系技术工程师处理。 400 FDI.3019 Failed to stop the real-time task. 停止实时任务失败。 检查任务配置是否有问题，或联系技术工程师处理。 400 FDI.3020 Failed to stop the scheduled task. 停止定时任务失败。 检查任务配置是否有问题，或联系技术工程师处理。 400 FDI.3021 One or more tasks do not exist. 一个或多个任务不存在。 检查任务是否存在。 400 FDI.3022 One or more tasks have empty task IDs. 一个或多个任务具有空的任务ID。 确认task_id是否存在。 400 FDI.3023 One or more tasks are running. 一个或多个任务正在运行。 确认是否有任务正在运行。 400 FDI.3026 Failed to manually start the task. 手动启动任务失败。 检查任务配置是否有问题，或联系技术工程师处理。 400 FDI.3027 Failed to manually stop the task. 手动停止任务失败。 检查任务配置是否有问题，或联系技术工程师处理。 400 FDI.3028 Failed to delete the task. 删除任务失败。 请稍后重试，或者联系技术工程师处理。 400 FDI.3033 Invalid parameter [%s]. 参数【%s】无效。 参考API文档修改参数。 400 FDI.3035 Invalid SQL statement. 无效的SQL语句。 检查SQL语句是否正确。 400 FDI.3037 The parameter in mapping information is invalid or does not match the task. 映射信息中的参数不合法或与任务不匹配。 检查映射信息中的参数。 400 FDI.3039 The project ID is empty or does not match the project ID in the URL. 项目ID为空或与URL中的项目ID不匹配。 检查项目ID。 400 FDI.3043 The data source IP address is not in the valid network segment. 数据源IP不在有效网段内。 检查task_id参数是否正确，修改task_id后重。 400 FDI.3048 Invalid pagination parameters. 分页参数不合法。 请参考API接口文档修改limit和offset参数。 400 FDI.3049 The parameter used for sorting is invalid. 排序参数不合法。 请参考API接口文档修改排序参数。 400 FDI.3050 The running status is invalid. execute_status参数非法。 按照API规范修改execute_status参数。 400 FDI.3051 The length of an SQL statement cannot exceed 20000 characters. SQL语句长度不能超过20000个字符。 检查SQL语句是否长度超出限制。 400 FDI.3057 The instance quota exceeds the upper limit. 实例配额超过上限。 检查实例配额。 400 FDI.3058 The task name already exists. 任务名称已存在。 修改重复任务名。 400 FDI.3059 The data source does not support the real-time integration mode. 数据源不支持实时集成模式。 检查数据源配置。 400 FDI.3060 The data source does not support the scheduled integration mode. 数据源不支持定时集成模式。 检查数据源配置。 400 FDI.3063 The parameter for setting the compensation period is invalid. 时间补偿值参数非法。 检查api的时间补偿值参数。 400 FDI.3064 The parameter for setting the incremental migration category is invalid. 增量迁移类别参数不合法。 检查api的增量迁移类别。 400 FDI.3065 The start time field and end time field must be specified. 开始时间字段和结束时间字段不能为空。 检查开始时间字段和结束时间字段是否为空。 400 FDI.3066 The parameter for setting the time format is invalid. 时间格式参数无效。 检查时间格式。 400 FDI.3067 The parameter for setting the time interval is invalid. 时间间隔参数无效。 检查时间间隔参数。 400 FDI.3069 The parameter for setting the right periodic boundary is invalid. 周期右边界参数无效。 检查周期右边界参数是否正确。 400 FDI.3070 The parameter for setting the right periodic boundary is invalid. 周期右边界参数无效。 检查周期右边界参数是否正确。 400 FDI.3071 The SQL statement of incremental migration does not contain "${{begin}}" and "${{end}}". 增量迁移的SQL语句中不包含“${{begin}}”和“${{end}}”。 检查增量迁移的SQL语句。 400 FDI.3073 The SQL statement is empty. SQL语句为空。 检查SQL语句。 400 FDI.3074 The SQL statement in a non-incremental migration task cannot contain "${{begin}}" and "${{end}}". 非增量迁移任务的SQL语句中不能包含${{begin}}和${{end}}。 检查非增量迁移的SQL语句。 400 FDI.3083 One or more scheduled tasks are not configured with scheduled plans. 一个或多个定时任务没有调度计划。 检查任务是否有调度计划。 400 FDI.3104 Invalid data source. 数据源不合法。 检查数据源配置是否有问题，或联系技术工程师处理。 400 FDI.3137 The number of tasks on the source instance exceeds the upper limit. 源实例任务数超过上限。 检查任务配额。 400 FDI.3138 The number of tasks on the destination instance exceeds the upper limit. 目标实例任务数超过上限。 检查任务配额。 400 FDI.3139 The task is running. 任务已经启动，无法再次启动。 检查任务状态，任务停止后重试。 400 FDI.3140 Non-running instance is not allowed to create or update tasks. 非运行实例不允许创建或更新任务。 检查实例运行状态。 400 FDI.3141 The instance ID is empty. 实例ID为空。 检查实例ID是否为空。 400 FDI.3142 The description length cannot exceed 1024. 描述长度不能超过1024。 减少描述字段长度。 400 FDI.3144 The integration mode can only be Scheduled or Real-Time. 集成方式只能是Scheduled和Real-Time。 检查集成方式字段。 400 FDI.3145 The mapping information is empty or invalid. 映射信息为空或无效。 检查映射信息字段。 400 FDI.3146 The source information or destination information is empty. 源信息或目的信息为空。 检查源端或者目标端是否为空。 400 FDI.3147 The data source does not exist. 数据源不存在。 检查数据源是否存在。 400 FDI.3148 The destination instance does not match the source instance. 目的实例与源实例不匹配。 检查源端或者目标端实例是否匹配。 400 FDI.3149 The task ID is empty. 任务ID为空。 填写任务ID。 400 FDI.3150 The task list is empty. 任务列表为空。 检查任务ID是否正确。 400 FDI.3157 The task name must contain 3 to 100 characters and start with a letter or digit. It can consist of only letters, digits, periods .), and underscores _), and strikethrough -). 任务名称必须以字母或数字开头，长度为3~100个字符。只能由字母、数字、“。”、下划线_)和删除线-)组成。 检查任务名称是否符合规则。 400 FDI.3160 The source and destination instances must be the same. 源实例和目的实例必须相同。 检查源端 或者目标端实例是否相同。 400 FDI.3161 The action must be start or stop. 动作必须是start或stop。 检查action字段。 400 FDI.3165 The task cannot be empty. 任务不能为空。 检查任务ID。 400 FDI.3166 The task details cannot be empty. 任务详情不能为空。 检查任务detail参数。 400 FDI.3173 The data source ID is empty. 数据源ID为空。 检查数据源ID。 400 FDI.3174 The instance ID is empty. 实例ID为空。 检查实例ID。 400 FDI.3179 This instance does not exist. 该实例不存在。 检查实例ID。 400 FDI.3183 The scheduled task that is running cannot be stopped manually. 不能手动停止正在运行的定时任务。 等待任务运行结束。 400 FDI.3435 The appId is invalid or can not find apps by this instance id. appId不合法或根据实例Id找不到应用。 检查应用ID。 400 FDI.3437 The connector ID cannot be empty. connector ID不能为空。 检查连接器ID。 400 FDI.3442 The description exceeds maximum length. 描述超过最大长度。 减少描述信息长度。 400 FDI.3443 Invalid data source type. 数据源类型非法。 检查数据源类型。 400 FDI.3447 Incorrect content. 内容错误。 检查content参数。 400 FDI.3448 The connector instance ID is empty. connector实例ID为空。 检查连接器实例ID。 400 FDI.3449 The connector instance ID is incorrect. connector实例ID错误。 检查连接器实例ID。 400 FDI.3451 The connector ID is not required for non-connectors. 非连接器不需要连接器ID。 删除连接器实例ID。 400 FDI.3467 The task quota in this project is insufficient. 此项目下的任务配额不足。 检查该项目下的任务配额。 400 FDI.3478 You do not have permission to perform operations on this application. 您没有权限操作该应用。 检查是否有权限。 400 FDI.3549 The task cannot be started because the topic used by an instance is being deleted. 实例使用的topic正在删除中，不能启动任务。 等待删除成功后再启动任务。 400 FDI.3557 The task tag is illegal. 任务标签非法。 检查任务标签。 404 FDI.3081 The task does not exist. task_id对应的任务记录不存在。 确认task_id是否有效，修改task_id参数后重试。 404 FDI.3101 The datasource does not exist. 数据源不存在。 检查数据源是否存在。 404 FDI.3108 Task details do not exist. 任务详情不存在。 检查任务details参数。 404 FDI.3109 This task does not exist. 该任务不存在。 检查任务id是否正确。 404 FDI.3180 This task is not in the project. 操作的task不属于当前项目。 检查task_id参数是否正确，修改task_id后重试。 404 FDI.3427 The specified connector is not found. 找不到指定的连接器。 检查指定连接器是否存在。 429 FDI.1007 The number of requests exceeds the upper limit. 并发请求数量超过上限。 请稍后重试，或者联系技术工程师处理。 500 FDI.3017 Failed to start the real-time task. 启动实时任务失败。 检查任务配置是否有问题，或联系技术工程师处理。 500 FDI.3018 Failed to start the scheduled task. 定时任务启动失败。 检查任务配置是否有问题，或联系技术工程师处理。 500 FDI.3030 The task is started. 任务在执行中，不允许进行操作。 等待当前任务结束后再操作。 500 FDI.3121 Failed to delete the data source. 删除数据源失败。 检查是否有关联的任务。 500 FDI.9999 Network error. FDI内部错误。 检查任务配置是否有问题，或联系技术工程师处理。 父主题： 错误码

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "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:37:28Z", "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" : [ ], "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.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 { "total" : 1, "size" : 1, "items" : [ { "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-command.saveProperty]. 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" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数。 size Integer 本次返回数量。 items Array of PropertyResponseBody objects 属性列表。 表5 PropertyResponseBody 参数 参数类型 描述 property_id Integer 属性ID。 property_name String 属性名称，首位必须为字母，支持大小写字母、数字、中划线及下划线，长度2-50。 description String 属性描述，长度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为数组类型。 required Integer 是否必填，0-非必填，1-必填。 min String 最小值，当data_type为integer或number时有效。 max String 最大值，当data_type为integer或number时有效。 step String 步长，当data_type为integer或number时有效。 max_length Integer 字符串最大长度，当data_type为string、datetime、json时有效。 unit String 属性单位。 enum_list String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 enum_dict Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。 method String 访问模式（兼容20.0，R属性可读，W属性可写，E属性可执行）。 状态码： 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。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 topic 是 String Topic名称。 partition 否 Integer 分区编号，默认值为-1，若传入值为-1，则重置所有分区。 message_offset 否 Integer 重置消费进度到指定偏移量。 如果传入offset小于当前最小的offset，则重置到最小的offset。 如果大于最大的offset，则重置到最大的offset。 message_offset、timestamp二者必选其一。 timestamp 否 Integer 重置消费进度到指定时间，格式为unix时间戳，单位为毫秒。 如果传入timestamp早于当前最早的timestamp，则重置到最早的timestamp。 如果晚于最晚的timestamp，则重置到最晚的timestamp。 message_offset、timestamp二者必选其一。

请求示例 POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset { "topic" : "test", "partition" : 0, "message_offset" : 10 } POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset { "topic" : "test", "partition" : 0, "timestamp" : 1571812144000 }

URI PUT /v2/{engine}/{project_id}/mqs/instances/{instance_id}/groups/{group_id}/reset-message-offset 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 instance_id 是 String 实例ID。 engine 是 String 引擎类型。 group_id 是 String 消费组ID。

响应参数 状态码： 401 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表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 错误描述

响应示例 状态码： 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.3001", "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 - File 导出设备列表(.csv格式或.xsl格式)。 状态码： 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" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.exportProduct]. Parameter is [X-Auth-Token]. Processor is [header].", "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" : 2, "size" : 2, "vpc_channels" : [ { "name" : "channel 1", "port" : 8080, "balance_strategy" : 1, "member_type" : "ip", "dict_code" : "", "create_time" : "2020-07-23T07:24:33Z", "id" : "105c6902457144a4820dff8b1ad63331", "status" : 1, "member_groups" : [ ], "type" : 2, "microservice_info" : { "id" : "", "instance_id" : "", "service_type" : "", "cse_info" : { "cse_app_id" : "", "engine_id" : "", "engine_name" : "", "register_address" : "", "service_id" : "", "service_name" : "", "version" : "" }, "cce_info" : { "cluster_id" : "", "cluster_name" : "", "namespace" : "", "workload_type" : "", "app_name" : "" }, "create_time" : "", "update_time" : "" } }, { "name" : "channel 2", "port" : 8088, "balance_strategy" : 2, "member_type" : "ip", "dict_code" : "", "create_time" : "2020-07-23T07:11:57Z", "id" : "56a7d7358e1b42459c9d730d65b14e59", "status" : 1, "member_groups" : [ ], "type" : 3, "microservice_info" : { "id" : "9483afa235be45158a70c19ab817ac65", "project_id" : "73d69ae0cfcf460190522d06b60f05ad", "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e", "service_type" : "CCE", "cse_info" : { "cse_app_id" : "", "engine_id" : "", "engine_name" : "", "register_address" : "", "service_id" : "", "service_name" : "", "version" : "" }, "cce_info" : { "cluster_id" : "ab1485b4f91b45abbcd560be591f7309", "cluster_name" : "cce-test", "namespace" : "default", "workload_type" : "deployment", "app_name" : "testapp" }, "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z" } } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "The request parameters must be specified,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-9892951c620e" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 vpc_channels Array of VpcChannelInfo objects 本次查询到的VPC通道列表 表5 VpcChannelInfo 参数 参数类型 描述 name String VPC通道的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、中划线、下划线、点组成，且只能以英文或中文开头。 说明： 中文字符必须为UTF-8或者unicode编码。 port Integer VPC通道中主机的端口号。 取值范围1 ~ 65535。 balance_strategy Integer 分发算法。 1：加权轮询（wrr） 2：加权最少连接（wleastconn） 3：源地址哈希（source） 4：URI哈希（uri） member_type String VPC通道的成员类型。 ip ecs type Integer vpc通道类型： 2：BUILTIN通道类型 3：微服务类型 vpc_channel_type String vpc通道类型。 builtin：服务器类型 microservice： 微服务类型 reference：引用负载通道类型 当vpc_channel_type为空时，负载通道类型取决于type字段的取值。 当vpc_channel_type不为空，但type字段非空或不为0时，当vpc_channel_type的指定类型与type字段指定的类型冲突时会校验报错。 当vpc_channel_type不为空，且type字段为空或等于0时，直接使用vpc_channel_type字段的值指定负载通道类型。 修改负载通道时vpc通道类型不会修改，直接使用原有的vpc通道类型。 dict_code String VPC通道的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 create_time String VPC通道的创建时间 id String VPC通道的编号 status Integer VPC通道的状态。 1：正常 2：异常 member_groups Array of MemberGroupInfo objects 后端云服务器组列表。 microservice_info MicroServiceInfo object 微服务的响应对象 表6 MemberGroupInfo 参数 参数类型 描述 member_group_name String VPC通道后端服务器组名称。支持汉字、英文、数字、下划线、中划线、点，且只能以英文和汉字开头，3-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 member_group_remark String VPC通道后端服务器组描述。 member_group_weight Integer VPC通道后端服务器组权重值。 当前服务器组存在服务器且此权重值存在时，自动使用此权重值分配权重。 dict_code String VPC通道后端服务器组的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 microservice_version String VPC通道后端服务器组的版本，仅VPC通道类型为微服务时支持。 microservice_port Integer VPC通道后端服务器组的端口号，仅VPC通道类型为微服务时支持。端口号为0时后端服务器组下的所有地址沿用原来负载端口继承逻辑。 microservice_labels Array of MicroserviceLabel objects VPC通道后端服务器组的标签，仅VPC通道类型为微服务时支持。 reference_vpc_channel_id String 引用的负载通道编号，仅VPC通道类型为引用类型（vpc_channel_type=reference）时支持。 member_group_id String VPC通道后端服务器组编号 create_time String VPC通道后端服务器组创建时间 update_time String VPC通道后端服务器组更新时间 表7 MicroserviceLabel 参数 参数类型 描述 label_name String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 label_value String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 表8 MicroServiceInfo 参数 参数类型 描述 id String 微服务编号 instance_id String 实例编号 service_type String 微服务类型： CS E：CSE微服务注册中心 CCE：CCE云容器引擎（暂不支持） CCE_SERVICE: CCE云容器引擎（Service）（暂不支持） NACOS: nacos引擎，nacos_info必填 cse_info MicroServiceInfoCSE object CSE基础信息 cce_info MicroServiceInfoCCE object CCE基础信息（暂不支持） cce_service_info MicroServiceInfoC CES ervice object CCE微服务Service信息 nacos_info MicroServiceInfoNacosBase object nacos基础信息。 update_time String 微服务更新时间 create_time String 微服务创建时间 表9 MicroServiceInfoCSE 参数 参数类型 描述 engine_id String 微服务引擎编号 service_id String 微服务编号 engine_name String 微服务引擎名称 service_name String 微服务名称 register_address String 注册中心地址 cse_app_id String 微服务所属的应用 version String 微服务的版本，已废弃，通过后端服务器组中的版本承载。 表10 MicroServiceInfoCCE 参数 参数类型 描述 cluster_id String 云容器引擎集群编号 namespace String 命名空间 workload_type String 工作负载类型 deployment：无状态负载 statefulset：有状态负载 daemonset：守护进程集 app_name String APP名称。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 label_key String 服务标识名。支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号，且只能以英文、汉字和数字开头，1-64个字符。 说明： 中文字符必须为UTF-8或者unicode编码。 label_value String 服务标识值。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 cluster_name String 云容器引擎集群名称（暂不支持） 表11 MicroServiceInfoCCEService 参数 参数类型 描述 cluster_id String 云容器引擎集群编号 namespace String 命名空间。1-63字符。只能包含小写字母、数字，以及 '-'，必须以字母开头，必须以字母数字结尾。 service_name String Service名称。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 cluster_name String 云容器引擎集群名称 表12 MicroServiceInfoNacosBase 参数 参数类型 描述 namespace String 命名空间ID，当选择默认命名空间public时，此项为空。由字母、数字、连接符('-')、下划线('_')组成且64个字符之内。 cluster_name String 集群名称，默认为DEFAULT。由字母、数字、连接符('-')、下划线('_')组成且64个字符之内。 group_name String 分组名称，默认为DEFAULT_GROUP。由字母、数字、连接符('-')、下划线('_')、点号('.')、冒号(':')组成且128个字符之内。 service_name String 微服务名称。不包含中文和@@，不得以@开头，512个字符以内。 server_config Array of NacosServerConfig objects nacos服务端配置信息。 user_info NacosUserInfo object nacos用户信息。 表13 NacosServerConfig 参数 参数类型 描述 ip_address String nacos服务端IP地址。不包含中文字符。 port Integer nacos服务端端口号。取值范围1 ~ 65535。 grpc_port Integer nacos服务端gRPC端口号，默认为port+1000。取值范围1 ~ 65535。 表14 NacosUserInfo 参数 参数类型 描述 user_name String nacos用户名。 password String nacos密码。 状态码： 400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表19 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述