检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常，通信失败、返回异常响应等错误 自定义认证失败
instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
个独立域名，供API调用者访问API使用。 在绑定独立域名前，您可以使用系统为API分配的调试域名进行API调试，每天最多可以访问调试域名1000次。系统自动分配的域名不能用于生产业务，且仅限应用程序调试使用。 创建API的负载通道（可选） 如果需要访问指定服务器中已部署的后端服
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道，并在创建API时将后端节点配置为使用这些VPC通道，以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问，可能会影响相当一部分应用和用户。请确保已经告知用户，或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道，并在创建API时将后端节点配置为使用这些VPC通道，以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}
API网关支持http重定向到https功能。当用户的API采用http协议访问时，由于http没有传输安全与认证安全保障，可以使用API网关的重定向功能将API升级为安全的https协议访问，同时兼容已有的http协议。（2022年11月30日之后创建的实例支持http重定向到https） 约束与限制
version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间，单位：毫秒 register_time Timestamp 创建时间
购买云专线。 购买一条连接本地数据中心到华为云API网关（所绑定的虚拟私有云）的云专线，请按以下操作顺序执行： 购买物理连接接入 即购买一条连接本地数据中心与华为云的运营商线路。建议您选择“一站式接入”，华为云负责施工工程。 如果已有数据中心到华为云的物理连接，可直接使用。 创建虚拟网关
创建API分组 功能介绍 API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer
spec_id 是 String 实例规格： BASIC：基础版实例 PROFESSIONAL：专业版实例 ENTERPRISE：企业版实例 PLATINUM：铂金版实例 BASIC_IPV6：基础版IPV6实例 PROFESSIONAL_IPV6：专业版IPV6实例 ENTERPRISE_IPV6：企业版IPV6实例
个IP访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 app_call_limits Integer APP流量限制是指一个API在时长之内被每个APP访问的次数
已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 查看带宽监控 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 带宽监控”。 根据下表参数说明，配置监控信息。 表1 监控信息 参数 配置项 带宽IP 带宽IP为实例的入口或出口IP，可在实例信息中查看。
0.1 访问控制策略最多支持设置100个IP地址或网段，且最大长度为5120。 如果使用IPv6地址，请先确保对应实例支持IPv6协议。 如果不开启访问控制策略，默认允许所有IP访问；如果开启访问控制策略，设置“白名单”类型，但是没有配置任何IP地址，则禁止任何IP访问；如果开启
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问，可能会影响相当一部分应用和用户。请确保已经告知用户，或者确认需要强制下线。 环境上存在已发布的API时，该环境不能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{proj
39：重启失败 40：实例异常 41：重启超时 42：规格变更中 43：规格变更失败 44：规格变更超时 type String 实例类型 默认apig spec String 实例规格： BASIC：基础版实例 PROFESSIONAL：专业版实例 ENTERPRISE：企业版实例 PLATINUM：铂金版实例
api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer
APIC.7301 Instance spec not found 实例规格不存在 使用存在的实例规格 404 APIC.7302 Instance not found 实例不存在 检查实例是否存在，使用正确的实例ID 404 APIC.7307 The security group
API的响应码如何定义？ API响应码分两种类型。 一种是网关响应码。当请求到达网关时，由于API的流量控制、访问控制策略以及认证失败，网关直接返回的响应信息。有关网关响应的详细指导，请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务（即API的提供者）定义，API网关只做透传。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
