华为云用户手册

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 auths Array of ApiAuthInfo objects 本次返回的API列表 表5 ApiAuthInfo 参数 参数类型 描述 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role String 授权者 auth_time String 授权创建的时间 app_name String APP的名称 app_remark String APP的描述 app_type String APP的类型： apig：存量apic客户端，新建实例不支持此类型 roma：roma集成客户端 app_creator String APP的创建者，取值如下： USER：租户自己创建 MARKET：API市场分配，暂不支持 publish_id String API的发布编号 group_id String API绑定的分组ID auth_tunnel String 授权通道类型 NORMAL：普通通道 GREEN：绿色通道 auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array of strings 绿色通道的黑名单配置 visit_param String 访问参数。 roma_app_type String ROMA_APP的类型： subscription：订阅应用 integration：集成应用 env_name String api授权绑定的环境名称 app_id String APP的编号 状态码： 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（如果所有地址返回"--"，表示所有节点部署了独占模式的协议插件，无法使用MQTT或CoAP协议；如果CoAP链接地址返回"--"，表示需要先配置外接ELB。） { "total" : 1, "size" : 1, "items" : [ { "permissions" : [ "read", "access", "delete", "modify" ], "id" : 711537, "parent_device_id" : 711536, "parent_device_name" : "parent-device", "product" : { "product_id" : 116303, "product_name" : "p1", "manufacturer_id" : "p1", "model" : "p1", "product_type" : 0, "protocol_type" : 0 }, "device_name" : "device", "instance_id" : "8993a690-cf61-46af-880d-587d823d14e5", "client_id" : "D116303711537sGDtK", "node_id" : "string", "app_name" : "app", "status" : 0, "online_status" : 2, "description" : "device", "authentication" : { "user_name" : "F01A8D25FE6E4CF5A286B711B31888AE", "password" : "************************" }, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "tags" : [ ], "created_datetime" : 1607408244841, "last_updated_datetime" : 1607422571094, "connect_address" : "xx.xx.xx.xx", "ssl_connect_address" : "xx.xx.xx.xx", "ipv6_connect_address" : "xx.xx.xx.xx", "ipv6_ssl_connect_address" : "xx.xx.xx.xx", "coap_connect_address" : "xx.xx.xx.xx", "coap_ssl_connect_address" : "xx.xx.xx.xx", "coap_ipv6_connect_address" : "xx.xx.xx.xx", "coap_ipv6_ssl_connect_address" : "xx.xx.xx.xx", "node_type" : 0, "device_type" : 0, "app_id" : "cb4b3ec0-8f7f-432f-b05e-fc149d05da5d" } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device.batchQuery]. Parameter is [node_type]. Processor is [body].", "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 OK { "instances" : [ { "name" : "romamqs_640bb069-151e-4d5e-bd1b-xxxxxxxxxxxx", "engine" : "kafka", "port" : 9093, "status" : "RUNNING", "description" : "roma-mqs", "type" : "cluster", "specification" : "100MB", "engine_version" : "1.1.0", "connect_address" : "192.168.0.57,192.168.0.227,192.168.0.234", "instance_id" : "640bb069-151e-4d5e-bd1b-xxxxxxxxxxxx", "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini", "charging_mode" : 1, "vpc_id" : "5810f4bb-b202-45cd-a5d1-xxxxxxxxxxxx", "vpc_name" : "vpc-4aeb", "created_at" : "1601016527494", "product_id" : "00300-30308-0--0", "security_group_id" : "20d120f2-70ba-4c8d-a6a4-xxxxxxxxxxxx", "security_group_name" : "sg-5ab2", "subnet_id" : "08c8e51c-7013-43ee-bb0a-xxxxxxxxxxxx", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "user_id" : "4d1a542e7bcf400cb9c8efada01406d8", "user_name" : "paas_test", "access_user" : "mqs-gen-user-1601016526411", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "enable_log_collection" : false, "storage_space" : 490, "total_storage_space" : 600, "used_storage_space" : 25, "partition_num" : "300", "enable_publicip" : false, "ssl_enable" : true, "cross_vpc_info" : "{\"192.168.0.227\":{\"advertised_ip\":\"192.168.0.227\",\"port\":9011,\"port_id\":\"6ba24c0a-c3ba-4fb8-9adb-84b7a346a623\"},\"192.168.0.57\":{\"advertised_ip\":\"192.168.0.57\",\"port\":9011,\"port_id\":\"4d34a44d-d968-4dcb-89a9-e38e62626df6\"},\"192.168.0.234\":{\"advertised_ip\":\"192.168.0.234\",\"port\":9011,\"port_id\":\"9eac2e81-323c-4d2d-acce-7f84f2d3bd9b\"}}", "storage_resource_id" : "234705d3-8f33-451a-92aa-xxxxxxxxxxxx", "storage_spec_code" : "dms.physical.storage.normal", "service_type" : "advanced", "storage_type" : "hec", "is_logical_volume" : true, "extend_times" : 0, "retention_policy" : "produce_reject", "ipv6_enable" : false, "ipv6_connect_addresses" : [ ], "connector_enable" : false, "mqs_connector_enable" : true, "mqs_connector_address" : "192.168.0.10:9776;192.168.0.17:9776", "connector_id" : "", "rest_enable" : true, "rest_connect_address" : "https://10.10.10.170:9292", "kafka_public_status" : "false", "public_bandwidth" : 0, "public_boundwidth" : 0, "message_query_inst_enable" : true, "vpc_client_plain" : false, "support_features" : "kafka.crossvpc.domain.enable,feature.physerver.kafka.topic.accesspolicy,rabbitmq.plugin.management,roma_app_enable,auto_topic_switch,feature.physerver.kafka.user.manager,route,kafka.new.pod.port,feature.physerver.kafka.topic.modify,message_trace_enable,features.pod.token.access,roma.user.manage.no.support,feature.physerver.kafka.pulbic.dynamic,features.log.collection", "trace_enable" : false, "agent_enable" : false, "pod_connect_address" : "10.10.10.122:9080,10.10.10.96:9080,10.10.10.66:9080", "disk_encrypted" : false, "kafka_private_connect_address" : "192.168.0.227:9093,192.168.0.234:9093,192.168.0.57:9093", "enable_auto_topic" : false, "ces_version" : "linux,v1,v2", "plugin_enable" : false, "public_access_enabled" : "false", "node_num" : 3 }, { "name" : "romamqs_54fc780d-bf6f-4402-8149-xxxxxxxxxxxx", "engine" : "kafka", "port" : 9093, "status" : "RUNNING", "description" : "roma-mqs", "type" : "cluster", "specification" : "100MB", "engine_version" : "1.1.0", "connect_address" : "192.168.0.25,192.168.0.92,192.168.0.220", "instance_id" : "54fc780d-bf6f-4402-8149-xxxxxxxxxxxx", "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini", "charging_mode" : 1, "vpc_id" : "5810f4bb-b202-45cd-a5d1-xxxxxxxxxxxx", "vpc_name" : "vpc-4aeb", "created_at" : "1600075938106", "product_id" : "00300-30308-0--0", "security_group_id" : "a9b9667f-8a48-4317-b637-xxxxxxxxxxxx", "security_group_name" : "default", "subnet_id" : "08c8e51c-7013-43ee-bb0a-xxxxxxxxxxxx", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "user_id" : "4d1a542e7bcf400cb9c8efada01406d8", "user_name" : "paas_test", "access_user" : "mqs-gen-user-1600075937011", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "enable_log_collection" : false, "storage_space" : 492, "total_storage_space" : 600, "used_storage_space" : 25, "partition_num" : "300", "enable_publicip" : false, "ssl_enable" : true, "cross_vpc_info" : "{\"192.168.0.25\":{\"advertised_ip\":\"192.168.0.25\",\"port\":9011,\"port_id\":\"bcf9ba5e-26f4-4d09-b566-014eac1c804b\"},\"192.168.0.92\":{\"advertised_ip\":\"192.168.0.92\",\"port\":9011,\"port_id\":\"43bbffdd-07bf-450f-b1cd-c5e553c77c0f\"},\"192.168.0.220\":{\"advertised_ip\":\"192.168.0.220\",\"port\":9011,\"port_id\":\"dc26f9c0-2d2b-4522-9f22-b5b3d726121e\"}}", "storage_resource_id" : "0b391dcb-ccc8-4f9d-9440-xxxxxxxxxxxx", "storage_spec_code" : "dms.physical.storage.high", "service_type" : "advanced", "storage_type" : "hec", "is_logical_volume" : true, "extend_times" : 0, "retention_policy" : "produce_reject", "ipv6_enable" : false, "ipv6_connect_addresses" : [ ], "connector_enable" : false, "mqs_connector_enable" : true, "mqs_connector_address" : "192.168.0.66:9776;192.168.0.65:9776", "connector_id" : "", "rest_enable" : true, "rest_connect_address" : "https://10.10.10.57:9292", "kafka_public_status" : "false", "public_bandwidth" : 0, "public_boundwidth" : 0, "message_query_inst_enable" : true, "vpc_client_plain" : false, "support_features" : "kafka.crossvpc.domain.enable,route,kafka.new.pod.port,feature.physerver.kafka.topic.modify,feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,rabbitmq.plugin.management,roma_app_enable,features.log.collection,auto_topic_switch,feature.physerver.kafka.user.manager", "trace_enable" : false, "agent_enable" : false, "pod_connect_address" : "10.10.10.244:9080,10.10.10.79:9080,10.10.10.64:9080", "disk_encrypted" : false, "kafka_private_connect_address" : "192.168.0.25:9093,192.168.0.92:9093,192.168.0.220:9093", "enable_auto_topic" : false, "ces_version" : "linux,v1,v2", "plugin_enable" : false, "public_access_enabled" : "false", "node_num" : 3 } ], "instance_num" : 2 }

请求示例 修改指定数据集成任务的调度计划，不使用Cron表达式，执行间隔为每天一次 { "dispatch_id" : "0b046396c0f84687840c37c642389609", "task_id" : "34bb58f48c684b5ea1158cff69b9fbe4", "start_datetime" : 1605597966246, "period" : "DAY", "dispatch_interval" : 1, "created_date" : 1605570764692, "last_modified_date" : 1605570764692, "remark" : "123", "use_quartz_cron" : false }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_datetime 否 Integer 调度计划的执行开始时间 最小值：0 最大值：99999999999999999 period 否 String 调度计划执行周期的时间单位，当使用cron表达式时，为空 MIN (分钟) HOUR (小时) DAY (日) WEEK (周) MON (月) 最小长度：0 最大长度：36 dispatch_interval 否 Integer 调度计划的执行间隔时间周期 最小值：1 最大值：59 remark 否 String 调度计划的备注信息 最小长度：8 最大长度：36 use_quartz_cron 否 Boolean 调度计划是否使用cron表达式，允许如下值： true (使用cron表达式) false (不使用cron表达式) 最小长度：4 最大长度：16 cron 否 String 调度计划的cron表达式 最小长度：8 最大长度：255

响应示例 状态码： 200 OK { "dispatch_id" : "0b046396c0f84687840c37c642389609", "task_id" : "34bb58f48c684b5ea1158cff69b9fbe4", "start_datetime" : 1605597966246, "period" : "DAY", "dispatch_interval" : 1, "created_date" : 1605570764692, "last_modified_date" : 1605570764692, "remark" : "123", "use_quartz_cron" : false } 状态码： 400 Bad Request { "code" : 400, "reason" : { "error_code" : "FDI.3149", "error_msg" : "The task ID is empty." } } 状态码： 404 Not Found { "code" : 404, "reason" : { "error_code" : "FDI.3180", "error_msg" : "This task is not in the project." } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 dispatch_id String 调度计划ID 最小长度：1 最大长度：64 task_id String 调度计划关联的任务ID 最小长度：1 最大长度：64 start_datetime Integer 调度计划的执行开始时间 最小值：0 最大值：99999999999999999 period String 调度计划执行周期的时间单位，当使用cron表达式时，为空 MIN (分钟) HOUR (小时) DAY (日) WEEK (周) MON (月) 最小长度：0 最大长度：36 dispatch_interval Integer 调度计划的执行间隔时间周期 最小值：1 最大值：59 created_date Integer 调度计划的创建时间 最小值：1 最大值：99999999999999999 last_modified_date Integer 调度计划最近一次的修改时间 最小值：1 最大值：99999999999999999 remark String 调度计划的备注信息 最小长度：8 最大长度：36 use_quartz_cron Boolean 调度计划是否使用cron表达式，允许如下值： true (使用cron表达式) false (不使用cron表达式) 最小长度：4 最大长度：16 cron String 调度计划的cron表达式 最小长度：8 最大长度：255 状态码： 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

响应示例 状态码： 201 OK { "project_vpc_channels" : [ { "balance_strategy" : 1, "member_type" : "ip", "name" : "VPC_demo", "port" : 22, "type" : 2, "vpc_health_config" : { "http_code" : "200", "path" : "/vpc/demo", "port" : 22, "protocol" : "http", "threshold_abnormal" : 5, "threshold_normal" : 2, "time_interval" : 10, "timeout" : 5, "enable_client_ssl" : false }, "member_groups" : [ { "create_time" : "2021-08-30T14:02:25Z", "member_group_id" : "ec79066c6f6f462e91ff3f17f0e43f2a", "member_group_name" : "test", "member_group_remark" : "", "member_group_weight" : 1, "update_time" : "2021-08-30T14:02:25Z" }, { "create_time" : "2021-08-04T06:03:47Z", "member_group_id" : "5b26a82cd18547f3ada54b3cfa641df9", "member_group_name" : "default", "member_group_remark" : "", "member_group_weight" : 1, "update_time" : "2021-08-04T06:03:47Z" } ], "instance_id" : "eea73cde015940908ae0117d67bf7330", "instance_name" : "test1" }, { "balance_strategy" : 1, "member_type" : "ip", "name" : "VPC_demo", "port" : 22, "type" : 2, "vpc_health_config" : { "http_code" : "200", "path" : "/vpc/demo", "port" : 22, "protocol" : "http", "threshold_abnormal" : 5, "threshold_normal" : 2, "time_interval" : 10, "timeout" : 5, "enable_client_ssl" : false }, "member_groups" : [ { "create_time" : "2021-08-30T14:02:25Z", "member_group_id" : "ec79066c6f6f462e91ff3f17f0e43f2a", "member_group_name" : "test", "member_group_remark" : "", "member_group_weight" : 1, "update_time" : "2021-08-30T14:02:25Z" }, { "create_time" : "2021-08-04T06:03:47Z", "member_group_id" : "5b26a82cd18547f3ada54b3cfa641df9", "member_group_name" : "default", "member_group_remark" : "", "member_group_weight" : 1, "update_time" : "2021-08-04T06:03:47Z" } ], "instance_id" : "ddd73cde017890908ae0117d67bf7330", "instance_name" : "test2" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "The request parameters must be specified,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" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 project_vpc_channels Array of ProjectVpcChannelInfo objects 项目VPC通道列表 表5 ProjectVpcChannelInfo 参数 参数类型 描述 name String VPC通道的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、中划线、下划线组成，且只能以英文或中文开头。 说明： 中文字符必须为UTF-8或者unicode编码。 port Integer VPC通道中主机的端口号。 取值范围1 ~ 65535。 balance_strategy Integer 分发算法。 1：加权轮询（wrr） 2：加权最少连接（wleastconn） 3：源地址哈希（source） 4：URI哈希（uri） 缺省值：1 member_type String VPC通道的成员类型。 ip ecs 缺省值：ecs type String vpc通道类型。 BUILTIN：BUILTIN通道类型 MICROSERVICE：微服务类型 dict_code String VPC通道的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 最小长度：3 最大长度：64 create_time String VPC通道的创建时间 id String VPC通道的编号 status Integer VPC通道的状态。 1：正常 2：异常 member_groups Array of MemberGroupInfo objects 后端云服务器组列表。 instance_id String 实例编号 instance_name String 实例名称 members Array of VpcMemberInfo objects 后端实例列表。 vpc_health_config VpcHealthConfigInfo object 健康检查详情。 microservice_info MicroServiceInfo object 微服务的响应对象 表6 MemberGroupInfo 参数 参数类型 描述 member_group_name String VPC通道后端服务器组名称 member_group_remark String VPC通道后端服务器组描述 member_group_weight Integer VPC通道后端服务器组权重值。 当前服务器组存在服务器且此权重值存在时，自动使用此权重值分配权重。 最小值：0 最大值：100 dict_code String VPC通道后端服务器组的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 最小长度：3 最大长度：64 microservice_version String VPC通道后端服务器组的版本，仅VPC通道类型为微服务时支持。 最大长度：64 microservice_port Integer VPC通道后端服务器组的端口号，仅VPC通道类型为微服务时支持。端口号为0时后端服务器组下的所有地址沿用原来负载端口继承逻辑。 最小值：0 最大值：65535 microservice_labels Array of MicroserviceLabel objects VPC通道后端服务器组的标签，仅VPC通道类型为微服务时支持。 member_group_id String VPC通道后端服务器组编号 create_time String VPC通道后端服务器组创建时间 update_time String VPC通道后端服务器组更新时间 表7 MicroserviceLabel 参数 参数类型 描述 label_name String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 label_value String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 表8 VpcMemberInfo 参数 参数类型 描述 host String 后端服务器地址 后端实例类型为ip时必填 最大长度：64 weight Integer 权重值。 允许您对后端服务进行评级，权重值越大，转发到该云服务的请求数量越多。 最小值：0 最大值：10000 is_backup Boolean 是否备用节点。 开启后对应后端服务为备用节点，仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能，若不支持请联系技术支持。 缺省值：false member_group_name String 后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1：可用 2：不可用 port Integer 后端服务器端口 最小值：0 最大值：65535 ecs_id String 后端云服务器的编号。 后端实例类型为ecs时必填，支持英文，数字，“-”,“_”，1 ~ 64字符。 最大长度：255 ecs_name String [后端云服务器的名称。] 后端实例类型为ecs时必填，支持汉字，英文，数字，“-”,“_”,“.”，1 ~ 64字符。 最大长度：64 id String 后端实例对象的编号 vpc_channel_id String VPC通道的编号 create_time String 后端实例增加到VPC通道的时间 member_group_id String 后端服务器组编号 表9 VpcHealthConfigInfo 参数 参数类型 描述 protocol String 使用以下协议，对VPC中主机执行健康检查： TCP HTTP HTTPS path String 健康检查时的目标路径。protocol = http或https时必选 method String 健康检查时的请求方法 缺省值：GET port Integer 健康检查的目标端口，缺少或port = 0时为VPC中主机的端口号。 若此端口存在非0值，则使用此端口进行健康检查。 最小值：0 最大值：65535 threshold_normal Integer 正常阈值。判定VPC通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 最小值：1 最大值：10 threshold_abnormal Integer 异常阈值。判定VPC通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 最小值：1 最大值：10 time_interval Integer 间隔时间：连续两次检查的间隔时间，单位为秒。必须大于timeout字段取值。 最小值：5 最大值：300 http_code String 检查目标HTTP响应时，判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值，支持如下三种格式： 多个值，如：200,201,202 一系列值，如：200-299 组合值，如：201,202,210-299 protocol = http时必选 enable_client_ssl Boolean 是否开启双向认证。若开启，则使用实例配置中的backend_client_certificate配置项的证书 缺省值：false status Integer 健康检查状态 1：可用 2：不可用 timeout Integer 超时时间：检查期间，无响应的时间，单位为秒。必须小于time_interval字段取值。 最小值：2 最大值：30 vpc_channel_id String VPC通道的编号 id String 健康检查的编号 create_time String 创建时间 表10 MicroServiceInfo 参数 参数类型 描述 id String 微服务编号 instance_id String 实例编号 service_type String 微服务类型： CS E：CSE微服务注册中心 CCE：CCE云容器引擎（暂不支持） cse_info MicroServiceInfoCSE object CSE基础信息 cce_info MicroServiceInfoCCE object 暂不支持 update_time String 微服务更新时间 create_time String 微服务创建时间 表11 MicroServiceInfoCSE 参数 参数类型 描述 engine_id String 微服务引擎编号 最大长度：64 service_id String 微服务编号 最大长度：64 engine_name String 微服务引擎名称 service_name String 微服务名称 register_address String 注册中心地址 cse_app_id String 微服务所属的应用 version String 微服务的版本，已废弃，通过后端服务器组中的版本承载。 最大长度：64 表12 MicroServiceInfoCCE 参数 参数类型 描述 cluster_id String 云容器引擎集群编号 最大长度：64 namespace String 命名空间 最大长度：64 workload_type String 工作负载类型 deployment：无状态负载 statefulset：有状态负载 daemonset：守护进程集 app_name String APP名称 最大长度：64 label_key String 标签名 最大长度：64 label_value String 标签值 最大长度：64 cluster_name String 云容器引擎集群名称 状态码： 400 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 vpc_channel_id 否 String VPC通道编号 instance_ids 否 Array of strings 新增关联的实例列表 force_sync 否 Boolean 是否强制同步，默认不强制同步 缺省值：false

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "req_uri" : "/test/function", "req_method" : "GET", "match_mode" : "NORMAL", "duplicated_apis" : [ { "api_id" : "e25fcb255a664e80aa40759d37d043e9", "api_name" : "api_demo", "group_id" : "86d75a6b1d6c4cca99e1bed795074167", "group_name" : "DEFAULT", "api_type" : "self-owned" }, { "api_id" : "d41f91f14ecc476fa9bdef54afb37f06", "api_name" : "api_demo_duplicate", "group_id" : "c3053da9dcd54ffba3bf6e0fb7721a82", "group_name" : "EchoDemo", "api_type" : "self-owned" } ] } ] } 状态码： 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" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiDuplicationInfo objects 应用下所有路径冲突的api信息列表 表5 ApiDuplicationInfo 参数 参数类型 描述 req_method String 请求方式 req_uri String API的访问地址 match_mode String API的匹配方式 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配） 默认：NORMAL duplicated_apis Array of DuplicateApiInfo objects 该路径下冲突的api列表 表6 DuplicateApiInfo 参数 参数类型 描述 api_id String API ID api_name String API名称 group_name String 分组名称 group_id String 分组ID remark String API描述 api_type String api类型： self-owned：自有API authorized：授权API 状态码： 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 错误描述

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 app_code String App Code值 支持英文，+_!@#$%+/=，且只能以英文和+、/开头。 最小长度：64 最大长度：180 id String 编号 app_id String 应用编号 create_time 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 错误描述

响应示例 状态码： 200 OK { "app_code" : "fdc8d90a30174460a91ddacfa54d6f04c92e523a85cc4a1894f87cb13b6f572a", "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc", "id" : "b3d34f746d0847fb95138670e10207ed", "create_time" : "2020-07-24T02:31:45Z" } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:app_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3004", "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 acl_name String 名称 acl_type String 类型: PERMIT（白名单类型） DENY（黑名单类型） acl_value String ACL策略值 entity_type String 对象类型： IP DOMAIN DOMAIN_ID id String 编号 update_time 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 { "id" : "7eb619ecf2a24943b099833cd24a01ba", "acl_name" : "acl_demo", "entity_type" : "IP", "acl_type" : "PERMIT", "acl_value" : "192.168.1.5,192.168.10.1", "update_time" : "2020-08-04T08:42:43.461276217Z" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:acl_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.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 OK { "total" : 1, "size" : 1, "items" : [ { "destination_id" : 27678, "destination_type" : 7, "app_id" : null, "destination_name" : null, "topic" : "8si8ST122893/in/214", "server" : "server", "token" : "token", "tag" : "device", "mqs_sasl_ssl" : "false", "user_name" : null, "password" : null } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-ruledest.query]. 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" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 最小值：0 最大值：9999999999999999 size Integer 本次返回数量 最小值：0 最大值：999 items Array of Destination objects 目标数据源列表 数组长度：0 - 9999 表5 Destination 参数 参数类型 描述 destination_id Integer 目标数据源ID 最小值：1 最大值：99999999999999999 destination_type Integer 操作类型，枚举值:0-目标端为本ROMA实例内MQS； 7-目标端为设备 最小值：0 最大值：10 app_id String 应用ID，目标端为0时需明确对方的APP_ID 最小长度：0 最大长度：64 destination_name String 目标数据源名称 最小长度：0 最大长度：64 topic String 目标数据源主题 最小长度：0 最大长度：64 server String 目标端数据源服务 最小长度：0 最大长度：200 token String 目标端数据源token 最小长度：0 最大长度：1000 tag String 目标数据源标签 最小长度：0 最大长度：200 mqs_sasl_ssl Boolean 目标端数据源MQS的SASL字段是否需要支持SSL加密 user_name String 目标数据源用户名 最小长度：0 最大长度：80 password String 目标数据源密码 最小长度：0 最大长度：500 状态码： 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 { "id" : "5f918d104dc84480a75166ba99efff21", "tags" : [ "webApi" ], "arrange_necessary" : 2, "backend_type" : "HTTP", "auth_type" : "AUTHORIZER", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac", "backend_api" : { "update_time" : "2020-08-02T16:32:47.077029Z", "vpc_status" : 1, "vpcinfo" : { "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.046289Z", "remark" : "web 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" : "consumer app id", "id" : "216ddda836e74d528f364ff589d9dd21" } ] } 状态码： 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 { "call_limits" : 200, "app_name" : "app_demo", "object_name" : "app_demo", "object_id" : "356de8eb7a8742168586e5daf5339965", "throttle_id" : "3437448ad06f4e0c91a224183116e965", "apply_time" : "2020-08-04T02:40:56Z", "id" : "a3e9ff8db55544ed9db91d8b048770c0", "app_id" : "356de8eb7a8742168586e5daf5339965", "object_type" : "APP" } 状态码： 400 Bad Request { "error_code" : "APIG.2003", "error_msg" : "The parameter value is too large,parameterName:call_limits. 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.3013", "error_msg" : "Excluded request throttling configuration a3e9ff8db55544ed9db91d8b048770c0 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 特殊配置的编号 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time String 设置时间 app_name String 作用的APP名称 app_id String 作用的APP编号 object_id String 特殊对象的身份标识 object_type String 特殊对象类型：APP、USER object_name String 作用的APP或租户的名称 throttle_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 Created { "permissions" : [ "read", "access", "delete", "modify" ], "rule_id" : 702244, "name" : "rule", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "description" : "123", "status" : 0, "data_parsing_status" : 1, "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.save]. Parameter is [request]. 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 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" }

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

响应参数 状态码： 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 description String 描述 最小长度：0 最大长度：200 status Integer 规则状态 0-启用 1-停用 最小值：0 最大值：10 data_parsing_status Integer 数据解析状态，ENABLE时data_parsing必填 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 表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 表4 响应Body参数 参数 参数类型 描述 tables Array of strings 数据源中所有的表名称 数组长度：0 - 2147483647 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 detail 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

响应示例 状态码： 200 OK { "total" : 2, "size" : 2, "apis" : [ { "auth_type" : "APP", "run_env_name" : "", "group_name" : "api_group_001", "publish_id" : "", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_function", "remark" : "FunctionGraph backend API", "run_env_id" : "", "id" : "abd9c4b2ff974888b0ba79be7e6b2763", "req_uri" : "/test/function" }, { "auth_type" : "APP", "run_env_name" : "RELEASE", "group_name" : "APIGroup_d3da", "publish_id" : "ca2631e233a74a758744ae1e19cc5ad7", "group_id" : "6acd94abe58747ee8a73b10c70817bac", "name" : "API_test", "remark" : "FunctionGraph backend API", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "11cbec3a7a8345ca981b86d161bc436e", "req_uri" : "/appcode" } ] } 状态码： 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" }