华为云用户手册

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of integers 设备ID列表，自动向下取整。 最小值：1 最大值：9999999999999999999 数组长度：0 - 9999

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

请求消息 请求参数 表2 Body参数 名称 类型 是否必填 描述 app_id string 是 应用ID。 product_name string 是 需要创建产品的名称，输入参数不能为空，长度最大64，仅支持中文、英文字母、数字、下划线和中划线。 remark string 否 描述信息，不能超过200个字符。 请求示例 https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1/products { "app_id" : "app01", "product_name" : "product01", "remark" : "this is a demo." }

响应消息 响应参数 表3 响应参数 名称 类型 描述 password string 密码。 product_id integer 产品ID。 product_name string 产品名。 product_serial string 产品序列号。 remark string 描述信息，不能超过200个字符。 user_name string 用户名。 响应示例 { "product_id": 250, "product_name": "product01", "product_serial": "wbgfcYR6p250", "remark": "this is a demo.", "password": "*****************", "user_name": "8f9be623df1249429dcfead6c0d541d3" }

响应示例 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-rulesrc.delete]. Parameter is [rule_oid]. 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 OK { "total" : 1, "size" : 1, "items" : [ { "permissions" : [ "read", "access", "delete", "modify" ], "id" : 120671, "product_serial" : "Dd1bRt122894", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "name" : "pro-opcua", "manufacturer_id" : "pro-opcua", "manufacturer_name" : "pro-opcua", "model" : "pro-opcua", "product_type" : 0, "description" : "opcua product", "protocol_type" : 4, "device_type" : "default", "version" : "version", "created_datetime" : 1607481372416, "last_updated_datetime" : 1607481372416, "app_name" : "app-link", "data_format" : 0, "created_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "last_updated_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "authentication" : { "user_name" : "4MjxbCl4q461", "password" : "********" } } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.search]. Parameter is [product_type]. Processor is [query].", "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 Long 查询任务列表任务总个数。 最小值：0 最大值：1000000 size Integer 查询任务列表返回的当前页的任务个数。 最小值：0 最大值：1000 entities Array of BriefTaskRespBean objects 查询任务列表返回的对象。 数组长度：1 - 9999 表5 BriefTaskRespBean 参数 参数类型 描述 task_id String 任务ID。 最小长度：1 最大长度：64 task_name String 任务名称。 最小长度：1 最大长度：64 task_type String 任务类型。 REALTIME (实时) TIMING (定时) 最小长度：1 最大长度：10 status Integer 任务状态。 0 (停止/未启动) 1 (运行中) 最小值：0 最大值：1 created_date String 创建时间。 version String 任务的版本。 最小长度：0 最大长度：10 last_modified_time Long 上次修改时间。 最小值：1 最大值：9999999999999999999 execute_status String 任务执行状态。 UNSTARTED (未启动) WAITING (等待执行) RUNNING (执行中) SUC CES S (执行成功) CANCELLED (任务取消) ERROR (执行异常) 最小长度：1 最大长度：64 source_app_id String 源端数据源所属应用ID。 最小长度：1 最大长度：64 target_app_id String 目标端数据源所属应用ID。 最小长度：1 最大长度：64 source_instance_id String 源端实例ID。 最小长度：1 最大长度：64 target_instance_id String 目标端实例ID。 最小长度：1 最大长度：64 ext_type String 组合任务类型, 可为空。 最小长度：1 最大长度：64 enterprise_project_id String 企业项目ID。 最小长度：1 最大长度：64 task_tag String 任务标签。 最小长度：1 最大长度：64 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "entities" : { "task_id" : "15366328208d4d77b76532fe9f4006a6", "task_name" : "task_cdc_oracle2oracle", "task_type" : "TIMING", "status" : 0, "created_date" : "1605288733684", "version" : "2", "last_modified_time" : 456223355566, "execute_status" : "ERROR", "source_app_id" : "73b7f7a6-d1b8-4806-a0f8-278fe7186592", "target_app_id" : "73b7f7a6-d1b8-4806-a0f8-278fe7186592", "source_instance_id" : "fae7ff6c-8e07-4cf8-9e67-589cab2f017c", "target_instance_id" : "fae7ff6c-8e07-4cf8-9e67-589cab2f017c", "ext_type" : "cdc", "enterprise_project_id" : "0", "task_tag" : "fdi_autotest" } }

