华为云用户手册

公共资源API错误码 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 ROMA.1000 No token is available in the request. 请求中缺少token。 在请求的header中增加token字段。 400 ROMA.10010 Failed to create the task. 创建任务失败。 核查失败原因修改重试。 400 ROMA.10011 Failed to decompress the file. 文件解压失败。 核查失败原因并重试。 400 ROMA.10012 An asset management task is running. 用户已有资产管理任务在运行。 已有资产管理任务在运行，结束后重试。 400 ROMA.10013 Only .zip files are supported. The file name must start with a letter or digit. Among all the special characters, only the plus sign (+), minus sign (-), and underscore (_) are allowed. 只支持zip文件，文件名必须以字母和数字开头。只能输入“+”、“-”、“_”。 核查是否匹配并重试。 400 ROMA.1002 Incorrect token in the request. 请求token错误。 在请求的header中增加正确token字段。 400 ROMA.1006 You do not have the permissions required to perform this operation. 缺少对此操作的权限。 在iam权限控制处增加对应的权限。 400 ROMA.1007 Invalid request URL. 请求url无效。 去除请求URL中的非法字符或者URL格式非标准。 400 ROMA.11011 Failed to write the dictionary information to etcd. 字典信息写入etcd失败。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.12001 You do not have the permissions required to operate the application. 没有权限操作应用程序。 可选择有操作权限账号。 400 ROMA.12002 The user does not support this feature. 此用户不支持该特性。 增加该特性操作权限。 400 ROMA.13000 Invalid parameters. 无效参数。 使用有效参数。 400 ROMA.13001 No request body is available. 请求体不存在。 请求体不存在，添加对应请求体。 400 ROMA.13002 The route description length exceeds the limit. 路由描述长度超过限制。 减少路由描述字段长度。 400 ROMA.13003 The route is invalid or conflicts with another route. 子服务更新路由失败。 请检查路由策略是否正确，以及子服务是否正常。 400 ROMA.13011 The dictionary does not exist. 字典不存在。 检查访问的字典信息是否正确。 400 ROMA.13012 The dictionary already exists. 字典已存在。 字典已存在，修改或创建新的字典。 400 ROMA.13013 The parent dictionary is invalid. 父字典无效。 创建有效父字典。 400 ROMA.13014 The system dictionary cannot be deleted. 系统字典不允许删除。 系统字典不允许删除。 400 ROMA.14001 The application does not exist. 应用不存在。 检查应用信息是否正确。 400 ROMA.14002 The instance does not exist. 实例不存在。 检查实例信息是否正确。 400 ROMA.14003 The instance is not running. 实例未运行。 实例未运行，可运行实例后操作。 400 ROMA.14004 The site does not exist. 站点不存在。 检查站点信息是否正确。 400 ROMA.14005 The site configuration does not exist. 站点配置不存在。 检查站点配置信息是否正确。 400 ROMA.14006 The site configuration is being downloaded. 站点配置已下载。 站点配置已下载，等待下载完成后重试。 400 ROMA.14007 The site status does not support the requested operation. 站点状态不支持该请求操作。 站点状态不支持该请求操作，请勿继续此操作。 400 ROMA.14011 The application already exists. 应用已存在。 应用已存在，请填写正确的应用名称。 400 ROMA.14012 The application key already exists. 应用键已存在。 应用键已存在，更换键，或者修改已有键。 400 ROMA.14014 The application cannot be deleted because it contains resources. 应用下有资源，无法删除。 单击应用详情，先删除应用下资源，再删除应用。 400 ROMA.15002 Insufficient instance quota. 实例配额不足。 删除无用实例或者申请扩大实例配额。 400 ROMA.15003 The IP addresses available in the subnet are insufficient. 子网可用IP不足。 更换可用IP足够的子网。 400 ROMA.15004 There is no available IP address in the subnet. 子网可用IP不存在。 检查子网可用IP信息是否正确。 400 ROMA.15005 Invalid VPC status. 虚拟私有云状态无效。 更换虚拟私有云。 400 ROMA.15006 The DHCP function of the subnet is unavailable. 子网DHCP不可用。 开启子网DHCP功能。 400 ROMA.15007 The subnet does not belong to the VPC. 子网不属于该虚拟私有云。 更换属于该虚拟私用云的子网。 400 ROMA.15008 The security group rule is empty. 安全组规则为空。 根据ROMA业务增加相应的安全组规则。 400 ROMA.15009 The security group does not have default rules. 安全组默认规则不存在。 更换存在默认规则的安全组。 400 ROMA.15010 The EIP has already been bound. 弹性IP已经被绑定。 更换未被绑定的弹性IP。 400 ROMA.15011 Failed to query the database. 查询数据库失败。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15012 Failed to update the database. 更新数据库失败。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15013 The resource tenant does not exist. 资源租户不存在。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15014 The LVS VM does not exist. 创建LVS虚拟机不存在。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15015 The subnet IP address of the LVS does not exist. LVS的子网IP不存在。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15016 Failed to create the NIC for the subnet. 租户子网的网卡创建失败。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15017 Failed to create the sub-service. 子服务创建失败。 请单击实例名称查看子服务的错误详细信息，如还不能解决，提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15018 Invalid OBS address. OBS地址无效。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15019 Invalid VPC CIDR. 虚拟私用云的cidr无效。 使用cidr合法的虚拟私用云。 400 ROMA.15020 Failed to invoke the E CS service. 调用ECS服务失败。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15021 Failed to invoke the VPC service. 调用VPC服务失败。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15022 Failed to create the instance. The ECS service may be abnormal. 创建实例失败，可能ECS服务异常。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.15023 REST request failed. REST请求失败。 网络异常或对端服务异常。 400 ROMA.4001000 Invalid parameters. 输入的参数无效。 检查参数信息是否正确。 400 ROMA.4001001 The ROMA Connect instance name already exists. ROMA Connect实例名称已存在。 更换ROMA Connect实例名称重试。 400 ROMA.4001010 The ROMA Connect instance name is invalid. ROMA Connect实例名称无效。 ROMA Connect实例名称无效，请填写正确的实例名称。 400 ROMA.4001012 The maintenance time window parameter of the ROMA Connect instance is invalid. ROMA Connect实例维护时间窗参数无效。 更改正确的ROMA Connect实例维护时间窗参数。 400 ROMA.4001016 Failed to create the LVS. 创建LVS失败。 1.申请配额，联系技术支持工程师扩容资源。 2.查看已有的VPC，检查用来创建实例的VPC，网段是否为"--"未配置。未配置，单击修改，填写与子网相同的网段。 400 ROMA.4001017 The token has expired. 请求token过期。 重新获取token。 400 ROMA.4001019 This operation cannot be performed on instances in the current status. 当前实例状态不支持该操作。 当前实例状态不支持该操作，提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.4001024 The password is too simple. 输入密码不满足密码复杂度。 检查输入的密码。 400 ROMA.4001025 The ROMA Connect instance does not exist. ROMA Connect实例不存在。 在ROMA Connec控制台查询实例ID对应的实例是否存在，检查传入的实例ID。 400 ROMA.4001026 The ROMA Connect instance is not running. ROMA Connect实例非运行状态。 实例状态可能异常，在实例页面查看具体实例状态检查信息，并联系技术支持工程师协助解决。 400 ROMA.4001027 The application does not exist. 应用不存在。 检查应用是否创建。 400 ROMA.4001028 The application already exists. 应用已存在。 检查应用是否已存在。 400 ROMA.4001029 Invalid application name. 应用名称无效。 检查输入参数应用名称满足1到256位支持英文大小写，数字，中文，下划线和中划线和点。 400 ROMA.4001030 The application description is too long. 应用备注参数长度超出限制。 检查输入的应用备注参数长度。 400 ROMA.4001031 Failed to write data into etcd. 写入etcd数据失败。 提供实例ID信息，并联系技术支持工程师协助解决。 400 ROMA.4001033 The application cannot be deleted because it contains resources. 应用下有资源，无法删除。 单击应用详情，先删除应用下资源，再删除应用。 400 ROMA.4001034 The application quota is insufficient. 应用配额不足。 应用数量已达上限，需要申请扩大配额。 400 ROMA.4001040 Invalid application key. 应用key值无效。 检查输入应用key值满足3到200位，包括数字、字母和-。 400 ROMA.4001041 Invalid application secret. 应用secret无效。 检查输入应用secret满足8到128位，包括数字、字母。 400 ROMA.4001048 The site already exists. Site站点已存在。 从ROMA Connect页面查看Site站点已存在，无需重复创建。 400 ROMA.4001053 Another order for deleting the instance is in progress. 实例删除的订单重复提交。 将该实例未处理的订单处理后，再进行后续操作。 400 ROMA.4011000 The user token in the request does not match the project ID. 请求中用户token与projectId不匹配。 检查请求中token或者projectId是否被篡改。 400 ROMA.4030001 You do not have the permissions required for this resource. 对此资源没有操作权限。 检查输入资源ID是否为自己创建的资源。 400 ROMA.4031001 Insufficient quota. 配额不足。 提供账户名称，并联系技术支持工程师协助解决。 400 ROMA.4031005 The trial instance quota is insufficient. 试用实例数量配额不足。 提供账户名称，并联系技术支持工程师协助解决。 400 ROMA.4031006 A resource with the same name already exists. 资源名字已存在。 检查输入资源名称是否合法。 400 ROMA.4031007 The EIP has already been bound. 弹性IP已经绑定。 更换一个可用的弹性IP。 400 ROMA.4031008 An LVS with the same name already exists. LVS名称已存在。 检查输入的LVS名称是否重复。 400 ROMA.4031009 You do not have the permissions required to create a trial instance. 没有权限创建试用实例。 联系服务申请试用实例。 400 ROMA.4031011 You need to apply for a trial period. 请申请试用期。 提供账户名称，并联系技术支持工程师协助解决。 400 ROMA.4041000 The resource does not exist. 资源不存在。 检查资源是否存在。 400 ROMA.4041002 The account cannot access enterprise projects. 账户不支持企业项目。 确认账户是否为企业账户。 400 ROMA.4041003 You do not have the permissions required to view the IAM user list. 此用户缺少查看IAM用户列表权限。 在用户权限页面增加系统角色SecurityAdministrator，从而拥有查看IAM用户列表权限。 400 ROMA.5001000 This is an internal service. 内部服务。 联系技术支持工程师协助解决。 400 ROMA.5001003 The product ID does not exist. 产品ID不存在。 确认服务是否已下线，若下线，进行上线操作。 400 ROMA.5002000 The AZ does not exist. 可用区AZ不存在。 检查创建实例请求中的可用区。 400 ROMA.5008000 The database connection is abnormal. 数据库连接异常。 检查数据库连接地址或数据库服务。 400 ROMA.5008020 Failed to unbind the EIP. 解绑EIP失败，请稍后重试。 1分钟后重试。 400 ROMA.5008021 Failed to bind the EIP. 绑定EIP失败，请稍后重试。 1分钟后重试。 父主题： 错误码

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 任务追踪ID。 dirty_data_count Integer 脏数据数量。 detail_logs Array of TaskMonitorDetailLog objects 任务监控日志当前页元素。 表4 TaskMonitorDetailLog 参数 参数类型 描述 id String 任务每次执行步骤产生的唯一ID。 status Integer 本次任务执行详细状态，状态码划分规则：reader端 100 ~ 499，writer端 500 ~ 899，其他900 ~ ： 16(被强制取消) 99(任务开始) 100(Reader 任务开始) 101(Reader 任务结束) 102(正在读取数据) 103(读端数据源端异常) 104(读取数据结束) 105(读取数据为0) 106(读任务强制取消) 107(在reader plugin中，任务发生了中断) 108(读任务恢复运行) 500(Writer 任务开始) 501(Writer 任务结束) 502(正在数据写入) 503(目标端异常) 504(数据写入结束) 505(写任务强制取消) 506(在writer plugin中，任务发生了中断) 507(写任务恢复运行) 900(接收到调度请求) 901(任务运行结束) 902(任务已运行结束，正在进行数据完整性校验) 903(输出数据完整性校验结果) 904(经过数据完整性校验，发现有数据缺失，正在进行数据补偿) 905(输出数据补偿结果) 906(读取任务正在在排队中（平台资源）) 907(读取任务被拒绝执行，因为上一次调度还没有结束) 908(写入任务正在在排队中（平台资源）) 909(写入任务被拒绝执行，因为上一次调度还没有结束) 911(读取任务没有被正常开启，请检查网络是否通畅，参数是否正确) 912(写入任务没有被正常开启，请检查网络是否通畅，参数是否正确) 913(任务调度请求失败) 914(任务被拒绝执行，因为上一次调度还没有结束) 915(任务不正常运行) 916(任务日志上报异常) position String 标识当前步骤属于哪一个阶段： ADAPTER(任务处于初始化阶段) READER(任务正在执行Reader读操作) WRITER(任务正在执行Writer写操作) position_status String 任务当前步骤的状态： NORMAL(正在运行) NODE_END(本节点正常结束) RUNTIME_CANCEL(任务被取消) TASK_END(本任务正常结束) RUNTIME_ERR(运行时异常) INTERNAL_ERR(内部程序异常) stage String 标识当前步骤属于哪一个FDI插件，如adapter、apireader、rdbwriter等。 dirty_data_count Integer 异常数据条数。 data_count Integer 成功数据条数。 data_size Number 成功数据大小，浮点数类型。 data_size_unit String 成功数据大小的计量单位。 spend_time Integer 执行时长，单位：ms。 remarks String 执行详细信息。 step_begin_time Integer 本次步骤启动时间，格式timestamp(ms)，使用UTC时区。 step_end_time Integer 本次步骤结束时间，格式timestamp(ms)，使用UTC时区。 状态码： 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 错误描述。

