华为云用户手册

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 publish_id String 发布记录的ID api_id String API编号 api_name String API名称 env_id String 发布的环境编号 remark String 发布描述 publish_time String 发布时间 version_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 { "api_id" : "5f918d104dc84480a75166ba99efff21", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2", "publish_time" : "2020-08-03T01:36:00.592970615Z", "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b", "remark" : "" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:action. 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" }

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "plugins" : [ { "plugin_id" : "5b729aa252764739b3s237ef0d66dc63", "plugin_name" : "跨域插件", "plugin_type" : "cors", "plugin_scope" : "global", "plugin_content" : "{\"allow_origin\": \"*\",\"allow_methods\": \"GET,POST,PUT\",\"allow_headers\": \"Content-Type,Accept,Accept-Ranges,Cache-Control\",\"expose_headers\": \"X-Request-Id,X-Apig-Latency\",\"max_age\": 172800,\"allow_credentials\": true}", "remark" : "CORS跨域资源访问", "create_time" : "2022-11-02T12:31:23.353Z", "update_time" : "2022-11-02T12:31:23.353Z" } ] } 状态码： 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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins Array of PluginInfo objects 插件列表。 表5 PluginInfo 参数 参数类型 描述 plugin_id String 插件编码。 plugin_name String 插件名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3-255字符。 说明： 中文字符必须为UTF-8或者unicode编码。 plugin_type String 插件类型 cors：跨域资源共享 set_resp_headers：HTTP响应头管理 kafka_log：Kafka日志推送 breaker：断路器 rate_limit: 流量控制 third_auth: 第三方认证 plugin_scope String 插件可见范围 global：全局可见 app：集成应用可见 plugin_content String 插件定义内容，支持json。参考提供的具体模型定义 CorsPluginContent：跨域资源共享 定义内容 SetRespHeadersContent：HTTP响应头管理 定义内容 KafkaLogContent：Kafka日志推送 定义内容 BreakerContent：断路器 定义内容 RateLimitContent 流量控制 定义内容 ThirdAuthContent: 第三方认证 定义内容 最大长度：65535 remark String 插件描述，255字符。 说明： 中文字符必须为UTF-8或者unicode编码。 最大长度：255 create_time String 创建时间。 update_time String 更新时间。 roma_app_id String 归属集成应用编码，plugin_scope为app时生效 roma_app_name String API归属的集成应用名称 状态码： 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 { "total" : 1, "size" : 1, "apps" : [ { "app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "app_key" : "9b93db07-4634-4b7a-99d8-869933ed055d", "app_quota_name" : "ClientQuota_demo", "bound_time" : "2020-09-19T07:43:11Z", "name" : "app-demo", "register_time" : "2020-09-18T09:25:19Z", "status" : 1, "update_time" : "2020-09-18T09:25:19Z" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:app_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.3093", "error_msg" : "The App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apps Array of AppQuotaAppInfo objects 客户端应用列表 表5 AppQuotaAppInfo 参数 参数类型 描述 app_id String 客户端应用编号 name String 客户端应用名称 status Integer 客户端应用状态： 1：启用 2：禁用 app_key String 客户端应用的Key remark String 客户端应用描述 register_time String 创建时间 update_time String 更新时间 app_quota_id String 客户端配额编号 app_quota_name String 配额名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3-255字符 bound_time String 绑定时间 状态码： 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 错误描述

请求示例 https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/access-policies/batch-add { "policies" : [ { "user_name" : "62034763-c4aa-416f-975d-1452ba90fec2", "app_name" : "app-uve7", "access_policy" : "sub", "tag" : "123&abc" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policies 是 Array of PolicyEntity objects 应用topic权限列表 表4 PolicyEntity 参数 是否必选 参数类型 描述 user_name 是 String 应用key（access key） app_name 是 String 应用名称 access_policy 是 String 权限类型 all:拥有发布、订阅权限； pub:拥有发布权限； sub:拥有订阅权限。 tag 否 String 标签列表，权限类型对应的标签。 当权限类型是all时，发布和订阅的标签用符号“&”隔开。 当有多个标签时，标签用符号“||”隔开。 规则：仅能包含数字、字母、中划线（-）、下划线（_），长度不超过48。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String topic名称，以字母开头，仅能包含数字，字母，下划线(_)，中划线（-），长度3-200字符。 app_id 是 String 集成应用key。 app_key 否 String 集成应用key。 partition 否 Integer topic分区数，设置消费的并发数。 取值范围：1-100。 默认值：3。 replication 否 Integer 副本数，配置数据的可靠性。 取值范围：1-3。 默认值：3。 access_policy 是 String 权限类型。 all：发布+订阅 pub：发布 sub：订阅 sync_message_flush 否 Boolean 是否使用同步落盘。默认值为false。同步落盘会导致性能降低。 sync_replication 否 Boolean 是否开启同步复制，开启后，客户端生产消息时相应的也要设置acks=-1，否则不生效，默认关闭。 retention_time 否 Integer 消息老化时间。默认值为72。取值范围1~168，单位小时。 tag 否 String 权限类型对应的标签。 当权限类型是all时，发布和订阅的标签用符号“&”隔开。 当有多个标签时，标签用符号“||”隔开。 description 否 String 描述。长度0-1000字符。 sensitive_word 否 String 敏感字段。 当有多个敏感字段时，敏感字段用符号“||”隔开。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 name String topic名称。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

请求示例 创建一个Topic，分区数为3，副本数为3，消息老化时间为72小时 POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics { "name" : "topic-test-2", "app_id" : "c5abd910-02b1-4bc4-b587-c3fe4c49dab9", "partition" : 3, "access_policy" : "all", "replication" : 3, "retention_time" : 72, "sync_replication" : false, "sync_message_flush" : false, "tag" : "11 || 22 || aa || bb&11 || 22 || aa || bb", "description" : "test", "sensitive_word" : "sss || ddd" }

响应示例 状态码： 200 OK { "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2", "api_id" : "5f918d104dc84480a75166ba99efff21", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b", "publish_time" : "2020-08-03T03:27:49.483295655Z", "remark" : "" } 状态码： 400 Bad Request { "error_code" : "APIG.2000", "error_msg" : "Parameter error: Serialization error: unexpected end of JSON input" } 状态码： 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.3022", "error_msg" : "The API version does not exist,id:ee1a5a38d3d3493abf1dc4ed6cacfa0b" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 publish_id String 发布记录的ID api_id String API编号 api_name String API名称 env_id String 发布的环境编号 remark String 发布描述 publish_time String 发布时间 version_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 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 最小值：1 最大值：9999999999 size Integer 本次返回数量 最小值：1 最大值：999 items Array of NotificationResponseBody objects 订阅管理列表 数组长度：0 - 9999 表5 NotificationResponseBody 参数 参数类型 描述 notification_id Integer 订阅ID 最小值：0 最大值：100 type Integer 订阅类型, 0:设备上线通知类型, 1:设备下线通知类型, 2:设备添加通知类型, 3:设备删除通知类型, 4:设备变更通知类型 最小值：0 最大值：4 status Integer 订阅管理状态，0：启用，1：停用 最小值：0 最大值：1 topic String 订阅的topic名称 最小长度：3 最大长度：200 instance_id String 实例ID 最小长度：0 最大长度：20 app_id String 应用ID 最小长度：0 最大长度：64 destination_type String 操作类型，枚举值:MQS-目标端为本ROMA实例内MQS; MRSKAFKA-目标端为本ROMA实例内MRS KAFKA数据源; THIRD_KAFKA-目标端为本ROMA实例内KAFKA数据源 最小值：0 最大值：10 destination_app_id String 目的端归属的应用ID，如果为空则和app_id一致 最小长度：0 最大长度：36 destination_name String 目标数据源名称，destination_type值为1、2或3时， 为对应KAFKA类数据源的名称 最小长度：0 最大长度：64 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64

响应示例 状态码： 200 OK { "total" : 9999999999, "size" : 999, "items" : [ { "notification_id" : 100, "type" : 0, "status" : 0, "topic" : "string", "instance_id" : "string", "app_id" : "string" } ] } 状态码： 400 Bad Request { "error_code" : "string", "error_msg" : "string", "request_id" : "string" } 状态码： 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" : "string", "error_msg" : "string", "request_id" : "string" }

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "features" : [ { "config" : "on", "enable" : true, "id" : "db9a9260cd3e4a16a9b5747a65d3ffaa", "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e", "name" : "app_api_key", "update_time" : "2020-08-24T01:17:31.041984Z" } ] } 状态码： 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 满足条件的记录数 features Array of FeatureInfoV2 objects 实例特性列表 表5 FeatureInfoV2 参数 参数类型 描述 id String 特性编号 name String 特性名称 最小长度：1 最大长度：64 enable Boolean 是否开启特性 config String 特性参数配置 instance_id String 实例编号 update_time String 实例特性更新时间 状态码： 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 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String API名称。 type = name时必填 req_method 否 String 请求方式。 type = path时必填 req_uri 否 String API的访问地址。 type = path时必填 match_mode 否 String API的匹配方式 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配） type = path时必填 group_id 否 String 分组ID。 校验分组下API定义是否重复时必填 roma_app_id 否 String 集成应用ID。 校验应用下API定义是否重复时必填 api_id 否 String 需要对比的API ID type 是 String 校验类型： path：路径类型 name：名称类型

响应示例 状态码： 400 Bad Request { "error_code" : "APIG.3202", "error_msg" : "The API name already exists, api_name:api_demo" } 状态码： 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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 FormData参数 参数 是否必选 参数类型 描述 source_ds_id 是 String 源端数据源ID 最小长度：1 最大长度：64 source_group 否 String 源表分组 缺省值：SOURCE_GROUP1 最大长度：64 target_ds_id 是 String 目标端数据源ID 最小长度：1 最大长度：64 target_group 否 String 目标表分组 缺省值：TARGET_GROUP1 最大长度：64 task_id 否 String 任务唯一标识，任务ID 最小长度：0 最大长度：64 ext_info 否 String 额外标识 task_type 否 Integer 1：实时任务，2：定时任务 mapping_prefix 否 String 映射前缀(根据前后缀组合将源端表映射至匹配目标端表名称 = 前缀(可选) + 源端表名称 + 后缀(可选)) mapping_suffix 否 String 映射后缀(根据前后缀组合将源端表映射至匹配目标端表名称 = 前缀(可选) + 源端表名称 + 后缀(可选)) target_select_mapping_tables 否 String 目标端映射范围（选择多表用半角,分隔：schema.table1,schema.table2；选择全库：schema.*） source_select_mapping_tables 否 String 源端映射范围（选择多表用半角,分隔：schema.table1,schema.table2；选择全库：schema.*）

响应示例 状态码： 200 ok [ { "target_instance_id" : "62afe8b5-6bf0-40ea-b4f6-6b06a39be754", "source_app_id" : "c24d7cf4-0e5a-416c-b197-30e6696b98f2", "mapping" : [ { "ext_info" : { "server_id" : 1665647763438 }, "id" : "f1c1d7f3afc94c1c995628df55939ced", "mapping" : [ { "is_add_boolean_mapping" : false, "is_add_custom_mapping" : false, "is_add_date_mapping" : false, "is_add_fdi_uuid_mapping" : false, "is_add_mapping" : false, "source_column" : "c1", "source_column_length" : "10", "source_column_type" : "INT", "target_column" : "c1", "target_column_length" : "10", "target_column_type" : "INT" }, { "is_add_boolean_mapping" : false, "is_add_custom_mapping" : false, "is_add_date_mapping" : false, "is_add_fdi_uuid_mapping" : false, "is_add_mapping" : false, "source_column" : "c2", "source_column_length" : "100", "source_column_type" : "VARCHAR", "target_column" : "c2", "target_column_length" : "100", "target_column_type" : "VARCHAR" } ], "mapping_percent" : 100, "project_id" : "0ab7e64afd80d2822fe0c00d26395a1f", "source_columns" : [ { "field_length" : "10", "field_name" : "c1", "field_type" : "INT", "null_able" : "0", "unique" : "1" }, { "field_length" : "100", "field_name" : "c2", "field_type" : "VARCHAR", "null_able" : "1", "unique" : "0" } ], "source_ds_id" : "984edcd6735c4988b15f6a497cb97c5a", "source_group" : "SOURCE_GROUP1", "source_table" : "test.t1", "status" : "ADD", "target_columns" : [ { "field_length" : "10", "field_name" : "c1", "field_type" : "INT", "null_able" : "0", "unique" : "0" }, { "field_length" : "100", "field_name" : "c2", "field_type" : "VARCHAR", "null_able" : "1", "unique" : "0" } ], "target_ds_id" : "dd14c908aa4d446b85949550f523ff83", "target_group" : "TARGET_GROUP1", "target_table" : "fditest.t1", "task_id" : "e530a006683d400e8b3bac1d7c00952b", "updated_time" : 1665647764511 } ], "target_ds_name" : "fdi_MySQL_zqx_205", "target_app_id" : "c24d7cf4-0e5a-416c-b197-30e6696b98f2", "source_instance_id" : "62afe8b5-6bf0-40ea-b4f6-6b06a39be754", "task_id" : "e530a006683d400e8b3bac1d7c00952b", "source_ds_type" : "MYSQL", "ext_info" : { "server_id" : 1665647763438 }, "target_ds_type" : "MYSQL", "total" : 1, "source_group" : "SOURCE_GROUP1", "source_ds_id" : "984edcd6735c4988b15f6a497cb97c5a", "target_group" : "TARGET_GROUP1", "source_ds_name" : "mysql8.0.30", "target_ds_id" : "dd14c908aa4d446b85949550f523ff83" } ]

响应示例 状态码： 200 OK { "permissions" : [ "read", "access", "delete", "modify" ], "rule_id" : 702244, "name" : "rule", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "app_name" : "app-link", "description" : null, "status" : 0, "data_parsing_status" : 1, "sql_field" : null, "sql_where" : null, "rule_express" : null, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "created_datetime" : 1607598152997, "last_updated_datetime" : 1607598152997 } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-rule.update]. 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 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" }

请求示例 修改指定规则的信息，规则状态和数据解析状态修改为启用，并修改查询字段和查询条件 { "name" : "rule", "description" : "rule", "status" : 0, "data_parsing_status" : 0, "sql_field" : "field1", "sql_where" : "field2 like '%HAHA%'" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 规则名称，支持英文大小写，数字，下划线和中划线,长度1-64 最小长度：1 最大长度：64 description 否 String 描述，长度0-200 最小长度：0 最大长度：200 status 否 Integer 规则状态 0-启用 1-停用，不填写时默认为0-启用 最小值：0 最大值：10 data_parsing_status 否 Integer 数据解析状态，0-启用 1-停用，不填写时默认为1-禁用 最小值：0 最大值：10 sql_field 否 String SQL查询字段 最小长度：0 最大长度：2000 sql_where 否 String SQL查询条件 最小长度：0 最大长度：2000

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 permissions Array of strings 权限 rule_id Integer 规则ID 最小值：1 最大值：99999999999999999 name String 规则名称，支持英文大小写，数字，下划线和中划线,长度1-64 最小长度：1 最大长度：64 app_id String 应用ID 最小长度：0 最大长度：64 app_name String 应用名称 最小长度：0 最大长度：256 description String 描述 最小长度：0 最大长度：200 status Integer 规则状态 0-启用 1-停用 最小值：0 最大值：10 data_parsing_status Integer 数据解析状态，ENABLE时data_parsing必填 0-启用 1-停用 最小值：0 最大值：10 sql_field String SQL查询字段 最小长度：0 最大长度：2000 sql_where String SQL查询条件 最小长度：0 最大长度：2000 rule_express String 完整的规则表达式 最小长度：0 最大长度：2000 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 表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

请求示例 创建一个自定义认证，认证类型为前端认证，函数类型为自定义后端函数，认证来源使用Header参数 { "name" : "Authorizer_demo", "type" : "FRONTEND", "authorizer_type" : "LD", "ld_api_id" : "6f8e61317e4e4fbf8e8220cc19fcced9", "authorizer_uri" : "/test", "network_type" : "", "authorizer_version" : "", "authorizer_alias_uri" : "", "identities" : [ { "name" : "header", "location" : "HEADER" } ], "ttl" : 5 }

响应示例 状态码： 201 Created { "name" : "Authorizer_demo", "type" : "FRONTEND", "authorizer_type" : "LD", "authorizer_uri" : "/test", "network_type" : "", "authorizer_version" : "", "authorizer_alias_uri" : "", "identities" : [ { "name" : "header", "location" : "HEADER" } ], "ttl" : 5, "id" : "0d982c1ac3da493dae47627b6439fc5c", "create_time" : "2020-09-23T02:32:10.354159293Z", "need_body" : true } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:type. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3019", "error_msg" : "The function URN does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 name String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type String 自定义认证类型 FRONTEND：前端 BACKEND：后端 authorizer_type String 自定义认证函数类型： LD：自定义后端函数 FUNC：函数服务函数 authorizer_uri String 函数地址。 注意：使用自定义后端的函数API，API请求方法必须为POST，且API状态必须为已部署。 network_type String 对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构 注意：该字段在APIC场景下不生效 缺省值：V1 authorizer_version String 函数版本。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN 最大长度：64 authorizer_alias_uri String 函数别名地址。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN identities Array of Identity objects 认证来源 ttl Integer 缓存时间 user_data String 用户数据 ld_api_id String 自定义后端服务ID。 自定义认证函数类型为LD时必填 need_body Boolean 是否发送body id String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 roma_app_name String 自定义认证所属应用名称 表6 Identity 参数 参数类型 描述 name String 参数名称。 支持数字，英文，下划线，中划线，点，且只能以数字或英文开头。 最小长度：0 最大长度：32 location String 参数位置 validation String 参数校验表达式，默认为null，不做校验 最大长度：1024 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型 FRONTEND：前端 BACKEND：后端 authorizer_type 是 String 自定义认证函数类型： LD：自定义后端函数 FUNC：函数服务函数 authorizer_uri 是 String 函数地址。 注意：使用自定义后端的函数API，API请求方法必须为POST，且API状态必须为已部署。 network_type 否 String 对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构 注意：该字段在APIC场景下不生效 缺省值：V1 authorizer_version 否 String 函数版本。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN 最大长度：64 authorizer_alias_uri 否 String 函数别名地址。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN identities 否 Array of Identity objects 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据 ld_api_id 否 String 自定义后端服务ID。 自定义认证函数类型为LD时必填 need_body 否 Boolean 是否发送body 表4 Identity 参数 是否必选 参数类型 描述 name 是 String 参数名称。 支持数字，英文，下划线，中划线，点，且只能以数字或英文开头。 最小长度：0 最大长度：32 location 是 String 参数位置 validation 否 String 参数校验表达式，默认为null，不做校验 最大长度：1024