检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的调用域名 在开放API前，您需要为API分组绑定独立域名，用户通过独立域名访问分组内的API。最多可以添加5个独立域名，不限访问次数。 独立域名可分为内网域名和公网域名两种： 内网域名：部署在云服务平台内的业务系统，可以使用内网域名访问API。 公网域名：部署在云服务
仅在用户后端服务所在的VPC下能够解析。 解决方法 方法一：在创建API时，使用公网域名配置“后端服务地址”。 方法二：在创建API时，不使用VPC通道（负载通道），使用用户后端服务IP配置“后端服务地址”，添加常量参数，在HEADER中添加Host：域名字段。 方法三：在创建API时，使用VPC通道（负载通道）。
查询某个实例的租户配置列表 功能介绍 查询某个实例的租户配置列表，用户可以通过此接口查看各类型资源配置及使用情况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs
部署在VPC下的应用是否可以调用API？ 默认部署在VPC下的应用可以调用API。如果域名解析失败，则参考配置内网DNS，在当前终端节点上配置DNS服务器。配置完成后，部署在VPC下的应用可以调用API。 配置内网DNS 配置DNS需要配置“/etc”目录下的resolv.conf文件，指定DNS服务器的IP地址。
在“创建策略”弹窗中，配置策略信息。 表1 跨域资源共享策略配置 参数 说明 策略名称 填写策略的名称，根据业务规划自定义。建议您按照一定的命名规则填写策略名称，方便您快速识别和查找。 策略类型 固定为“跨域资源共享”。 描述 填写策略的描述信息。 策略内容 策略的配置内容，支持表单配置和脚本配置两种方式。
添加SSL证书失败常见原因：生成证书的域名和实际添加证书所用的域名不一致。 后续操作 绑定独立域名后，您可以开始创建API，将API接口配置在API网关中，开放后端能力。 父主题： API分组管理
应头中获取此处配置的头部，传到业务后端。 最大支持配置10个头部。 简易鉴权模式 开关开启后，鉴权服务返回状态码“2xx”时，表示认证通过。 鉴权结果匹配 仅在“简易鉴权模式”关闭后可配置。 根据鉴权服务返回的响应头中的参数名和参数值进行校验，响应头中存在此处配置的参数名，并且参数值相等则认证通过。
在“创建策略”弹窗中，配置策略信息。 表1 流量镜像参数说明 参数 说明 策略名称 填写策略的名称，根据业务规划自定义。建议您按照一定的命名规则填写策略名称，方便您快速识别和查找。 策略类型 固定为“流量镜像”。 描述 填写策略的描述信息。 策略内容 策略的配置内容，支持表单配置和脚本配置两种方式。
单个IP地址调用API次数上限。您可以选择配置实例的“real_ip_from_xff”参数使用X-Forwarded-For头中的IP作为流控的判断依据。 不超过“API流量限制”。 与“时长”配合使用，表示单位时间内的单个IP地址请求次数上限。 参数流控配置 参数流控配置开关。开启后，以参数维度进行流控限制。
仅当“安全协议”选择“SASL_PLAINTEXT”或“SASL_SSL”时需配置。 填写与SASL用户密码一样的值。 证书内容 仅当“安全协议”选择“SASL_SSL”时需配置。 SSL认证所使用的CA证书内容。 元数据配置信息 系统元数据 推送的日志中，需要携带的系统字段信息。 其中，s
账号ID：仅适用IAM认证类型的API，限制调用API的账号ID。仅支持配置账号ID，对账号ID及账号ID下的IAM用户ID做限制，不支持配置IAM用户ID。 可以配置单账号ID或多账号ID，多账号ID以英文格式下的“,”隔开。账号ID为英文字母、数字组成的32位字符；多账号ID字符的总长度不超过1024。 说明：
降级参数配置 降级参数配置开关。开启后可为断路器自定义规则，API请求优先匹配自定义规则中的触发条件和降级策略，仅当未匹配到自定义规则时才执行上方配置的默认触发条件和降级策略。 如果匹配到自定义规则，则执行规则内配置的触发条件和降级策略。如果匹配到的自定义规则内未配置触发条件或
修改域名 功能介绍 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时，注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_
响应缓存键 配置参数作为响应缓存键，用于区分不同的缓存。 system_params类型：配置不同的网关内置系统参数作为响应缓存键来区分缓存。配置参数请参考网关内置参数。 parameters类型：配置不同的请求query参数作为响应缓存键来区分缓存。 headers类型：配置不同的请求头作为响应缓存键来区分缓存。
失败返回示例，描述API的异常返回信息 response_id String 分组自定义响应ID sl_domain String 分组的二级域名 sl_domains Array of strings 分组的二级域名列表 req_params 字典数据类型 API的请求参数列表 表5 req_params参数说明 参数
配置API的HTTP响应头 API响应是指API网关返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持，请联系技术支持升级实例到最新版本。 策略参数会明文展示，为防止信息泄露，请谨慎配置。
实例配置特性 功能介绍 为实例配置需要的特性。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/features
配置API的流量控制 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 使用限制 API添加流控策略相当于流控策略同步绑定了API。同一
配置APIG实例参数 配置参数提供了实例内组件的公共参数配置，通过修改配置参数，可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断，建议在无业务运行或业务低峰时修改配置参数。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置
凭据管理”。 单击凭据名称，进入凭据详情页面。 在“AppCodes”区域，单击“添加AppCode”。 在弹窗中配置AppCode，完成后单击“确定”。 表1 配置AppCode 参数 说明 生成方式 选择AppCode的生成方式。 自动生成：由系统随机生成AppCode。 手动输入：自定义AppCode。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
