华为云用户手册

响应示例 状态码：200 OK { "available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]", "bandwidth_size" : 5, "description" : "test create instance", "enterprise_project_id" : "0", "instance_name" : "apig-demo", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7", "spec" : "PROFESSIONAL", "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5", "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763", "enable_fullstack_ipv6" : true, "unreliable_ips" : [ "192.xx.xxx.xxx" ] } 状态码：400 Bad Request { "error_code" : "APIC.7211", "error_msg" : "Parameter value does not match the rules, parameter name[maintainBegin]" } 状态码：401 Unauthorized { "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method" } 状态码：404 Not Found { "error_code" : "APIC.7302", "error_msg" : "Instance not found" } 状态码：500 Internal Server Error { "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 id String 实例ID project_id String 实例所属租户ID instance_name String 实例名称 status String 实例状态： Creating：创建中 CreateSuccess：创建成功 CreateFail：创建失败 Initing：初始化中 Registering：注册中 Running：运行中 InitingFailed：初始化失败 RegisterFailed：注册失败 Installing：安装中 InstallFailed：安装失败 Updating：升级中 UpdateFailed：升级失败 Rollbacking：回滚中 RollbackSuccess：回滚成功 RollbackFailed：回滚失败 Deleting：删除中 DeleteFailed：删除失败 Unregistering：注销中 UnRegisterFailed：注销失败 CreateTimeout：创建超时 InitTimeout：初始化超时 RegisterTimeout：注册超时 InstallTimeout：安装超时 UpdateTimeout：升级超时 RollbackTimeout：回滚超时 DeleteTimeout：删除超时 UnregisterTimeout：注销超时 Starting：启动中 Freezing：冻结中 Frozen：已冻结 Restarting：重启中 RestartFail：重启失败 Unhealthy：实例异常 RestartTimeout：重启超时 Resizing：规格变更中 ResizeFailed：规格变更失败 ResizeTimeout：规格变更超时 instance_status Integer 实例状态对应编号 1：创建中 2：创建成功 3：创建失败 4：初始化中 5：注册中 6：运行中 7：初始化失败 8：注册失败 10：安装中 11：安装失败 12：升级中 13：升级失败 20：回滚中 21：回滚成功 22：回滚失败 23：删除中 24：删除失败 25：注销中 26：注销失败 27：创建超时 28：初始化超时 29：注册超时 30：安装超时 31：升级超时 32：回滚超时 33：删除超时 34：注销超时 35：启动中 36：冻结中 37：已冻结 38：重启中 39：重启失败 40：实例异常 41：重启超时 42：规格变更中 43：规格变更失败 44：规格变更超时 type String 实例类型 默认apig spec String 实例规格： BASIC：基础版实例 PROFESSIONAL：专业版实例 ENTERPRISE：企业版实例 PLATINUM：铂金版实例 BASIC_IPV6：基础版IPV6实例 PROFESSIONAL_IPV6：专业版IPV6实例 ENTERPRISE_IPV6：企业版IPV6实例 PLATINUM_IPV6：铂金版IPV6实例 create_time Long 实例创建时间。unix时间戳格式。 enterprise_project_id String 企业项目ID，企业账号必填 eip_address String 实例绑定的弹性IP地址 charging_mode Integer 实例计费方式： 0：按需计费 1：包周期计费 cbc_metadata String 包周期计费订单编号 loadbalancer_provider String 实例使用的负载均衡器类型 lvs Linux虚拟服务器 elb 弹性负载均衡，elb仅部分region支持 缺省值：lvs cbc_operation_locks Array of CbcOperationLock objects 云运营限制操作锁 description String 实例描述 vpc_id String 虚拟私有云ID。 获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id String 子网的网络ID。 获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体方法请参见《虚拟私有云服务API参考》的“查询子网列表”章节。 security_group_id String 指定实例所属的安全组。 获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体方法请参见《虚拟私有云服务API参考》的“查询安全组列表”章节。 maintain_begin String '维护时间窗开始时间。时间格式为 xx:00:00，xx取值为02,06,10,14,18,22。' '在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次。' maintain_end String '维护时间窗结束时间。时间格式为 xx:00:00，与维护时间窗开始时间相差4个小时。' '在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次'。 ingress_ip String 实例入口，虚拟私有云访问地址 ingress_ip_v6 String 实例入口，虚拟私有云访问地址 (IPv6) user_id String 实例所属用户ID nat_eip_ipv6_cidr String 出公网网段 (IPv6) 。 当前仅部分region部分可用区支持IPv6 eip_ipv6_address String 弹性IP地址(IPv6)。 当前仅部分region部分可用区支持IPv6 nat_eip_address String 实例出公网IP bandwidth_size Integer 出公网带宽 bandwidth_charging_mode String 出公网带宽计费模式 available_zone_ids String 可用区 instance_version String 实例版本编号 virsubnet_id String 子网的网络ID。 暂不支持 roma_eip_address String roma弹性公网IP。 暂不支持 listeners Object 监听信息 暂不支持 supported_features Array of strings 实例支持的特性列表 endpoint_service EndpointService object 终端节点服务详情 待废弃，优先使用endpoint_services endpoint_services Array of EndpointService objects 终端节点服务列表 node_ips NodeIps object 服务节点IP node_ipv6_ips NodeIps object 服务IPV6节点IP public_ipv6_ips Array of strings 实例IPV6出公网IP publicips Array of IpDetails objects 公网入口地址列表 privateips Array of IpDetails objects 私网入口地址列表 unreliable_ips Array of strings 不建议使用的实例入口列表：分组子 域名 解析未指向到该列表的IP，不能用该列表的IP直接访问DEFAULT分组 enable_fullstack_ipv6 Boolean 实例是否支持全量IPv6 true：支持，实例入口和实例出口都支持IPV6 false：不支持，仅实例入口支持IPV6 is_releasable Boolean 实例是否可释放 true：可释放 false：不可释放 ingress_bandwidth_charging_mode String 入公网带宽计费模式 表5 CbcOperationLock 参数 参数类型 描述 lock_scene String 限制操作场景： TO_PERIOD_LOCK：按需转包周期场景锁，不允许进行删除、规格变更、按需转包周期等 SPEC_CHG_LOCK：包周期规格变更场景锁，不允许进行删除、规格变更等 lock_source_id String 发起限制操作对象的标志 表6 EndpointService 参数 参数类型 描述 service_name String 终端节点服务名称 created_at String 创建时间 表7 NodeIps 参数 参数类型 描述 livedata Array of strings livedata节点IP地址列表 shubao Array of strings shubao节点IP地址列表 表8 IpDetails 参数 参数类型 描述 ip_address String IP地址 ipv6_address String IPV6地址 bandwidth_size Integer 带宽大小 状态码：400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 member_group_name String VPC通道后端服务器组名称。支持汉字、英文、数字、下划线、中划线、点，且只能以英文和汉字开头，3-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 member_group_remark String VPC通道后端服务器组描述。 最大长度：255 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通道类型为微服务时支持。 reference_vpc_channel_id String 引用的负载通道编号，仅VPC通道类型为引用类型（vpc_channel_type=reference）时支持。 最小长度：0 最大长度：64 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 示例 1 { "member_group_name" : "vpc_member_group", "member_group_id" : "105c6902457144a4820dff8b1ad63331", "member_group_remark" : "", "member_group_weight" : 10, "create_time" : "2020-07-23T07:24:33Z", "update_time" : "2020-07-23T07:24:33Z", "microservice_version" : "", "microservice_port" : 0, "microservice_labels" : [ ] } 示例 2 { "member_group_name" : "vpc_member_group", "member_group_id" : "105c6902457144a4820dff8b1ad63331", "member_group_remark" : "", "member_group_weight" : 10, "create_time" : "2020-07-23T07:24:33Z", "update_time" : "2020-07-23T07:24:33Z", "microservice_version" : "v1", "microservice_port" : 80, "microservice_labels" : [ { "label_name" : "cluster_id", "label_value" : "c429700c-5dc4-482a-9c0e-99f6c0635113" } ] } 状态码：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" }

请求示例 更新服务器类型的VPC通道后端服务器组 { "member_group_name" : "vpc_member_group", "member_group_weight" : 10 } 更新微服务类型的VPC通道后端服务器组 { "member_group_name" : "vpc_member_group", "member_group_weight" : 10, "microservice_version" : "v1", "microservice_port" : 80, "microservice_labels" : [ { "label_name" : "cluster_id", "label_value" : "c429700c-5dc4-482a-9c0e-99f6c0635113" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 member_group_name 是 String VPC通道后端服务器组名称。支持汉字、英文、数字、下划线、中划线、点，且只能以英文和汉字开头，3-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 member_group_remark 否 String VPC通道后端服务器组描述。 最大长度：255 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通道类型为微服务时支持。 reference_vpc_channel_id 否 String 引用的负载通道编号，仅VPC通道类型为引用类型（vpc_channel_type=reference）时支持。 最小长度：0 最大长度：64 表4 MicroserviceLabel 参数 是否必选 参数类型 描述 label_name 是 String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 label_value 是 String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63

URI PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups/{member_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号 member_group_id 是 String VPC通道后端服务器组编号

响应示例 状态码：201 Created { "auths" : [ { "api_id" : "5f918d104dc84480a75166ba99efff21", "auth_result" : { "status" : "SUC CES S" }, "auth_time" : "22020-08-04T04:02:22.482227344Z", "id" : "dd29b33ae4394e3b924b582c6b40880b", "app_id" : "356de8eb7a8742168586e5daf5339965", "auth_role" : "PROVIDER", "auth_tunnel" : "NORMAL" } ] } 状态码：400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:api_ids. 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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String 需要授权的环境编号 app_ids 是 Array of strings APP的编号列表 api_ids 是 Array of strings API的编号列表，可以选择租户自己的API，也可以选择从云商店上购买的API。

响应参数 状态码：201 表4 响应Body参数 参数 参数类型 描述 auths Array of ApiAuthRelations objects API与APP的授权关系列表 表5 ApiAuthRelations 参数 参数类型 描述 api_id String API编号 auth_result AuthResult object 授权结果 auth_time String 授权时间 id String 授权关系编号 app_id String APP编号 auth_role String 授权者 PROVIDER：API提供者授权 CONSUMER：API消费者授权 auth_tunnel String 授权通道类型 NORMAL：普通通道 GREEN：绿色通道 暂不支持，默认NORMAL auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array of strings 绿色通道的黑名单配置 visit_params String 访问参数。 表6 AuthResult 参数 参数类型 描述 status String 授权结果 SUCCESS：授权成功 SKIPPED：跳过 FAILED：授权失败 error_msg String 授权失败错误信息 error_code String 授权失败错误码 api_name String 授权失败的API名称 app_name String 授权失败的APP名称 状态码：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 错误描述

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String API分组发布的环境ID group_id 是 String API分组ID define 否 String 导出API的定义范围： spec：基础定义，只包括api前端定义 proxy：全量定义，包括api前后端定义 all：扩展定义，包括api前后端定义以及流控、访问控制、自定义认证等扩展定义 dev：开发定义，包括未发布的api的前后端定义 缺省值：spec type 否 String 导出的API定义的格式 缺省值：json version 否 String 导出的API定义版本，默认为当前时间 apis 否 Array of strings 导出的API ID列表

响应示例 状态码：400 Bad Request { "error_code" : "APIG.2001", "error_msg" : "The request parameters must be specified,parameterName:env_id. Please refer to the support documentation" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3001", "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 - File - 状态码：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 错误描述

URI POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/export 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 oas_version 否 String OpenAPI版本 缺省值：2.0

请求示例 VPC通道添加后端服务器地址 { "members" : [ { "host" : "192.168.2.25", "weight" : 1, "member_group_name" : "test" } ] } VPC通道添加云服务器 { "members" : [ { "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest02", "weight" : 2 } ] }

响应示例 状态码：201 Created 示例 1 { "total" : 1, "size" : 1, "members" : [ { "host" : "192.168.2.25", "weight" : 1, "is_backup" : false, "member_group_name" : "test", "status" : 1, "port" : 22, "ecs_id" : "3082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest", "id" : "683b6807cad54122a6777ad047a6178e", "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T09:13:24Z", "member_group_id" : "cf868f0224084710a1e188b7d3057c52" } ] } 示例 2 { "total" : 2, "size" : 2, "members" : [ { "host" : "192.168.0.17", "weight" : 2, "is_backup" : false, "member_group_name" : "test02", "status" : 1, "port" : 22, "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest02", "id" : "5c868f0224084710a1e188b7d3057c52", "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T09:03:53Z", "member_group_id" : "df868f0224084710a1e188b7d3057c52", "health_status" : "unhealthy" }, { "host" : "192.168.0.39", "weight" : 1, "is_backup" : false, "member_group_name" : "test01", "status" : 1, "port" : 22, "ecs_id" : "ebe1104f-1254-4ac6-8ed7-366bec84f36e", "ecs_name" : "APIGtest01", "id" : "33ac0e39d005492eb1f4683e66d1a0d1", "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T07:24:34Z", "member_group_id" : "ef868f0224084710a1e188b7d3057c42", "health_status" : "unhealthy" } ] } 状态码：400 Bad Request { "error_code" : "APIG.2004", "error_msg" : "The parameter value is outside the allowable range,parameterName:weight. 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.3023", "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码：201 表5 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 members Array of VpcMemberInfo objects 本次查询到的云服务器列表 表6 VpcMemberInfo 参数 参数类型 描述 host String 后端服务器地址 后端实例类型为ip时必填 最大长度：255 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 后端服务器组编号 health_status String 负载通道后端实例健康状态，unknown、healthy、unhealthy分别标识未做健康检查、健康、不健康。 状态码：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 错误描述

URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of MemberInfo objects 后端实例列表 表4 MemberInfo 参数 是否必选 参数类型 描述 host 否 String 后端服务器地址 后端实例类型为ip时必填 最大长度：255 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

响应示例 状态码：400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:domain_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.3020", "error_msg" : "The URL domain 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参数 参数 是否必选 参数类型 描述 domains 是 Array of AttachOrDetachDomainInfo objects 证书绑定或解绑域名列表 表4 AttachOrDetachDomainInfo 参数 是否必选 参数类型 描述 domain 是 String 域名 instance_ids 否 Array of strings 实例ID集合 verified_client_certificate_enabled 否 Boolean 是否开启客户端证书校验。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。

响应参数 状态码：204 OK 状态码：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 错误描述

响应示例 状态码：400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:group_id. Please refer to the support documentation" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3001", "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码：204 No Content 状态码：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 错误描述

URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}/{response_type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 response_id 是 String 响应编号 response_type 是 String 错误类型 AUTH_FAILURE: 认证失败，IAM或APP认证校验失败 AUTH_HEADER_MISSING: 认证身份来源信息缺失 AUTHORIZER_FAILURE: 自定义认证方返回认证失败 AUTHORIZER_CONF_FAILURE:自定义认证方异常，通信失败、返回异常响应等错误 AUTHORIZER_IDENTITIES_FAILURE: 前端自定义认证的身份来源信息缺失或不合法错误 BACKEND_UNAVAILABLE: 后端不可用，网络不可达错误 BACKEND_TIMEOUT: 后端超时，与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PA RAM ETERS_FAILURE: 请求参数校验失败、不支持的HTTP方法 DEFAULT_4XX: 其它4XX类错误 DEFAULT_5XX: 其它5XX类错误 THIRD_AUTH_FAILURE: 第三方认证方返回认证失败 THIRD_AUTH_IDENTITIES_FAILURE: 第三方认证的身份来源信息缺失或不合法错误 THIRD_AUTH_CONF_FAILURE: 第三方认证方异常，通信失败、返回异常响应等错误 ORCHESTRATION_PARAMETER_NOT_FOUND: 参数编排失败，请求中没有待编排的入参 ORCHESTRATION_FAILURE: 参数编排失败，没有编排规则匹配成功

URI GET /v2/{project_id}/apigw/instances/{instance_id}/instance-features 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 limit 否 Integer 每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20

响应示例 状态码：200 OK { "total" : 3, "size" : 3, "features" : [ "health_check_in_instance_etcd", "shubao_support_add_node", "resize_huge_flavor" ] } 状态码：401 Unauthorized { "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method" } 状态码：500 Internal Server Error { "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 features Array of strings 实例支持的特性列表： "resize_huge_flavor" "health_check_in_instance_etcd" "shubao_support_add_node" "upgrade_uninterrupted" "sm_cipher_type" 与实例版本有关，列表中不展示的特性为实例不支持的特性 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码：200 OK 示例 1 { "task_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2", "task_status" : "succeed", "task_type" : "import_api", "task_result" : "{\"success\":[{\"id\":\"ee93ce6815f04896b301452982b92222\",\"action\":\"create\",\"method\":\"GET\",\"path\":\"/test1\"}],\"failure\":[],\"swagger\":{\"id\":\"de1852ab6c5e4090b0bd88a02058e650\",\"result\":\"Success\"},\"group_id\":\"9100ae30705947cc9543d37cd7fb388c\"}" } 示例 2 { "task_id" : "d6e8834b6f0f4711a2fa5345e5b60833", "task_status" : "succeed", "task_type" : "export_api", "task_result" : "{\"FileName\":\"test8-RELEASE-all-2023-07-11-19:54:22\",\"FileType\":\".json\",\"Comment\":\"{\\n\\t\\\"swagger\\\": \\\"2.0\\\",\\n\\t\\\"info\\\": {\\n\\t\\t\\\"title\\\": \\\"test8\\\",\\n\\t\\t\\\"version\\\": \\\"2023-07-11-19:54:22\\\"\\n\\t},\\n\\t\\\"host\\\": \\\"9100ae30705947cc9543d37cd7fb388c.apic.cn-north-7.huaweicloudapis.com\\\",\\n\\t\\\"paths\\\": {\\n\\t\\t\\\"/test1\\\": {\\n\\t\\t\\t\\\"get\\\": {\\n\\t\\t\\t\\t\\\"security\\\": [\\n\\t\\t\\t\\t\\t{\\n\\t\\t\\t\\t\\t\\t\\\"apig-auth-app\\\": []\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"schemes\\\": [\\n\\t\\t\\t\\t\\t\\\"https\\\"\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"operationId\\\": \\\"API_zjev\\\",\\n\\t\\t\\t\\t\\\"responses\\\": {\\n\\t\\t\\t\\t\\t\\\"default\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"$ref\\\": \\\"#/responses/default\\\"\\n\\t\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\t\\\"x-apigateway-result-failure-sample\\\": \\\"\\\",\\n\\t\\t\\t\\t\\t\\\"x-apigateway-result-normal-sample\\\": \\\"\\\"\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"x-apigateway-backend\\\": {\\n\\t\\t\\t\\t\\t\\\"mockEndpoints\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"description\\\": \\\"\\\",\\n\\t\\t\\t\\t\\t\\t\\\"result-content\\\": \\\"not ok\\\"\\n\\t\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\t\\\"type\\\": \\\"MOCK\\\"\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"x-apigateway-cors\\\": false,\\n\\t\\t\\t\\t\\\"x-apigateway-match-mode\\\": \\\"NORMAL\\\",\\n\\t\\t\\t\\t\\\"x-apigateway-request-type\\\": \\\"public\\\"\\n\\t\\t\\t}\\n\\t\\t}\\n\\t},\\n\\t\\\"responses\\\": {\\n\\t\\t\\\"default\\\": {\\n\\t\\t\\t\\\"description\\\": \\\"response example\\\"\\n\\t\\t}\\n\\t},\\n\\t\\\"securityDefinitions\\\": {\\n\\t\\t\\\"apig-auth-app\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"Authorization\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"AppSigv1\\\"\\n\\t\\t},\\n\\t\\t\\\"apig-auth-app-header\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"Authorization\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-opt\\\": {\\n\\t\\t\\t\\t\\\"appcode-auth-type\\\": \\\"header\\\"\\n\\t\\t\\t},\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"AppSigv1\\\"\\n\\t\\t},\\n\\t\\t\\\"apig-auth-iam\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"unused\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"IAM\\\"\\n\\t\\t}\\n\\t}\\n,\\n\\t\\\"x-apigateway-responses\\\": {}\\n}\"}" } 示例 3 { "task_id" : "f01d2772ea4944408fa544c8ae5a9999", "task_status" : "failed", "task_type" : "import_api", "task_result" : "{\"error_code\":\"APIG.3201\",\"error_msg\":\"The API group name already exists\"}" } 示例 4 { "task_id" : "4dfbf6acaacf4c41a8b3c50daa90d3dc", "task_status" : "processing", "task_type" : "import_api", "task_result" : "" } 示例 5 { "task_id" : "c3b78a52fb28461aab92bf6c6989f731", "task_status" : "waiting", "task_type" : "import_api", "task_result" : "" } 状态码：400 Bad Request { "error_code" : "APIG.2001", "error_msg" : "The request parameters must be specified,parameterName:task_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.3093", "error_msg" : "The asynchronous task d9ce8c9eede54b3f841ec324fe0bfdc2 does not exist" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 task_id String 任务id task_status String 任务状态。waiting等待处理，processing处理中，succeed成功，failed失败。 task_type String 任务类型。 import_api为异步导入api，export_api为异步导出api。 task_result String 任务结果。string可转成json object。 当task_type为import_api时，字段包括API分组编号group_id、success数组、failure数组、swagger结构体、ignore数组。其中success数组元素中包括4个字段，导入成功的API编号id、API请求方法method、API请求路径path、导入行为action（枚举值，update表示更新API，create表示新建API）。failure数组元素中包括4个字段，API请求方法method、API请求路径path、导入失败的错误码error_code、导入失败的错误信息error_msg。swagger结构体包括2个字段，swagger文档编号id、导入结果说明result。ignore数组元素包括API请求方法method、API请求路径path。 当task_type为export_api时，字段包括导出文件类型file_type、导出文件内容content。 状态码：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 错误描述