响应示例 状态码： 200 OK { "permissions" : [ "read", "access", "delete", "modify" ], "id" : 120671, "product_serial" : "Dd1bRt122894", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "name" : "pro-opcua", "manufacturer_id" : "pro-opcua", "manufacturer_name" : "pro-opcua", "model" : "pro-opcua", "product_type" : 0, "description" : "opcua product", "protocol_type" : 4, "device_type" : "default", "version" : "version", "created_datetime" : 1607481372416, "last_updated_datetime" : 1607481372416, "app_name" : "app-link", "data_format" : 0, "created_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "last_updated_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "authentication" : { "user_name" : "4MjxbCl4q461", "password" : "********" } } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.searchProductDetails]. Parameter is [product_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 ff38023c-0854-4779-847d-72528e1f5da5 is correct.", "request_id" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应示例 状态码： 200 OK { "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:25:59Z", "name" : "livedata_api_demo", "parameters" : [ ], "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "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.3084", "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应示例 状态码： 200 OK { "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:25:59Z", "name" : "livedata_api_demo", "parameters" : [ ], "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "scripts" : [ { "type" : "SQL", "object_name" : "fun", "content" : "ZnVuY3Rpb24gZXhlY3V0ZShkYXRhKSB7CiAgICByZXR1cm4gIkhlbGxvIHdvcmxkISIKfQ==", "created_time" : "2020-09-19T06:29:35Z", "modified_time" : "2020-09-19T06:29:35Z" } ], "status" : 1, "type" : "", "version" : "1.0.1" } 状态码： 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.3081", "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found" } 状态码： 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参数 参数 是否必选 参数类型 描述 api_id 否 String 后端API编号 api_type 否 String API类型 data：数据API function：函数API scripts 否 Array of LdApiScript objects API脚本信息列表 表4 LdApiScript 参数 是否必选 参数类型 描述 ds_id 否 String 数据源编号，当api_type = data时，必选 ds_name 否 String 数据源名称 ds_type 否 String 数据源类型： oracle：oracle数据源类型 mysql：mysql数据源类型 mongodb：mongodb数据源类型 redis：redis数据源类型 postgresql：postgresql/opengauss数据源类型 hive：hive数据源类型 mssql：sqlserver数据源类型 sqlserver：sqlserver数据源类型 dws：dws数据源类型 gauss100：gauss100数据源类型 zenith：zenith数据源类型 hana: hana数据源类型 clickhouse: clickhouse数据源类型 mrshive: mrshive数据源类型(tag:Site_hybrid) dm : dameng数据源类型(tag:hcs) opengauss : opengauss数据源类型(tag:hcs) type 否 String 脚本类型 SQL：sql语句 SP：存储过程 object_name 是 String 返回对象。 最小长度：1 最大长度：32 content 是 String API脚本内容 请对脚本进行base64编码 最小长度：1 最大长度：100000 enable_result_paging 否 Boolean 数据脚本是否结果分页，当api_type = data时有效 缺省值：false enable_preparestatement 否 Boolean 数据脚本是否预编译，当api_type = data时有效 缺省值：false created_time 否 String 后端API脚本创建时间 modified_time 否 String 后端API脚本修改时间

