检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
停止计费 包年/包月模式 对于包年/包月计费模式的实例资源，您在购买时会一次性付费，服务将在到期后自动停止使用。 如果在计费周期内不再使用包年/包月资源，您可以执行退订操作，系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订。
已有独立域名。可通过域名注册服务申请新的域名。 公网独立域名需要备案，未备案的独立域名无法被访问。备案时长需几个工作日，建议您提前进行备案。 共享版：已将独立域名CNAME解析到分组的子域名上，具体方法请参见增加CNAME类型记录集。 如果API分组中的API支持HTTPS请求协议，那么在独立域名中需要添加SSL
表2 参数说明 参数 是否必选 类型 说明 env_id/env 是 String API分组发布的环境ID，目前支持env_id和env，两个均存在时以env_id为准，建议使用env_id define 否 String 导出API的定义范围： base：基础定义 full：全量定义
专享版实例可以根据需要分别开启公网入口和公网出口，每个实例都会有单独的公网入口IP和公网出口IP，该IP与原有的共享版IP不同，如果上游和下游（服务端和客户端）的相关服务有网络安全策略的设置，需要修改相应的网络安全策略，放通对应IP的访问。 内网出入口的变化 每个专享版实例都会拥有一个VPC内的入口私有IP，以
IpDetails objects 私网入口地址列表 unreliable_ips Array of strings 不建议使用的实例入口列表：分组子域名解析未指向到该列表的IP，不能用该列表的IP直接访问DEFAULT分组 enable_fullstack_ipv6 Boolean 实例是否支持全量IPv6
Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥
约束与限制 负载均衡限制 API网关专享版支持的负载均衡模式为LVS模式或ELB模式。当前仅墨西哥城一、北京一区域支持LVS模式，其他区域支持ELB模式。 配额限制 如果您需要修改默认限制值，请参考如何申请扩大配额。专享版更多参数配置，请参见配置参数。 新增或修改的APIG资源存在数据同步延迟，需要5-10秒才生效。
第三方认证策略说明 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务，收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持，请联系技术支持升级实例到最新版本。 第三方认证原理图如下，第三方认证策略绑定API后，您可以参考调用API调用。
实例ID，可从API网关控制台的专享版实例信息中获取。 env_id/env 是 String API分组发布的环境ID，目前支持env_id和env，两个均存在时以env_id为准，建议使用env_id define 否 String 导出API的定义范围： base：基础定义 full：全量定义
策略的绑定、解绑、更新会实时生效，不需要重新发布API。 API的下线操作不影响策略的绑定关系，再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系，则策略无法执行删除操作。 创建策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
专享版-VPC通道管理 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查询VPC通道列表 添加或更新后端实例 查看后端实例列表 更新后端实例 删除后端实例 批量修改后端服务器状态可用 批量修改后端服务器状态不可用 修改VPC通道健康检查 添加或更新VPC通道后端服务器组
访问控制策略说明 访问控制策略是API网关提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址/账号名/账号ID访问API。实例级访问控制策略请参考表1。 访问控制策略和API本身是相互独立的，只有将
总览 API网关（API Gateway）是为您提供高性能、高可用、高安全的API托管服务，帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。 API网关支持专享版和共享版（存量用户）功能。专享
VPC通道管理 对象模型 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例（云服务器） 删除后端实例（云服务器） 查看后端实例列表（云服务器列表） 父主题： 共享版API（仅存量用户使用）
VPC通道管理（待下线） 对象模型 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例（云服务器） 删除后端实例（云服务器） 查看后端实例列表（云服务器列表） 父主题： 专享版API（V1）（待下线）
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。
参数说明 名称 类型 说明 id String 自定义域名的编号 url_domain String 自定义域名 status Integer 解析状态值 ssl_id String 证书的编号 ssl_name String 证书的名称 响应消息样例： { "id": " b9be
基本概念 API API（Application Programming Interface，应用程序编程接口）是一些预先定义的函数，应用将自身的服务能力封装成API，并通过API网关开放给用户调用。 API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API分组 AP
APP认证信息错误 APP认证信息错误有： Incorrect app authentication information: app not found, appkey xxx Incorrect app authentication information: verify signature
流量控制策略说明 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 使用限制 已了解前提条件。 API添加流控策略相当于流控策略同步绑定
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
