华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of UnbindApiForAcl objects 本次查询返回的API列表 表5 UnbindApiForAcl 参数 参数类型 描述 auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark String API描述 run_env_id String 发布的环境id id String API编号 req_uri String API的请求地址 type Integer API类型 acl_name String 绑定的其他同类型的ACL策略名称 状态码： 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, "apis" : [ { "auth_type" : " IAM ", "run_env_name" : "RELEASE", "group_name" : "api_group_001", "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_mock", "remark" : "Mock backend API", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "3a955b791bd24b1c9cd94c745f8d1aad", "req_uri" : "/test/mock", "type" : 1, "acl_name" : "" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "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.3006", "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应示例 状态码： 200 OK { "code" : "APIG.0000", "start_time" : 1595573280, "end_time" : 1595576820, "list" : [ { "api_id" : "39bce6d25a3f470e8cf7b2c97174f7d9", "avg_backend_latency" : 2.71, "avg_inner_latency" : 1.57, "avg_latency" : 4.14, "current_minute" : 1595576640, "cycle" : "MINUTE", "group_id" : "d0fc4e40b7d1492cba802f667c7c7226", "input_throughput" : 1071, "max_backend_latency" : 6, "max_inner_latency" : 8, "max_latency" : 14, "output_throughput" : 3790, "provider" : "73d69ae0cfcf460190522d06b60f05ad", "register_time" : "2020-07-24 15:44:56", "req_count" : 7, "req_count2xx" : 0, "req_count4xx" : 6, "req_count5xx" : 1, "req_count_error" : 7, "req_time" : "2020-07-24 15:44:00", "status" : 1 } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 code String 响应码 start_time Long 开始时间的UTC的时间戳 end_time Long 截止时间的UTC的时间戳 list Array of StatisticsAPI objects 统计指标的数据结构结构体 表5 StatisticsAPI 参数 参数类型 描述 max_latency Integer 最大延时 avg_latency Float 平均延时 req_count Integer 请求总次数 req_count2xx Integer 2xx响应码总次数 req_count4xx Integer 4xx响应码总次数 req_count5xx Integer 5xx响应码总次数 req_count_error Integer 错误次数 max_inner_latency Integer 最大网关内部延时 avg_inner_latency Float 平均网关内部延时 max_backend_latency Integer 最大后端延时 avg_backend_latency Float 平均后端延时 output_throughput Long 下行吞吐量（byte） input_throughput Long 上行吞吐量（byte） current_minute Long API访问的UTC时间戳 cycle String 查询统计周期 api_id String API编号 group_id String API分组编号 provider String API拥有者 req_time String API请求时间 register_time String 记录时间 status Integer 状态值： 1：调度中，未上报 CES 2：已经成功上报CES 预留字段，暂不支持 状态码： 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参数 参数 是否必选 参数类型 描述 env_id 是 String 绑定API的环境编码。 api_ids 是 Array of strings 绑定的API编码列表。 数组长度：1 - 500

响应示例 状态码： 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.3068", "error_msg" : "Plugin b294018ee0554156a875b3513e02e5b9 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 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 表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 { "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.3068", "error_msg" : "Plugin b294018ee0554156a875b3513e02e5b9 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg 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 错误描述

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 member_groups Array of MemberGroupInfo objects VPC通道后端服务器组列表 表5 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通道后端服务器组更新时间 表6 MicroserviceLabel 参数 参数类型 描述 label_name String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 label_value String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 状态码： 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 OK { "total" : 1, "size" : 1, "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_remark" : "remark", "member_group_weight" : 1, "dict_code" : "", "member_group_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T07:24:33Z", "update_time" : "2020-07-23T07:24:33Z" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "The request parameters must be specified,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.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 { "name" : "MyDict", "code" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3" } 状态码： 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参数 参数 参数类型 描述 name String 字典名称。 字符集：中文、英文字母、数字、下划线和空格。 约束：实例下唯一。 code 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。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 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 是否收藏应用，收藏的应用会在列表里优先显示。 表5 created_user 参数 参数类型 描述 user_id String 创建应用的用户ID。 user_name String 创建应用的用户名称。 表6 last_updated_user 参数 参数类型 描述 user_id String 最后修改者的用户ID。 user_name String 最后修改者的用户名。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

响应示例 状态码： 201 OK { "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "name" : "AppName", "remark" : "example", "roles" : [ "read, access, delete, modify, admin" ], "create_time" : "2019-12-06T06:49:04.000Z", "update_time" : "2019-12-06T06:49:04.000Z", "created_user" : { "user_id" : "string", "user_name" : "string" }, "last_updated_user" : { "user_id" : "string", "user_name" : "string" }, "owner" : true, "key" : "TEI95R8RZ2pIf8UM", "favorite" : true } 状态码： 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 应用描述。 key 否 String 应用认证访问KEY,未提供时随机生成。 字符集：支持中文、英文字母、数字、中划线、下划线、@号和点，以字母或中文或数字开头。 约束：实例下唯一。 secret 否 String 应用认证访问SECRET,未提供（字段不存在或值为null）时随机生成。 字符集：英文字母、数字、！、@、#、$、%、+、=、点、中划线、斜线/。 复杂度：满足大小写字母、数字、特殊字符的复杂度组合，考虑兼容性暂时不做复杂度校验。 favorite 否 Boolean 是否收藏应用，收藏的应用会在列表里优先显示。

请求示例 修改指定的服务器类型VPC通道，分发算法改为加权最少连接，并修改后端服务器配置 { "balance_strategy" : 2, "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" : [ { "member_group_name" : "test", "member_group_weight" : 1, "member_group_remark" : "remark" }, { "member_group_name" : "default", "member_group_weight" : 2, "member_group_remark" : "remark" } ], "members" : [ { "host" : "192.168.0.5", "weight" : 1, "member_group_name" : "test" }, { "host" : "192.168.1.124", "weight" : 2, "member_group_name" : "default" } ] }

响应示例 状态码： 200 OK 示例 1 { "name" : "VPC_demo", "port" : 22, "balance_strategy" : 2, "member_type" : "ip", "dict_code" : "", "create_time" : "2020-07-23T07:11:57Z", "id" : "18174f5f4f1a4dc29f33aeadd9788e5f", "status" : 1, "member_groups" : [ { "member_group_id" : "c1ce135c705c4066853a0460b318fe16", "member_group_name" : "test", "member_group_weight" : 1, "member_group_remark" : "remark", "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z" }, { "member_group_id" : "c1ce135c705c4066853a0460b318fe17", "member_group_name" : "default", "member_group_weight" : 2, "member_group_remark" : "remark", "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z" } ], "type" : 2, "microservice_info" : { "id" : "", "instance_id" : "", "service_type" : "", "cse_info" : { "cse_app_id" : "", "engine_id" : "", "engine_name" : "", "register_address" : "", "service_id" : "", "service_name" : "", "version" : "" }, "cce_info" : { "cluster_id" : "", "cluster_name" : "", "namespace" : "", "workload_type" : "", "app_name" : "" }, "create_time" : "", "update_time" : "" } } 示例 2 { "name" : "VPC_demo", "id" : "105c6902457144a4820dff8b1ad63331", "balance_strategy" : 1, "dict_code" : "", "create_time" : "2020-07-23T07:11:57.244829604Z", "member_type" : "ip", "port" : 22, "status" : 1, "member_groups" : [ { "member_group_id" : "c1ce135c705c4066853a0460b318fe16", "member_group_name" : "test", "member_group_weight" : 1, "member_group_remark" : "remark", "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z", "microservice_version" : "v1", "microservice_port" : 80 }, { "member_group_id" : "c1ce135c705c4066853a0460b318fe17", "member_group_name" : "default", "member_group_weight" : 2, "member_group_remark" : "remark", "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z", "microservice_version" : "v2", "microservice_port" : 80 } ], "type" : 3, "microservice_info" : { "id" : "9483afa235be45158a70c19ab817ac65", "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e", "service_type" : "CCE", "cse_info" : { "cse_app_id" : "", "engine_id" : "", "engine_name" : "", "register_address" : "", "service_id" : "", "service_name" : "", "version" : "" }, "cce_info" : { "cluster_id" : "ab1485b4f91b45abbcd560be591f7309", "cluster_name" : "cce-test", "namespace" : "default", "workload_type" : "deployment", "app_name" : "testapp" }, "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z" } } 状态码： 400 Bad Request { "error_code" : "APIG.2001", "error_msg" : "The request parameters must be specified, parameter name:members" } 状态码： 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.3023", "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表11 响应Body参数 参数 参数类型 描述 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 Integer vpc通道类型： 2：BUILTIN通道类型 3：微服务类型 dict_code String VPC通道的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 最小长度：3 最大长度：64 create_time String VPC通道的创建时间 id String VPC通道的编号 status Integer VPC通道的状态。 1：正常 2：异常 member_groups Array of MemberGroupInfo objects 后端云服务器组列表。 microservice_info MicroServiceInfo object 微服务的响应对象 表12 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通道后端服务器组更新时间 表13 MicroserviceLabel 参数 参数类型 描述 label_name String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 label_value String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 表14 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 微服务创建时间 表15 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 表16 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 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表19 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表20 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表21 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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 否 Integer vpc通道类型，默认为服务器类型。 2：服务器类型 3：微服务类型 缺省值：2 dict_code 否 String VPC通道的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 最小长度：3 最大长度：64 member_groups 否 Array of MemberGroupCreate objects VPC通道后端服务器组列表 members 否 Array of MemberInfo objects VPC后端实例列表。 vpc_health_config 否 VpcHealthConfig object 健康检查详情。 microservice_info 否 MicroServiceCreate object 微服务详情。 表4 MemberGroupCreate 参数 是否必选 参数类型 描述 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通道类型为微服务时支持。 表5 MicroserviceLabel 参数 是否必选 参数类型 描述 label_name 是 String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 label_value 是 String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 表6 MemberInfo 参数 是否必选 参数类型 描述 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 表7 VpcHealthConfig 参数 是否必选 参数类型 描述 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 表8 MicroServiceCreate 参数 是否必选 参数类型 描述 service_type 否 String 微服务类型： CSE：CSE微服务注册中心 CCE：CCE云容器引擎（暂不支持） cse_info 否 MicroServiceInfoCSEBase object CSE基础信息 cce_info 否 MicroServiceInfoCCEBase object 暂不支持 表9 MicroServiceInfoCSEBase 参数 是否必选 参数类型 描述 engine_id 是 String 微服务引擎编号 最大长度：64 service_id 是 String 微服务编号 最大长度：64 表10 MicroServiceInfoCCEBase 参数 是否必选 参数类型 描述 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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 最小值：1 最大值：99999999999999999 size Integer 本次返回数量 最小值：1 最大值：9999 items Array of Command objects 命令列表 数组长度：0 - 9999 表5 Command 参数 参数类型 描述 service_id Integer 命令所属服务id 最小值：0 最大值：99999999999999999 command_id Integer 命令id 最小值：0 最大值：99999999999999999 command_name String 命令名称 最小长度：0 最大长度：255 description String 命令描述 最小长度：0 最大长度：255 状态码： 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" : 1, "size" : 1, "items" : [ { "service_id" : 10190, "command_id" : 6398, "command_name" : "command", "description" : "command" } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services.queryCommandsInService]. Parameter is [service_id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应示例 状态码： 201 Ok { "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc", "app_acl_type" : "PERMIT", "app_acl_values" : [ "192.168.0.1", "192.168.0.5-192.168.0.10", "192.168.0.100/28" ] } 状态码： 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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_acl_type 是 String 类型 PERMIT (白名单类型) DENY (黑名单类型) app_acl_values 是 Array of strings ACL策略值，支持IP、IP范围和CIDR方式。IP范围以英文中划线分隔。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 app_id String APP编号 app_acl_type String 类型 PERMIT (白名单类型) DENY (黑名单类型) app_acl_values Array of strings ACL策略值，支持IP、IP范围和CIDR方式。IP范围以英文中划线分隔。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "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", "env_name" : "RELEASE", "bind_id" : "332c5db1458a477b89b2ea741fec94a3", "bind_time" : "2020-08-04T08:58:03Z", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "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.3006", "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba 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 AclBindApiInfo objects 本次查询返回的API列表 表5 AclBindApiInfo 参数 参数类型 描述 api_id String API编号 api_name String API名称 group_name String API分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String 生效的环境编号 env_name String 生效的环境名称 bind_id String 绑定关系编号 bind_time String 绑定时间 publish_id 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 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 throttles Array of ThrottleForApi objects 本次查询返回的流控策略列表 表5 ThrottleForApi 参数 参数类型 描述 app_call_limits Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限，该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 name String 流控策略名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 time_unit String 流控的时间单位 remark String 流控策略描述字符长度不超过255。 说明： 中文字符必须为UTF-8或者unicode编码。 api_call_limits Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制，系统默认配额为200tps，用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 type Integer 流控策略的类型 1：基础，表示绑定到流控策略的单个API流控时间内能够被调用多少次。 2：共享，表示绑定到流控策略的所有API流控时间内能够被调用多少次。 enable_adaptive_control String 是否开启动态流控： TRUE FALSE 暂不支持 user_call_limits Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval Integer 流量控制的时长单位。与“流量限制次数”配合使用，表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。 ip_call_limits Integer 源IP流量限制是指一个API在时长之内被每个IP访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 id String 流控策略的ID bind_num Integer 流控绑定的API数量 is_inclu_special_throttle Integer 是否包含特殊流控配置 1：包含 2：不包含 create_time String 创建时间 env_name String 流控策略生效的环境（即在哪个环境上有效） bind_id String 流控策略与API绑定关系编号 bind_time 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 错误描述