请求示例 { "api_id" : "bd42841c20184da6bbf457c6d8a06e37", "api_type" : "function", "scripts" : [ { "type" : "SQL", "object_name" : "fun", "content" : "ZnVuY3Rpb24gZXhlY3V0ZShkYXRhKSB7CiAgICByZXR1cm4gIkhlbGxvIHdvcmxkISIKfQ==" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数。 最小值：0 最大值：99999999 size Integer 本次返回数量。 最小值：0 最大值：9999 items Array of ProductTemplate objects 产品模板信息。 数组长度：0 - 9999 表5 ProductTemplate 参数 参数类型 描述 id Integer 产品模板ID。 最小值：1 最大值：99999999999999999 name String 产品模板名称。 最小长度：1 最大长度：64 description String 产品模板描述。 最小长度：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 { "total" : 1, "size" : 1, "items" : [ { "id" : 2235, "name" : "template", "description" : "description", "status" : 0, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "created_datetime" : 1607303564596, "last_updated_datetime" : 1607571061057 } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-producttemplate.pageQuery]. Parameter is [status]. Processor is [query].", "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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 task_name 是 String 任务名称，只能以字母、数字为开头，包含字母、数字和 . _ - 3~100个字符。 最小长度：3 最大长度：100 task_id 否 String 任务ID，可以为空。 最小长度：3 最大长度：50 task_type 否 String 任务类型，目前组合任务仅支持实时任务。 REALTIME (实时) TIMING (定时) 最小长度：1 最大长度：10 description 否 String 描述信息。 最小长度：1 最大长度：1024 task_tag 否 String 任务标签，只能包含字母、数字、中划线、下划线。 最小长度：4 最大长度：64 operation_types 是 Array of strings 需要支持的操作类型，支持多选，至少需要选择以下一种： INSERT UPDATE DELETE 数组长度：1 - 3 source_app_id 否 String 源端数据源所属集成应用ID。 最小长度：1 最大长度：64 target_app_id 否 String 目标端数据源所属集成应用ID。 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 task_id String 任务ID, 可为空。 最小长度：1 最大长度：64 状态码： 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

请求示例 创建一个数据集成组合任务，任务类型为实时任务，包含插入、更新和删除操作 { "task_name" : "cdctest1", "task_id" : "a9fe65f41****6a5d646477c52", "task_type" : "REALTIME", "description" : "create", "task_tag" : "combination", "operation_types" : [ "INSERT", "UPDATE", "DELETE" ], "source_app_id" : "d5afd9af-a8fe-47f6-a98c-edbcba11a0da", "target_app_id" : "d5afd9af-a8fe-47f6-a98c-edbcba11a0da" }

响应示例 状态码： 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 OK { "histories" : { "api_id" : "1d0432f1a82a49d08b9308ae7bd96ca6", "deploy_time" : "2020-09-28T11:01:09Z", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "group_id" : "01ce7564a2544713b80c7c08eb85f5d0", "id" : "abbe44b56eda428d84172343674c9cd6", "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37" } } 状态码： 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 表3 响应Body参数 参数 参数类型 描述 id String 编号 name String API分组名称 status Integer 状态 1：有效 2：锁定 sl_domain String 系统默认分配的子 域名 register_time String 创建时间 update_time String 最近修改时间 on_sell_status Integer 是否已上架云市场： 1：已上架 2：未上架 3：审核中 ROMA Connect暂未对接云市场，此字段默认返回2 url_domains Array of UrlDomain objects 分组上绑定的独立域名列表 sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer 是否为默认分组 version String 分组版本 V1：全局分组 V2：应用级分组 roma_app_id String 分组归属的集成应用编号。 分组版本V2时必填。 roma_app_name String 分组归属的集成应用名称 表4 UrlDomain 参数 参数类型 描述 id String 域名编号 domain String 访问域名 cname_status Integer 域名cname状态： 1：未解析 2：解析中 3：解析成功 4：解析失败 ssl_id String SSL证书编号 ssl_name String SSL证书名称 min_ssl_version String 最小ssl协议版本号。支持TLSv1.1或TLSv1.2 缺省值：TLSv1.1 verified_client_certificate_enabled Boolean 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 缺省值：false is_has_trusted_root_ca Boolean 是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。 缺省值：false ssl_infos Array of SslInfo objects SSL证书列表 表5 SslInfo 参数 参数类型 描述 ssl_id String SSL证书编号 ssl_name String SSL证书名称 algorithm_type String 证书算法类型： RSA ECC SM2 type String 证书可见范围： instance：当前实例 global：全局 缺省值：global 状态码： 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 { "update_time" : "2020-07-31T06:55:55Z", "name" : "api_group_001", "on_sell_status" : 2, "remark" : "group1", "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ], "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "register_time" : "2020-07-31T06:55:55Z", "status" : 1, "is_default" : 2, "version" : "V1" } 状态码： 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" }

WAF转发和Nginx转发有什么区别？ WAF转发和Nginx转发的主要区别为Nginx是直接转发访问请求到源站服务器，而WAF会先检测并过滤恶意流量，再将过滤后的访问请求转发到源站服务器，详细说明如下： WAF转发 网站接入WAF后，所有访问请求将先经过WAF，WAF通过对HTTP(S)请求进行检测，识别并阻断SQL注入、跨站脚本攻击、网页木马上传、命令/代码注入、文件包含、敏感文件访问、第三方应用漏洞攻击、CC攻击、恶意爬虫扫描、跨站请求伪造等攻击流量后，将正常流量返回给源站，从而确保Web应用安全、稳定、可用。 图1 防护原理 Nginx转发 即反向代理（Reverse Proxy）方式转发。反向代理服务器接受客户端访问请求后，直接将访问请求转发给Web服务器，并将从Web服务器上获取的结果返回给客户端。反向代理服务器安装在网站机房，代理Web服务器接收访问请求，并对访问请求进行转发。 反向代理可以防止外网对内网服务器的恶性攻击，缓存以减少内网服务器压力，还可以实现访问安全控制和负载均衡。 图2 Nginx转发原理 父主题： 产品咨询

Web应用防火墙 和 云防火墙 有什么区别？ Web应用防火墙和云防火墙是华为云推出的两款不同的产品，分别针对您的Web服务，互联网边界和VPC边界的流量进行防护。 WAF和CFW的主要区别说明如表1所示。 表1 WAF和CFW的主要区别说明 类别 Web应用防火墙 云防火墙 定义 Web应用防火墙（Web Application Firewall，WAF），通过对HTTP(S)请求进行检测，识别并阻断SQL注入、跨站脚本攻击、网页木马上传、命令/代码注入、文件包含、敏感文件访问、第三方应用漏洞攻击、CC攻击、恶意爬虫扫描、跨站请求伪造等攻击，保护Web服务安全稳定。 云防火墙（Cloud Firewall，CFW）是新一代的云原生防火墙，提供云上互联网边界和VPC边界的防护，包括实时入侵检测与防御、全局统一访问控制、全流量分析可视化、日志审计与溯源分析等，同时支持按需弹性扩容、AI提升智能防御能力、灵活扩展满足云上业务的变化和扩张需求，极简应用让用户快速灵活应对威胁。云防火墙服务是为用户业务上云提供网络安全防护的基础服务。 有关CFW的详细介绍，请参见什么是云防火墙。 防护机制 网站成功接入WAF后，WAF作为一个反向代理存在于客户端和服务器之间，网站所有访问请求将先流转到WAF，WAF检测过滤恶意攻击流量后，将正常流量返回给源站，从而确保源站安全、稳定、可用。 CFW可对全流量进行精细化管控，包括互联网边界防护，跨VPC，NAT流量防护，防止外部入侵、内部渗透攻击和从内到外的非法访问。 部署模式 WAF支持云模式、独享模式和ELB模式。 云模式-CNAME接入：业务服务器部署在华为云、非华为云或线下，且防护对象为域名。 各服务版本推荐使用的场景说明如下： 入门版 个人网站防护 标准版 中小型网站，对业务没有特殊的安全需求 专业版 中型企业级网站或服务对互联网公众开放，关注数据安全且具有高标准的安全需求 铂金版 中大型企业网站，具备较大的业务规模，或是具有特殊定制的安全需求 云模式-ELB接入：业务服务器部署在华为云，防护对象为域名或IP。大型企业网站，对业务稳定性有较高要求的安全防护需求。 独享模式：业务服务器部署在华为云，防护对象为域名或IP。大型企业网站，具备较大的业务规模且基于业务特性具有制定个性化防护规则的安全需求。 互联网边界和VPC边界 防护对象 云模式-CNAME接入：域名。 独享模式/云模式-ELB接入：域名或IP。 弹性公网IP和VPC 功能特性 SQL注入、跨站脚本攻击、网页木马上传、命令/代码注入、文件包含、敏感文件访问、第三方应用漏洞攻击、CC攻击、恶意爬虫扫描、跨站请求伪造等攻击防护。 WAF具体支持的功能请参见功能特性。 资产管理与入侵防御：对已开放公网访问的服务资产进行安全盘点，进行实时入侵检测与防御。 访问控制：支持互联网边界访问流量的访问控制。 流量分析与日志审计：VPC间流量全局统一访问控制，全流量分析可视化，日志审计与溯源分析。 父主题： 产品咨询

WAF如何解析/访问IPv6源站？ 当防护网站的源站地址配置为IPv6地址时，WAF直接通过IPv6地址访问源站。WAF默认在CNAME中增加IPv6地址解析，IPv6的所有访问请求将先流转到WAF，WAF检测并过滤恶意攻击流量后，将正常流量返回给源站，从而确保源站安全、稳定、可用。 WAF支持IPv6/IPv4双栈模式和NAT64机制，详细说明如下： Web应用防火墙支持IPv6/IPv4双栈，针对同一域名可以同时提供IPv6和IPv4的流量防护。 针对仍然使用IPv4协议栈的Web业务，Web应用防火墙支持NAT64机制（NAT64是一种通过 网络地址转换 （NAT）形式促成IPv6与IPv4主机间通信的IPv6转换机制），即WAF可以将外部IPv6访问流量转化成对内的IPv4流量。 哪些Region支持IPv6防护请参考功能总览。 仅专业版和铂金版支持IPv6防护。 父主题： IPv6防护

如果流量超过Web应用防火墙的业务请求限制，该如何处理？ 如果您的正常业务流量超过您已购买的WAF版本的业务请求限制，您在WAF中配置的全部业务的流量转发将可能受到影响。 超出业务请求限制后，可能出现限流、随机丢包、自动Bypass等现象，导致您的正常业务在一定时间内不可用、卡顿、延迟等。 超出业务请求限制后，WAF不会发告警通知，当QPS超过版本支持的峰值且受到攻击时，WAF会发送告警通知。有关告警通知的详细介绍，请参见开启告警通知。 如果出现这种情况，您需要升级WAF版本或者扩展业务QPS，避免正常业务流量超出业务带宽限制所产生的影响。 有关升级版本的详细介绍，请参见变更WAF云模式版本和规格。 父主题： 购买和变更规格

Web应用防火墙支持配置泛域名吗？ 在WAF中添加防护的域名时，您可以根据业务需求配置单域名或泛域名，说明如下： 入门版不支持添加泛域名。 单域名 配置待防护的单域名。例如：www.example.com。 泛域名 配置泛域名可以使泛域名下的多级域名经过WAF防护。 如果各子域名对应的服务器IP地址相同：配置防护的泛域名。例如：子域名a.example.com，b.example.com和c.example.com对应的服务器IP地址相同，可以直接添加泛域名*.example.com。 如果各子域名对应的服务器IP地址不相同：请将子域名按“单域名”方式逐条配置。 有关添加防护域名的详细操作，请参见添加防护域名。 父主题： 网站接入

如何降低Web应用防火墙的版本和规格？ WAF云模式提供了入门版、标准版、专业版和铂金版四种服务版本。WAF支持降低WAF的版本和域名扩展包、QPS扩展包、规则扩展包的数量，如果您需要降低当前的WAF版本和规格，在产品信息页面进行操作，详细操作请参见变更WAF云模式版本和规格。 已到期的服务版本，不支持变更规格，请先完成续费再变更规格。 扩展包只能退订未使用的扩展包。 有关WAF各版本规格的详细说明，请参见服务版本差异。 有关退订的详细操作，请参见如何退订Web应用防火墙？。 有关退订重购后，原配置数据的相关说明，请参见退订后重购WAF，原配置数据可以保存吗？。 父主题： 购买和变更规格