华为云用户手册

响应示例 状态码： 200 OK { "id" : "string", "name" : "string", "remark" : "string", "code" : "string", "extend_one" : "string", "extend_two" : "string", "parent_code" : "string", "type" : "system", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z" } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 字典名称。 字符集：中文、英文字母、数字、下划线和空格。 约束：实例下唯一。 remark 否 String 字典描述。 order 否 Integer 字典排序，值越小顺序越靠前。 extend_one 否 String 字典扩展字段1。 字符集：中文、英文字母、数字、下划线和空格。 extend_two 否 String 字典扩展字段2。 字符集：中文、英文字母、数字、下划线和空格。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 字典ID。 name String 字典名称。 字符集：中文、英文字母、数字、下划线和空格。 约束：实例下唯一。 remark String 字典描述。 code String 字典编码。 字符集：英文字母、数字、下划线和空格。 约束：实例下唯一。 extend_one String 字典扩展字段1。 字符集：中文、英文字母、数字、下划线和空格。 extend_two String 字典扩展字段2。 字符集：中文、英文字母、数字、下划线和空格。 parent_code String 父字典编码，为空时代表自身就是最顶级字典。 type String 字典类型。 system: 代表系统内置字典，用户可编辑但不可删除。 user: 代表用户创建字典。 create_time String 创建时间。 update_time String 更新时间。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

响应示例 状态码： 200 OK { "variable_value" : "192.168.1.5", "env_id" : "7a1ad0c350844ee69479b47df9a881cb", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "id" : "25054838a624400bbf2267cf5b3a3f70", "variable_name" : "address" } 状态码： 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.3011", "error_msg" : "The environment variable does not exist, id: 25054838a624400bbf2267cf5b3a3f70" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 variable_value String 变量值支持英文字母、数字、英文格式的下划线、中划线，斜线（/）、点、冒号，1 ~ 255个字符。 env_id String 环境编号 最小长度：1 最大长度：65 group_id String API分组编号 最小长度：1 最大长度：65 variable_name String 变量名，支持英文字母、数字、英文格式的下划线、中划线，必须以英文字母开头，3~32个字符。在API定义中等于#Name的值#部分（区分大小写），发布到环境里的API被变量值替换。 说明： 中文字符必须为UTF-8或者unicode编码。 id 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 { "job_id" : "ff8080814dbd65d7014dbe0d84db0013" } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

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

响应示例 状态码： 200 OK { "name" : "MyApp", "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "remark" : "" } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码： 404 Not Found { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 字符集：支持中文、英文字母、数字、中划线、下划线、点、空格和中英文圆括号。 约束：实例下唯一。 remark String 应用描述。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总的应用数量。 size Integer 当前页的数量。 apps Array of ServerAppInfo objects 应用信息。 表5 ServerAppInfo 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 字符集：支持中文、英文字母、数字、中划线、下划线、点、空格和中英文圆括号。 约束：实例下唯一。 remark String 应用描述。 roles Array of strings 应用权限角色。 read：应用下资源只读权限，至少要存在此权限，包括API调试。 access：应用下资源的访问管理权限。 delete：应用下资源的删除权限。 modify：应用下资源的修改权限，包括API发布、下线。 admin：应用和应用下资源的权限。 仅提供admin时，会自动应用其它所有权限。 未提供read时会自动应用read权限。 create_time String 创建时间。 update_time String 更新时间。 created_user created_user object 创建用户信息。 last_updated_user last_updated_user object 最后更新用户信息。 owner Boolean 是否是应用拥有者。 key String 应用认证访问KEY,未提供时随机生成。 字符集：支持中文、英文字母、数字、中划线、下划线、@号和点，以字母或中文或数字开头。 约束：实例下唯一。 favorite Boolean 是否收藏应用，收藏的应用会在列表里优先显示。 表6 created_user 参数 参数类型 描述 user_id String 创建应用的用户ID。 user_name String 创建应用的用户名称。 表7 last_updated_user 参数 参数类型 描述 user_id String 最后修改者的用户ID。 user_name String 最后修改者的用户名。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

响应示例 状态码： 200 ok { "total" : 0, "size" : 0, "apps" : [ { "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "name" : "AppName", "remark" : "example", "roles" : [ "admin" ], "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z", "created_user" : { "user_id" : "string", "user_name" : "string" }, "last_updated_user" : { "user_id" : "string", "user_name" : "string" }, "owner" : true, "key" : "TEI***8UM", "favorite" : true } ] } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

请求示例 创建一个数据字典，指定字典名称和字典编码，字典排序为1。 { "name" : "DictName", "remark" : "example", "code" : "13760c1fe8655e61209b75665e9bef43", "order" : "1", "extend_one" : "param1", "extend_two" : "param2", "parent_code" : "" }

响应示例 状态码： 200 OK { "id" : "string", "name" : "string", "remark" : "string", "code" : "string", "extend_one" : "string", "extend_two" : "string", "parent_code" : "string", "type" : "system", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z" } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 字典名称。 字符集：中文、英文字母、数字、下划线和空格。 约束：实例下唯一。 remark 否 String 字典描述。 code 是 String 字典编码。 字符集：英文字母、数字、下划线和空格。 约束：实例下唯一。 order 否 Integer 字典排序，值越小顺序越靠前。 extend_one 否 String 字典扩展字段1。 字符集：中文、英文字母、数字、下划线和空格。 extend_two 否 String 字典扩展字段2。 字符集：中文、英文字母、数字、下划线和空格。 parent_code 否 String 父字典编码，为空时代表自身就是最顶级字典。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 字典ID。 name String 字典名称。 字符集：中文、英文字母、数字、下划线和空格。 约束：实例下唯一。 remark String 字典描述。 code String 字典编码。 字符集：英文字母、数字、下划线和空格。 约束：实例下唯一。 extend_one String 字典扩展字段1。 字符集：中文、英文字母、数字、下划线和空格。 extend_two String 字典扩展字段2。 字符集：中文、英文字母、数字、下划线和空格。 parent_code String 父字典编码，为空时代表自身就是最顶级字典。 type String 字典类型。 system: 代表系统内置字典，用户可编辑但不可删除。 user: 代表用户创建字典。 create_time String 创建时间。 update_time String 更新时间。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

响应示例 状态码： 201 Created { "datasource_id" : "123", "datasource_name" : "fdi_ds_api_v2", "datasource_type" : "API", "content" : { "url" : "http%3A%2F%2FVM6_ip%3A1080%2F0928njapi", "api_method" : "GET", "ApiAuthDetail" : { "auth_method" : "none" } }, "description" : "testAPI", "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd" }

请求示例 创建一个MySQL数据源，连接模式为默认。 { "datasource_name" : "fdi_ds_y3k674", "datasource_type" : "MYSQL", "content" : { "host" : "**.**.**.**", "port" : "3306", "database_name" : "testfdi", "user_name" : "fditest", "password" : "******", "mode" : "default" }, "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd", "description" : "testtesttest" } 创建一个FTP数据源，连接模式为active，协议类型为ftp。 { "datasource_name" : "fdi_ds_v2frp", "datasource_type" : "FTP", "content" : { "ftp_connect_mode" : "active", "host" : "**.**.**.**", "port" : "21", "user_name" : "ftpuser", "password" : "******", "ftp_protocol" : "ftp" }, "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd", "description" : "testtesttest" } 创建一个API数据源，API请求方式为GET，认证方式为无认证。 { "datasource_name" : "fdi_ds_api_v2", "datasource_type" : "API", "content" : { "url" : "http%3A%2F%2FVM6_ip%3A1080%2F0928njapi", "api_method" : "GET", "api_auth_detail" : { "auth_method" : "none" } }, "description" : "testAPI", "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd" }

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "instances" : [ { "id" : "e34610ca-0a37-4f04-8856-4101b08cc5e2", "name" : "roma-test", "description" : " ", "flavor_id" : "00400-30101-0--0", "flavor_type" : "basic", "cpu_arch" : "x86_64", "vpc_id" : "000c3783-a9c0-4ee4-ac44-93bfdfbf3340", "subnet_id" : "8e2ee0d5-0f1d-4067-965f-caf00dd65529", "security_group_id" : "56275464-d5f1-417d-a73b-92ee479e91e2", "publicip_enable" : true, "publicip_id" : "55a6ef1b-498d-42fb-bbc7-d01ba1652bfc", "publicip_address" : "139.9.140.164", "status" : "RUNNING", "error_code" : "string", "error_msg" : "string", "charge_type" : "prePaid", "project_id" : "106506b9a92342df9a5025fc12351cfc", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "available_zone_ids" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "enterprise_project_id" : "0" } ] } 状态码： 400 Bad Request { "error_code" : "ROMA.00013000", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码： 401 Unauthorized { "error_code" : "ROMA.00012000", "error_msg" : "Incorrect token or token resolution failed", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码： 403 Forbidden { "error_code" : "ROMA.00012000", "error_msg" : "No permissions to request this method", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00011000", "error_msg" : "System error", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 列表总数。 size Integer 本页数量。 instances Array of instances objects 实例列表。 表5 instances 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 description String 实例描述。 flavor_id String 实例规格ID。 flavor_type String 实例规格类型。 - 基础版：basic - 专业版：professional - 企业版：enterprise - 铂金版：platinum cpu_arch String CPU架构类型，取值如下： x86_64: x86架构。 aarch64: arm架构。 vpc_id String 实例指定虚拟私有云ID。 subnet_id String 实例指定虚拟私有云子网ID。 security_group_id String 实例指定安全组ID。 publicip_enable Boolean 是否开启公网访问，开启时publicip_id字段必填。 publicip_id String 实例绑定的弹性公网地址ID。 publicip_address String 实例绑定的弹性公网地址。 status String 实例运行状态。 error_code String 错误码。 error_msg String 错误消息。 charge_type String 实例计费模式。 project_id String 租户项目ID。 create_time String 创建时间。 update_time String 更新时间。 maintain_begin String 运维开始时间。 maintain_end String 运维结束时间。 available_zone_ids Array of strings 创实例使用的可用区列表。 enterprise_project_id String 实例所属企业项目ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

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

响应示例 状态码： 200 查询成功。 { "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 OK { "id" : "5f918d104dc84480a75166ba99efff21", "tags" : [ "webApi" ], "arrange_necessary" : 2, "backend_type" : "HTTP", "auth_type" : "APP", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "backend_api" : { "update_time" : "2020-08-02T16:32:47.077028841Z", "vpc_status" : 1, "vpc_info" : { "vpc_id" : "56a7d7358e1b42459c9d730d65b14e59", "vpc_proxy_host" : "www.example.com" }, "url_domain" : "56a7d7358e1b42459c9d730d65b14e59", "req_protocol" : "HTTPS", "id" : "1ce8fda3586d4371bd83c955df37e102", "req_method" : "GET", "register_time" : "2020-07-31T12:42:51Z", "req_uri" : "/test/benchmark", "timeout" : 5000, "status" : 1 }, "cors" : false, "status" : 1, "group_name" : "api_group_001", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "group_version" : "V1", "match_mode" : "NORMAL", "name" : "Api_http", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "type" : 1, "version" : "V0.0.1", "result_normal_sample" : "normal result", "result_failure_sample" : "failure result", "register_time" : "2020-07-31T12:42:51Z", "update_time" : "2020-08-02T16:32:47.046288842Z", "remark" : "Web backend API", "backend_params" : [ { "name" : "X-CONSTANT-HEADER", "value" : "demo", "location" : "HEADER", "origin" : "CONSTANT", "remark" : "constant_demo", "id" : "8cb2eba19e7a4423a4e835647a8b8d76" }, { "name" : "app-id", "value" : "$context.appId", "location" : "HEADER", "origin" : "SYSTEM", "remark" : "provider roma app id", "id" : "216ddda836e74d528f364ff589d9dd21" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

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

实例支持的APIC特性 若当前实例中无相关特性，可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持SHUBAO访问日志上报功能。 是 {"name":"lts","enable":true,"config": "{\"group_id\": ",\"topic_id\":\"\",\"log_group\":\"\",\"log_stream\":\"\"}"} group_id 日志组ID。 - - topic_id 日志流ID。 - - log_group 日志组名称。 - - log_stream 日志流名称。 - - gateway_responses 是否支持网关自定义响应。 否 - - - - - ratelimit 是否支持自定义流控值。 是 {"name":"ratelimit","enable":true,"config": "{\"api_limits\": 500}"} api_limits API全局默认流控值。注意：如果配置过小会导致业务持续被流控，请根据业务谨慎修改。 200 次/秒 1-1000000 次/秒 request_body_size 是否支持指定最大请求Body大小。 是 {"name":"request_body_size","enable":true,"config": "104857600"} request_body_size 请求中允许携带的Body大小上限。 12 M 1-9536 M backend_timeout 是否支持配置后端API超时时间。 是 {"name":"backend_timeout","enable":true,"config": "{"max_timeout": 500}"} max_timeout APIC到后端服务的超时时间上限。 60000 ms 1-600000 ms app_token 是否开启app_token认证方式。 是 {"name":"app_token","enable":true,"config": "{\"enable\": \"on\", \"app_token_expire_time\": 3600, \"app_token_uri\": \"/v1/apigw/oauth2/token\", \"refresh_token_expire_time\": 7200}"} enable 是否开启。 off on/off app_token_expire_time access token的有效时间。 3600 s 1-72000 s refresh_token_expire_time refresh token的有效时间。 7200 s 1-72000 s app_token_uri 获取Token 的uri。 /v1/apigw/oauth2/token - app_token_key Token的加密Key。 - - app_basic 是否开启app_basic认证方式。 是 {"name":"app_basic","enable":true,"config": "on"} - - off on/off app_secret 是否支持app_secret认证方式。 是 {"name":"app_secret","enable":true,"config": "on"} - - off on/off backend_token_allow 是否支持普通租户透传Token到后端。 是 {"name":"backend_token_allow","enable":true,"config": "{\"backend_token_allow_users\": [\"paas_apig_username_01\"]}"} backend_token_allow_users 透传Token到后端普通租户白名单，匹配普通租户domain name正则表达式。 - - sign_basic 签名密钥是否支持Basic类型。 否 - - - - - multi_auth API是否支持双重认证方式。 否 - - - - - backend_client_certificate 是否开启后端双向认证。 是 {"name":"backend_client_certificate","enable":true,"config": "{\"enable\": \"on\",\"ca\": \"\",\"content\": \"\",\"key\": \"\"}"} enable 是否开启。 off on/off ca 双向认证信任证书。 - - content 双向认证证书。 - - key 双向认证信任私钥。 - - ssl_ciphers 是否支持https加密套件。 是 {"name":"ssl_ciphers","enable":true,"config": "config": "{\"ssl_ciphers\": [\"ECDHE-ECDSA-AES256-GCM-SHA384\"]}"} ssl_ciphers 支持的加解密套件。ssl_ciphers数组中只允许出现默认值中的字符串，且数组不能为空。 - ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-RSA-AES128-GCM-SHA256,ECDHE-ECDSA-AES256-SHA384,ECDHE-RSA-AES256-SHA384,ECDHE-ECDSA-AES128-SHA256,ECDHE-RSA-AES128-SHA256 app_config 是否支持应用配置。 否 - - - - - green_tunnel 授权是否支持绿色通道。 否 - - - - - app_route 是否支持IP访问。 是 {"name":"app_route","enable":true,"config": "on"} - - off on/off default_group_hide 是否隐藏默认分组。注意：隐藏默认分组后不支持IP访问，如想使用IP访问，建议开启app_route配置。 是 {"name":"default_group_hide","enable":true,"config": "on"} - - off on/off cascade 是否开启级联功能。 是 {"name":"app_route","enable":true,"config": "{\"enable\": \"on\", \"cascade_auth_key\": \"abcdefabcdefabcdefabcdefabcdef11\", \"cascade_instance_ids\":\"104e4816-1e9c-4345-be3a-14528727d0e3\"}"} enable 是否开启级联功能。 off on/off cascade_auth_key 用于生成级联认证token的加密key。 - - cascade_instance_ids 级联时允许作为上级的实例ID。 - - sandbox 是否支持LDA函数沙箱配置。 是 {"name":"sandbox","enable":true,"config": "{\"max_cpu_time\": 30000, \"max_memory\": 1073741824}"} max_cpu_time 允许函数API中执行的CPU时间占用的最高时长。单位：毫秒。 60000 ms 1-1000000 ms max_memory 允许函数API中执行的内存大小。单位：字节。 256 M 1-9536 M livedata_config 是否支持后端服务自定义配置。同时存在sandbox和livedata_config时，优先使用livedata_config。 是 {"name":"sandbox","enable":true,"config": "{\"max_cpu_time\": 30000, \"max_memory\": 1073741824, \"max_memory\": 1073741824, \"dataapi_return_type\": \"no_string\", \"gw_address_protocol\": \"http\", \"livedata_env\": \"offline\",\"procedure_async\": \"off\"}"} max_cpu_time 允许函数API中执行的CPU时间占用的最高时长。单位：毫秒。 60000 ms 1-1000000 ms max_memory 允许函数API中执行的内存大小。单位：字节。 256 M 1-9536 M livedata_env 自定义后端的运行模式，设置为online时，自定义后端API将会按照线上格式返回。 online online/offline gw_address_protocol DICT:gw_rest_float_addr变量中使用的默认请求协议。 none http/https/none procedure_async 存储过程是否使用异步执行。 off on/off dataapi_return_type 数据API的返回格式。 no_string string/no_string real_ip_from_xff 是否使用X-Forwarded-For头中的IP作为ACL、流控的判断依据。 是 {"name": "real_ip_from_xff","enable": true,"config": {"enable": "on","xff_index": -1}} enable 是否开启。 off on/off xff_index X-Forwarded-For头中IP的排序序号，值允许为正数、负数、0。 值为0或正数时，获取X-Forwarded-For头中对应索引的IP。 值为负数时，按倒序方式从X-Forwarded-For头中获取IP。 例如到达API网关的X-Forwarded-For头中依次有IP1，IP2，IP3三个IP地址，xff_index取0时获取IP1，xff_index取1时获取IP2，xff_index取-1时获取IP3，xff_index取-2时获取IP2。 -1 int32有效值 apiclient_first_use_x_hw_id 自定义后端的ApiClient类是否优先使用X-HW-ID字段进行校验。 是 {"name":"apiclient_first_use_x_hw_id","enable":true,"config": "on"} - - off on/off custom_log 是否支持自定义日志功能。 是 {"name":"custom_log","enable":true,"config": "{\"custom_logs\":[{\"location\":\"header\",\"name\":\"test\"},{\"location\":\"query\",\"name\":\"x-query-test001\"}]}"} custom_logs 自定义日志中要打印参数的集合，数量不超过10个。 - - location 参数位置。 - header/query/cookie name 参数名称。 - - real_ip_header_getter 是否开启用户自定义Header获取源IP地址，作为访问控制、流控策略的源IP生效依据。 是 {"name":"real_ip_header_getter","enable":true,"config": "{\"enable\": \"on\",\"header_getter\": \"header:testIP\"}"} enable 是否开启。 off on/off header_getter 获取用户源IP地址的自定义Header。 - - vpc_name_modifiable 负载通道名称是否支持修改。 是 {"name":"vpc_name_modifiable","enable":true,"config": "on"} - - on on/off default_group_host_trustlist DEFAULT分组中的API是否支持非本实例IP访问。 是 {"name":"default_group_host_trustlist","enable":true,"config": "{\"enable\":\"on\",\"hosts\":[\"123.2.2.2\",\"202.2.2.2\"]}"} enable 是否开启。 off on/off hosts 非本实例IP列表。 - - data_api_column_types_converted_to_string 数据后端是否支持数据列类型转换String类型。 是 {"name": "data_api_column_types_converted_to_string", "enable": true, "config": "{\"enable\":\"on\",\"column_types\":[\"nvarchar2\"]}"} enable 是否开启。 off on/off column_types 数据列类型列表：勾选要转换String类型的数据列类型，当前仅支持nvarchar2类型。 - - sse_strategy 是否支持sse传输策略开关。 是 { "name": "sse_strategy", "enable": true, "config": "on" } - - off on/off request_custom_config 支持自定义配置客户端请求相关参数。 是 { "name": "request_custom_config", "enable": true, "config": "{\"http2\":\"on\",\"client_body_timeout\":10}" } http2 HTTP/2协议的开关。 on on/off client_body_timeout 客户端请求体超时时间。 8 秒 1-60 秒 api_uri_no_escape API中请求path的请求参数是否支持不转义 是 {"name":"api_uri_no_escape","enable":true,"config":""} enable 是否开启 false true/false 父主题： 附录

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "items" : [ { "product_template_id" : null, "product_id" : 122893, "service_id" : 10190, "service_name" : "s1", "description" : null, "status" : 0, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "created_datetime" : 1607502702474, "last_updated_datetime" : 1607572282845 } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services.queryService]. 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 表4 响应Body参数 参数 参数类型 描述 total Integer 总数。 最小值：1 最大值：99999999999999999 size Integer 本次返回数量。 最小值：1 最大值：999 items Array of Service objects 服务列表。 数组长度：0 - 9999 表5 Service 参数 参数类型 描述 product_template_id Integer 服务归属的产品模板ID。 最小值：1 最大值：99999999999999999 product_id Integer 服务归属的产品ID。 最小值：1 最大值：99999999999999999 service_id Integer 服务ID。 最小值：1 最大值：99999999999999999 service_name String 服务名称，支持中文、英文大小写、数字、下划线和中划线，长度2-64。 最小长度：2 最大长度：64 description String 服务描述，长度0-200。 最小长度：0 最大长度：200 status Integer 服务状态，0-启用，1-停用。 最小值：0 最大值：10 created_user CreatedUser object 创建时的用户。 last_updated_user LastUpdatedUser object 最后更新时的用户。 created_datetime Long 创建时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 last_updated_datetime Long 最后修改时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 表6 CreatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 最小长度：0 最大长度：64 user_name String 用户名。 最小长度：0 最大长度：64 表7 LastUpdatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 最小长度：0 最大长度：64 user_name String 用户名。 最小长度：0 最大长度：64 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

响应示例 状态码： 200 OK { "versions" : [ { "min_version" : "", "links" : { "rel" : "self", "href" : "https://roma.example.com/v1" }, "id" : "v1", "updated" : "2018-06-28T12:20:21Z", "version" : "", "status" : "SUPPORTED" }, { "min_version" : "", "links" : { "rel" : "self", "href" : "https://roma.example.com/v2" }, "id" : "v2", "updated" : "2020-06-28T12:20:21Z", "version" : "", "status" : "CURRENT" } ], "scene" : null }

响应参数 状态码： 200 表1 响应Body参数 参数 参数类型 描述 versions Array of Version objects 服务的API版本信息列表。 scene String 场景信息。 表2 Version 参数 参数类型 描述 id String API版本ID，如v1。 version String API的最大微版本号，不支持固定填空。 min_version String API的最小微版本号，不支持固定填空。 status String API版本状态。取值： CURRENT：主推版本。 SUPPORTED：老版本，仍继续支持。 DEPRECATED：废弃版本，后续可能会删除。 updated Number API版本发布UTC时间。 links links object API版本URL地址。 表3 links 参数 参数类型 描述 rel String 用途。 href String 该用途的URL。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 variable_value String 变量值支持英文字母、数字、英文格式的下划线、中划线，斜线（/）、点、冒号，1 ~ 255个字符。 env_id String 环境编号 最小长度：1 最大长度：65 group_id String API分组编号 最小长度：1 最大长度：65 variable_name String 变量名，支持英文字母、数字、英文格式的下划线、中划线，必须以英文字母开头，3~32个字符。在API定义中等于#Name的值#部分（区分大小写），发布到环境里的API被变量值替换。 说明： 中文字符必须为UTF-8或者unicode编码。 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 错误描述

响应示例 状态码： 201 Created { "variable_value" : "192.168.1.5", "env_id" : "7a1ad0c350844ee69479b47df9a881cb", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "id" : "25054838a624400bbf2267cf5b3a3f70", "variable_name" : "address" } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:variable_name" } 状态码： 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" }