响应示例 状态码： 200 OK { "group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2", "failure" : [ { "path" : "/test/demo", "error_msg" : "The API already exists, An API with the same combination of the method, path, and x-apigateway-match-mode fields already exists. API name: API_demo", "method" : "GET", "error_code" : "APIG.3301" } ], "success" : [ { "path" : "/test", "method" : "GET", "action" : "create", "id" : "8ae6bcafab6f49d78242bff26ad8a4f0" } ], "swagger" : { "id" : "412488ba965041f9838a5266a5f8e574", "result" : "Success" } } 状态码： 400 Bad Request { "error_code" : "APIG.3201", "error_msg" : "The API group 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.3001", "error_msg" : "API group not found" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 success Array of Success objects 导入成功信息 failure Array of Failure objects 导入失败信息 swagger Swagger object swagger文档导入结果 暂不支持 group_id String API分组编号 ignore Array of Ignore objects 被忽略导入的API信息 表5 Success 参数 参数类型 描述 path String API请求路径 method String API请求方法 action String 导入行为： update：表示更新API create：表示新建API id String 导入成功的API编号 表6 Failure 参数 参数类型 描述 path String API请求路径 error_msg String 导入失败的错误信息 method String API请求方法 error_code String 导入失败的错误码 表7 Swagger 参数 参数类型 描述 id String swagger文档编号 result String 导入结果说明 表8 Ignore 参数 参数类型 描述 method String API请求方法 path String API请求路径 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 FormData参数 参数 是否必选 参数类型 描述 is_create_group 否 Boolean 是否创建新分组 group_id 否 String API分组编号。 当is_create_group=false时为必填 app_id 否 String 应用编号。 当is_create_group=false且使用集成应用分组时必填 extend_mode 否 String 扩展信息导入模式 merge：当扩展信息定义冲突时，merge保留原有扩展信息 override：当扩展信息定义冲突时，override会覆盖原有扩展信息 simple_mode 否 Boolean 是否开启简易导入模式 mock_mode 否 Boolean 是否开启Mock后端 api_mode 否 String 导入模式 merge：当API信息定义冲突时，merge保留原有API信息 override：当API信息定义冲突时，override会覆盖原有API信息 file_name 是 File 导入Api的请求体，json或yaml格式的文件

响应示例 状态码： 201 Created 示例 1 { "name" : "VPC_demo", "id" : "105c6902457144a4820dff8b1ad63331", "balance_strategy" : 1, "dict_code" : "", "create_time" : "2020-07-23T07:11:57.244829604Z", "member_type" : "ip", "port" : 22, "status" : 1, "member_groups" : [ { "member_group_id" : "c1ce135c705c4066853a0460b318fe16", "member_group_name" : "test", "member_group_weight" : 1, "member_group_remark" : "remark", "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z", "microservice_version" : "", "microservice_port" : 0 }, { "member_group_id" : "c1ce135c705c4066853a0460b318fe17", "member_group_name" : "default", "member_group_weight" : 2, "member_group_remark" : "remark", "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z", "microservice_version" : "", "microservice_port" : 0 } ], "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" : "" } } 示例 2 { "name" : "VPC_demo", "id" : "105c6902457144a4820dff8b1ad63331", "balance_strategy" : 1, "dict_code" : "", "create_time" : "2020-07-23T07:11:57.244829604Z", "member_type" : "ip", "port" : 22, "status" : 1, "member_groups" : [ { "member_group_id" : "c1ce135c705c4066853a0460b318fe16", "member_group_name" : "test", "member_group_weight" : 1, "member_group_remark" : "remark", "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z", "microservice_version" : "v1", "microservice_port" : 80 }, { "member_group_id" : "c1ce135c705c4066853a0460b318fe17", "member_group_name" : "default", "member_group_weight" : 2, "member_group_remark" : "remark", "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z", "microservice_version" : "v2", "microservice_port" : 80 } ], "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.2001", "error_msg" : "The request parameters must be specified, parameter name:members" } 状态码： 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" }

请求示例 创建一个服务器类型的VPC通道，成员类型为IP，并添加后端服务器 { "balance_strategy" : 1, "member_type" : "ip", "name" : "VPC_demo", "port" : 22, "type" : 2, "vpc_health_config" : { "http_code" : "200", "path" : "/vpc/demo", "port" : 22, "protocol" : "http", "threshold_abnormal" : 5, "threshold_normal" : 2, "time_interval" : 10, "timeout" : 5, "enable_client_ssl" : false }, "member_groups" : [ { "member_group_name" : "test", "member_group_weight" : 1, "member_group_remark" : "remark" }, { "member_group_name" : "default", "member_group_weight" : 2, "member_group_remark" : "remark" } ], "members" : [ { "host" : "192.168.0.5", "weight" : 1, "member_group_name" : "test" }, { "host" : "192.168.1.124", "weight" : 2, "member_group_name" : "default" } ] }

响应参数 状态码： 201 表15 响应Body参数 参数 参数类型 描述 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 微服务的响应对象 表16 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通道后端服务器组更新时间 表17 MicroserviceLabel 参数 参数类型 描述 label_name String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 label_value String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 表18 MicroServiceInfo 参数 参数类型 描述 id String 微服务编号 instance_id String 实例编号 service_type String 微服务类型： CSE：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 微服务创建时间 表19 MicroServiceInfoCSE 参数 参数类型 描述 engine_id String 微服务引擎编号 service_id String 微服务编号 engine_name String 微服务引擎名称 service_name String 微服务名称 register_address String 注册中心地址 cse_app_id String 微服务所属的应用 version String 微服务的版本，已废弃，通过后端服务器组中的版本承载。 表20 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 云容器引擎集群名称（暂不支持） 表21 MicroServiceInfoCCEService 参数 参数类型 描述 cluster_id String 云容器引擎集群编号 namespace String 命名空间。1-63字符。只能包含小写字母、数字，以及 '-'，必须以字母开头，必须以字母数字结尾。 service_name String Service名称。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 cluster_name String 云容器引擎集群名称 表22 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用户信息。 表23 NacosServerConfig 参数 参数类型 描述 ip_address String nacos服务端IP地址。不包含中文字符。 port Integer nacos服务端端口号。取值范围1 ~ 65535。 grpc_port Integer nacos服务端gRPC端口号，默认为port+1000。取值范围1 ~ 65535。 表24 NacosUserInfo 参数 参数类型 描述 user_name String nacos用户名。 password String nacos密码。 状态码： 400 表25 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表26 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表27 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表28 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表29 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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：服务器类型 3：微服务类型 当vpc_channel_type字段为空时，负载通道类型由type字段控制： 当type不为3或microservice_info为空，VCP通道类型默认为服务器类型。 当type=3，microservice_info不为空，VPC通道类型为微服务类型。 修改负载通道时vpc通道类型不会修改，直接使用原有的vpc通道类型。 此字段待废弃，请使用vpc_channel_type字段指定负载通道类型。 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通道的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 member_groups 否 Array of MemberGroupCreate objects VPC通道后端服务器组列表。当microservice_info中service_type为NACOS类型时，服务器组的权重不支持手动设置。 members 否 Array of MemberInfo objects VPC后端实例列表。 对于引用负载通道类型的负载通道，不会使用此字段新增或更新后端实例。 vpc_health_config 否 VpcHealthConfig object 健康检查详情。 microservice_info 否 MicroServiceCreate object 微服务详情。 表4 MemberGroupCreate 参数 是否必选 参数类型 描述 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）时支持。 表5 MicroserviceLabel 参数 是否必选 参数类型 描述 label_name 是 String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 label_value 是 String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 表6 MemberInfo 参数 是否必选 参数类型 描述 host 否 String 后端服务器地址 后端实例类型为ip时必填 weight 否 Integer 权重值。 允许您对后端服务进行评级，权重值越大，转发到该云服务的请求数量越多。 is_backup 否 Boolean 是否备用节点。 开启后对应后端服务为备用节点，仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能，若不支持请联系技术支持。 member_group_name 否 String 后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。 status 否 Integer 后端服务器状态 1：可用 2：不可用 port 否 Integer 后端服务器端口 ecs_id 否 String 后端云服务器的编号。 后端实例类型为ecs时必填，支持英文，数字，“-”,“_”，1 ~ 64字符。 ecs_name 否 String [后端云服务器的名称。] 后端实例类型为ecs时必填，支持汉字，英文，数字，“-”,“_”,“.”，1 ~ 64字符。 表7 VpcHealthConfig 参数 是否必选 参数类型 描述 protocol 是 String 使用以下协议，对VPC中主机执行健康检查： TCP HTTP HTTPS path 否 String 健康检查时的目标路径。protocol = http或https时必选 method 否 String 健康检查时的请求方法 port 否 Integer 健康检查的目标端口，缺少或port = 0时为VPC中主机的端口号。 若此端口存在非0值，则使用此端口进行健康检查。 threshold_normal 是 Integer 正常阈值。判定VPC通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 threshold_abnormal 是 Integer 异常阈值。判定VPC通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 time_interval 是 Integer 间隔时间：连续两次检查的间隔时间，单位为秒。必须大于timeout字段取值。 http_code 否 String 检查目标HTTP响应时，判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值，支持如下三种格式： 多个值，如：200,201,202 一系列值，如：200-299 组合值，如：201,202,210-299 protocol = http时必选 enable_client_ssl 否 Boolean 是否开启双向认证。若开启，则使用实例配置中的backend_client_certificate配置项的证书 status 否 Integer 健康检查状态 1：可用 2：不可用 timeout 是 Integer 超时时间：检查期间，无响应的时间，单位为秒。必须小于time_interval字段取值。 表8 MicroServiceCreate 参数 是否必选 参数类型 描述 service_type 否 String 微服务类型： CSE：CSE微服务注册中心 CCE：CCE云容器引擎（暂不支持） CCE_SERVICE: CCE云容器引擎（Service）（暂不支持） NACOS: Nacos注册中心，nacos_info必填 cse_info 否 MicroServiceInfoCSEBase object CSE基础信息 cce_info 否 MicroServiceInfoCCEBase object 暂不支持 cce_service_info 否 MicroServiceInfoCCEServiceBase object 暂不支持 nacos_info 否 MicroServiceInfoNacosBase object nacos基础信息。 表9 MicroServiceInfoCSEBase 参数 是否必选 参数类型 描述 engine_id 是 String 微服务引擎编号 service_id 是 String 微服务编号 表10 MicroServiceInfoCCEBase 参数 是否必选 参数类型 描述 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编码。 表11 MicroServiceInfoCCEServiceBase 参数 是否必选 参数类型 描述 cluster_id 是 String 云容器引擎集群编号 namespace 是 String 命名空间。1-63字符。只能包含小写字母、数字，以及 '-'，必须以字母开头，必须以字母数字结尾。 service_name 是 String Service名称。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 表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密码。

响应示例 状态码： 200 OK { "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37", "test_date" : "2020-09-19T06:40:52Z", "test_id" : 2524356, "test_method" : "GET", "test_operator" : "73d69ae0cfcf460190522d06b60f05ad", "test_request" : "{\"apiUUID\":\"bd42841c20184da6bbf457c6d8a06e37\",\"method\":\"GET\",\"params\":[{\"paramDesc\":\"\",\"paramName\":\"header\",\"paramRequired\":\"0\",\"paramType\":\"Headers\",\"paramValue\":\"test\"}],\"testUrl\":\"/test/function\"}", "test_response" : "Hello world!", "test_status_code" : "200", "test_used_time" : 29, "debug_log" : [ "2021-04-20 16:52:47 | 226e613ca72f4997b87def5445dac75c | 111", "2021-04-20 16:52:47 | 226e613ca72f4997b87def5445dac75c | message:bbb" ] } 状态码： 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 表5 响应Body参数 参数 参数类型 描述 test_status_code String 测试返回的状态码 test_request String 测试的请求内容 test_used_time Integer 测试耗时 test_operator String 测试者的项目编号 test_response String 测试的响应内容 test_method String 测试的请求方法 test_id Integer 测试编号 test_date String 测试时间 ld_api_id String 后端API编号 debug_log Array of strings 本次测试日志列表 状态码： 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 错误描述

响应示例 状态码： 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.3024", "error_msg" : "The VPC instance does not exist,id:be63c6260a1043888187f84af39c9f0e" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

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

响应参数 状态码： 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。

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

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

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 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。

响应示例 状态码： 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.3010", "error_msg" : "The access control policy binding record does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

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

响应示例 状态码： 200 OK { "success" : [ { "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d", "api_id" : "3a955b791bd24b1c9cd94c745f8d1aad", "api_name" : "Api_mock", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "version_id" : "632b2c9e022941969af9a1d45735ae2c", "remark" : "publish to release environment", "publish_time" : "2020-08-03T03:01:31.26522821Z" } ], "failure" : [ { "api_id" : "abd9c4b2ff974888b0ba79be7e6b2762", "error_code" : "APIG.3002", "error_msg" : "Api abd9c4b2ff974888b0ba79be7e6b2762 not found" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value: parameter action should be \\\"online\\\" or \\\"offline\\\"" } 状态码： 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" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 apis 否 Array of strings 需要发布或下线的API ID列表 env_id 是 String 环境ID remark 否 String 对本次发布的描述信息 字符长度不超过255 说明： 中文字符必须为UTF-8或者unicode编码。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 success Array of PublishResp objects 发布或下线成功的信息 failure Array of BatchFailure objects 发布或下线失败的API及错误信息 表6 PublishResp 参数 参数类型 描述 publish_id String 发布记录的ID api_id String API编号 api_name String API名称 env_id String 发布的环境编号 remark String 发布描述 publish_time String 发布时间 version_id String 在线的版本号 表7 BatchFailure 参数 参数类型 描述 api_id String 操作失败的API ID api_name String 操作失败的APi名称 error_code String 操作失败的错误码 error_msg String 操作失败的错误信息 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "request" : "GET /test/mock HTTP/1.1\r\nHost: c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com\r\nUser-Agent: APIGatewayDebugClient/1.0\r\nX-Apig-Mode: debug\r\n\r\n", "response" : "HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\nConnection: keep-alive\r\nContent-Type: application/json\r\nDate: Mon, 03 Aug 2020 02:51:22 GMT\r\nServer: api-gateway\r\nX-Apig-Latency: 0\r\nX-Apig-Ratelimit-Api: remain:99,limit:100,time:1 minute\r\nX-Apig-Ratelimit-Api-Allenv: remain:14999,limit:15000,time:1 second\r\nX-Request-Id: d4ec6e33148bdeffe8f55b43472d1251\r\n\r\nmock success", "latency" : 5, "log" : "" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:mode. 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 3a955b791bd24b1c9cd94c745f8d1aad does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request String 调试请求报文内容 response String 调试响应报文内容，响应消息体最大支持2097152字节，超过部分会被截断 说明： 响应消息体超过限制长度时，超过部分会被截断，并追加"[TRUNCATED]"信息。 latency Integer 调试耗时，单位：毫秒 log 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 错误描述

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

响应参数 状态码： 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 Created { "permissions" : [ "read", "access", "delete", "modify" ], "parent_id" : 0, "id" : 1, "name" : "group1", "description" : "group", "app_id" : "fe382523-cf76-4152-9fc6-f772d4427302", "created_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "last_updated_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "created_datetime" : "2020-12-11", "last_updated_datetime" : "2020-12-11" } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device-groups.save]. Parameter is [request]. Processor is [body].", "request_id" : "4946aac3-6f8f-46b8-8b06-513f4084196c-1619602488278-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 parent_id 是 Integer 父分组ID，自动向下取整。 name 是 String 分组名称，支持中文，英文大小写，数字，下划线和中划线，长度2-64。 description 否 String 分组描述。 app_id 是 String 分组归属应用ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 permissions Array of strings 权限。 parent_id Integer 父分组ID。 id Integer 分组ID。 name String 分组名称，支持中文、英文大小写、数字、下划线和中划线，长度2-64。 description String 分组描述，长度0-200。 app_id String 分组归属应用ID。 created_user CreatedUser object 创建时的用户。 last_updated_user LastUpdatedUser object 最后更新时的用户。 created_datetime String 创建时间。 last_updated_datetime String 最后修改时间。 表5 CreatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 user_name String 用户名。 表6 LastUpdatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 user_name String 用户名。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。

响应示例 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:app_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.3004", "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }