华为云用户手册

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

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

响应示例 状态码： 200 OK { "topics" : [ { "id" : "topic-test-2", "success" : true } ] } 状态码： 400 Bad Request { "error_code" : 400, "error_msg" : "Bad Request" } 状态码： 403 Forbidden { "error_code" : 403, "error_msg" : "Forbidden" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 topics Array of topics objects 待删除的Topic列表。 表5 topics 参数 参数类型 描述 id String Topic名称。 success Boolean 是否删除成功。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 date_from 否 Long 任务重置开始时间，UTC时间戳，允许为空。 最小值：1 最大值：9999999999999999999

响应示例 状态码： 200 OK { "message" : "Reset Success" } 状态码： 400 Bad Request { "error_code" : "FDI.3150", "error_msg" : "The task list is empty." } 状态码： 404 Not Found { "error_code" : "FDI.3083", "error_msg" : "One or more scheduled tasks are not configured with scheduled plans." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 message String 任务重置结果。 最小长度：3 最大长度：50 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

请求示例 重置指定数据集成组合任务的进度到指定时间点 https://{{ServerHost}}/v2/c53626012ba84727b938ca8bf03108ef/fdi/instances/fae7ff6c-8e07-4cf8-9e67-589cab2f017c/multi-tasks/15366328208d4d77b76532fe9f4006a6/reset { "date_from" : 1630052714000 }

响应示例 状态码： 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错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表4 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 permissions Array of strings 权限。 parent_id Integer 父分组ID。 最小值：1 最大值：99999999999999999 id Integer 分组ID。 最小值：1 最大值：99999999999999999 name String 分组名称，支持中文、英文大小写、数字、下划线和中划线，长度2-64。 最小长度：2 最大长度：64 description String 分组描述，长度0-200。 最小长度：0 最大长度：200 app_id String 分组归属应用ID。 最小长度：0 最大长度：36 created_user CreatedUser object 创建时的用户。 last_updated_user LastUpdatedUser object 最后更新时的用户。 created_datetime String 创建时间。 最小长度：0 最大长度：50 last_updated_datetime String 最后修改时间。 最小长度：0 最大长度：50 表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

响应示例 状态码： 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的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 parent_id 是 Integer 父分组ID，自动向下取整。 最小值：0 最大值：99999999999999999 name 是 String 分组名称，支持中文，英文大小写，数字，下划线和中划线，长度2-64。 最小长度：2 最大长度：64 description 否 String 分组描述。 最小长度：0 最大长度：200 app_id 是 String 分组归属应用ID。 最小长度：0 最大长度：36

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 topics Array of topics objects Topic列表。 表5 topics 参数 参数类型 描述 id String Topic名称。 success Boolean 是否删除成功。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

响应示例 状态码： 200 OK { "topics" : [ { "id" : "topic-mqs-test1", "success" : true }, { "id" : "topic-mqs-test2", "success" : true } ] } 状态码： 400 Bad Request { "error_code" : 400, "error_msg" : "Bad Request" } 状态码： 403 Forbidden { "error_code" : 403, "error_msg" : "Forbidden" }

响应示例 状态码： 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.updateCommandResponse]. 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 表4 响应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 表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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 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时必填，自动向下取整。 最小值：0 最大值：9999999 缺省值：10 unit 否 String 属性单位。 最小长度：0 最大长度：10 enum_list 否 String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 最小长度：0 enum_dict 否 Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。

响应示例 状态码： 200 OK { "total" : 43, "size" : 2, "configs" : [ { "config_id" : "9", "config_name" : "API_VERSION_NUM_LIMIT", "config_value" : "10", "config_time" : "2019-02-12T19:42:19.914989Z", "remark" : "xxx", "used" : 0 }, { "config_id" : "8", "config_name" : "APIGROUP_DOMAIN_NUM_LIMIT", "config_value" : "5", "config_time" : "2019-02-12T19:42:19.914989Z", "remark" : "xxx", "used" : 0 } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620e" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 configs Array of Config objects 配额列表 表5 Config 参数 参数类型 描述 config_id String 配额编号 config_name String 配额名称 config_value String 配额值 当前实例所在租户该配额对应的数量 config_time String 配额创建时间 remark String 配额描述： API_NUM_LIMIT：租户可以创建的API个数限制 APP_NUM_LIMIT：租户可以创建的APP个数限制 APIGROUP_NUM_LIMIT：租户可以创建的API分组个数限制 ENVIRONMENT_NUM_LIMIT：租户可以创建的环境个数限制 VARIABLE_NUM_LIMIT：每个API分组上可以创建的环境变量个数限制 SIGN_NUM_LIMIT：租户可以创建的签名密钥个数限制 THROTTLE_NUM_LIMIT：租户可以创建的流控策略个数限制 APIGROUP_DOMAIN_NUM_LIMIT：每个API分组上可以绑定的自定义 域名 个数限制 API_VERSION_NUM_LIMIT：每个API可以保留的发布版本个数限制 VPC_NUM_LIMIT：租户可以创建的VPC通道个数限制 VPC_INSTANCE_NUM_LIMIT：每个VPC通道上可以绑定的弹性云服务器个数限制 API_PA RAM _NUM_LIMIT：每个API可以设置的参数个数限制 API_USER_CALL_LIMIT：每个租户的API单位时间内的请求默认限制 ACL_NUM_LIMIT：每个租户可以创建的ACL策略个数限制 APP_THROTTLE_LIMIT：特殊应用流控策略个数限制 USER_THROTTLE_LIMIT：特殊用户流控策略个数限制 API_NUM_LIMIT_PER_GROUP：租户每个API分组可以创建的API数量限制 API_POLICY_NUM_LIMIT：每个API可以设置的策略后端个数限制 API_CONDITION_NUM_LIMIT：每个API策略后端可以设置的条件个数限制 SL_DOMAIN_CALL_LIMIT：每个二级域名单位时间内的请求默认限制 ELB_SWITCH：是否启用ELB通道 AUTHORIZER_NUM_LIMIT：租户可创建的自定义认证个数限制 AUTHORIZER_IDENTITY_NUM_LIMIT：每个自定义认证可以设置的身份来源个数限制 APP_CODE_NUM_LIMIT：每个APP可以创建的APP code数量限制 REGION_MANAGER_WHITELIST_SERVI CES ：不校验region manager服务白名单列表，暂不支持 API_SWAGGER_NUM_LIMIT：单个API分组可以绑定的swagger文档数量限制 API_TAG_NUM_LIMIT：每个API可以设置的标签个数限制 LTS_SWITCH：是启用LTS上报 APP_KEY_SECRET_SWITCH：是否打开APP支持自定义KEY和SECRET的开关，1：开启；2：关闭 RESPONSE_NUM_LIMIT：分组自定义响应个数限制 CONFIG_NUM_LIMIT_PER_APP：每个APP可以设置的配置项个数限制 BACKEND_TOKEN_ALLOW_SWITCH：是否支持普通租户透传后端Token，1：开启；2：关闭 APP_TOKEN_SWITCH：是否启用APPTOKEN API_DESIGNER_SWITCH：是否启用API设计器，1：开启；2：关闭 APP_API_KEY_SWITCH：是否启用APP_API_KEY认证方式 APP_BASIC_SWITCH：是否启用APP_BASIC认证方式 APP_JWT_SWITCH：是否启用APP_JWT认证方式 APP_ROUTE_SWITCH：是否启用APP路由 PUBLIC_KEY_SWITCH：是否启用PUBLIK_KEY后端认证方式 APP_SECRET_SWITCH：是否启用APP_SECRET认证方式 CASCADE_SWITCH：是否启用级联网关 IS_INIT_API_PATH_HASH：是否执行过API PATH HASH刷新 APP_QUOTA_NUM_LIMIT：租户可以创建的客户端配额个数 IS_INIT_API_VERSION：是否执行过API VERSION CANONICAL PATH刷新 PLUGIN_NUM_LIMIT：租户可以创建的插件个数 APICLIENT_FIRST_USE_X_HW_ID_SWITCH：ApiClient是否优先使用x-hw-id校验权限 API_TASK_NUM_LIMIT：租户可以创建的API定时任务个数限制 THROTTLE_LOCAL_SWITCH：是否启用本地流控模式 API_TASK_SWITCH：租户是否支持定时任务 SET_HEADERS_NUM_LIMIT_PER_PLUGIN：租户可以通过插件创建的HTTP头个数限制 LUA_SCRIPT_SWITCH：租户是否允许使用lua_script插件 LUA_SCRIPT_NUM_LIMIT：每个实例可以创建的lua_script类型插件个数限制 SM_DICT_NUM_LIMIT：每个实例可以创建的数据字典个数限制 BM_VPC_INSTANCE_GROUP_NUM_LIMIT：每个实例可以创建的VPC通道后端服务器组个数限制 used Long 该实例对应配额已使用数量 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "create_time" : "2020-07-31T06:41:43Z", "name" : "DEV", "remark" : "Development environment", "id" : "7a1ad0c350844ee69479b47df9a881cb" } 状态码： 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.3003", "error_msg" : "Environment 7a1ad0c350844ee69479b47df9a881cb 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参数 参数 是否必选 参数类型 描述 name 是 String 环境的名称，支持英文、数字、下划线，且只能以英文字母开头。 最小长度：3 最大长度：64 remark 否 String 描述信息 说明： 中文字符必须为UTF-8或者unicode编码。 最大长度：255

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 create_time String 创建时间 name String 环境名称 remark String 描述信息 id 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 错误描述

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

响应示例 状态码： 400 Bad Request { "error_code" : "FDI.3150", "error_msg" : "The task list is empty." } 状态码： 404 Not Found { "error_code" : "FDI.3083", "error_msg" : "One or more scheduled tasks are not configured with scheduled plans." }

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

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

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "auths" : [ { "id" : "dd29b33ae4394e3b924b582c6b40880b", "api_id" : "5f918d104dc84480a75166ba99efff21", "api_name" : "Api_http", "group_name" : "api_group_001", "api_type" : 1, "api_remark" : "Web backend Api", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "auth_role" : "PROVIDER", "auth_time" : "2020-08-04T04:02:22Z", "app_name" : "app_demo", "app_remark" : "remark", "app_type" : "roma", "app_creator" : "USER", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "auth_tunnel" : "NORMAL", "auth_whitelist" : [ ], "auth_blacklist" : [ ], "roma_app_type" : "integration", "env_name" : "RELEASE", "app_id" : "356de8eb7a8742168586e5daf5339965" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }