检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关服务开放API基本流程 创建实例 共享版无需购买实例，可直接进入共享版。 创建API分组 每个API都归属到某一个API分组下，在创建API前应提前创建API分组。 绑定域名 在开放API前，您需要为API分组绑定一个独立域名，供API调用者访问API使用。 在绑定独立域名前，您可以使用系统
API受API超时时间的限制，如果当前WebSocket连接空闲时间超过了配置的超时时间，并且没有ping/pong保活，则连接会被自动断开。 前提条件 准备一个已做ping/pong保活的WebSocket服务后端。 操作步骤 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
识别可能影响业务的潜在风险。 安全防护 域名访问认证支持TLS1.1、TLS1.2防护，支持mTLS双向认证。 访问控制策略主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 断路器策略是API网关在后端服务
如果API分组中的API支持HTTPS请求协议，需要为独立域名添加SSL证书。反之，跳过此步骤。 配置API的调用域名 在开放API前，您需要为API分组绑定一个独立域名，供API调用者访问API使用。 在绑定独立域名前，您可以使用系统为API分配的调试域名进行API调试，每天最多可以访问调试域名1000次。系统自
在APIG实例控制台选择“API管理 > 凭据管理”，进入凭据详情，获取Key和Secret。 AppKey/Key：APP访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 AppSecret/Secret：与访问密钥ID结合
密算法。 域名 调试域名默认只能在与实例相同VPC内的服务器上解析和访问，如果调试域名要支持公网解析与访问，请在实例上绑定公网入口弹性IP。 调试域名不能用于生产业务，且仅限应用程序调试使用。 同一实例下的不同分组不能绑定相同的独立域名。 独立域名绑定端口时，同一域名不支持绑定相同端口。
目为单位进行授权，用户可以访问您账号中该区域的所有资源。此处默认为已选择的区域。 函数名称 根据规划自定义名称。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。此处默认“default”。 委托名称 用户委托函数工作流去访问其他的云服务。此处选择“未使用任何委托”。
请求方法：接口调用方式，默认“GET”。 请求协议：选择API请求协议，默认“HTTPS”。 子域名：API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名每天最多可以访问1000次。 路径：接口请求路径。此处填写“/1234”。 网关响应 API网关未能成功处理API请求，从而产生的错误响应。
s##test#。 说明： IP地址/域名可以是公网IP（支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址）/公网域名，前提需要开启实例的公网出口。可以是内网的IP，不可以是内网域名。 2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性，可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持shubao访问日志上报功能。 是 {"name":"lts"
热门咨询 开放API API的后端服务是否支持绑定私网ELB地址？ API的后端服务地址支持填写私有地址（子网IP）吗？ API可以绑定内网域名吗？ 调用API 调用API失败的可能原因 调用API报“The API does not exist or has not been published
API网关漏洞修复周期 SDK漏洞： 针对APIG提供的SDK所涉及的漏洞会根据风险等级在修复时间内对外发布修复版本，由客户自行升级SDK版本进行修复。 其他漏洞： 按照版本正常升级流程解决。 修复声明 为了防止客户遭遇不当风险，除漏洞背景信息、漏洞详情、漏洞原理分析、影响范围/版本/场景、解决
LB负载的实例的安全组不生效，如需禁用部分IP请使用访问控制策略。 开启ELB负载：ELB作为网关入口的负载均衡器，入口支持跨VPC访问。但在开启公网入口时，弹性IP地址由网关随机分配，不支持选择已有弹性IP地址。 步骤二：创建实例 进入购买实例页面。 根据下表配置实例信息。 表2
s##test#。 说明： IP地址/域名可以是公网IP（支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址）/公网域名，前提需要开启实例的公网出口。可以是内网的IP，不可以是内网域名。 2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
objects 分组上绑定的独立域名列表 sl_domain_access_enabled Boolean 调试域名是否可以访问，true表示可以访问，false表示禁止访问 缺省值：true sl_domains Array of strings 系统默认分配的子域名列表 remark String
等待流控刷新后访问。如果触发子域名的单日请求数上限，请绑定独立域名。 APIG.0310 The project is unavailable. 403 project不可使用 使用其他project访问 APIG.0311 Incorrect debugging authentication
该操作将导致此API无法被访问，可能会影响正在使用此API的应用或者用户，请确保已经告知用户。 已上架云商店的API，无法被删除。 已发布的API，需要先下线API，再删除。 操作步骤 进入共享版控制台。 单击“开放API > API管理”，进入到API管理信息页面。 通过以下任意一种方法，弹出“删除API”对话框。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
