检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API管理 创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。
连接目标Kafka所使用的安全协议。 PLAINTEXT:默认接入点的用户认证协议。 SASL_PLAINTEXT:SASL用户认证协议。 SASL_SSL:SSL用户认证协议。 消息收发机制 目标Kafka的消息收发机制,默认为PLAIN。 SASL用户名 仅当“安全协议”选择“SASL_PLAI
IDEA官方网站下载。 已在IntelliJ IDEA中安装Go插件,如果未安装,请按照图1所示安装。 图1 安装Go插件 获取SDK 请登录API网关控制台,参考《API网关用户指南》的“SDK”章节,进入SDK页面并下载SDK。 或直接下载SDK的最新版本,获取“ApiGateway-go-sdk
API网关提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败
Engine,简称CSE)的微服务,提供API注册开放CSE服务能力。 如果当前实例不支持“导入CSE微服务”,请联系客服。 目前仅广州友好、贵阳一、上海一、广州、北京四区域支持导入CSE服务。 注意事项 仅支持导入未开启安全认证的微服务引擎。 您需保证当前实例与微服务实例地址网络可达,否则导入后调用API会出现失败场景。
已在IntelliJ IDEA中安装PHP插件,如果未安装,请按照图1所示安装。 图1 安装PHP插件 获取SDK 请登录API网关控制台,参考《API网关用户指南》的“SDK”章节,进入SDK页面并下载SDK。 或直接下载SDK的最新版本,获取“ApiGateway-php-sdk
配置凭据策略 配置API认证凭据的配额控制 配置API认证凭据访问控制
已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 带宽监控”。 根据下表,配置监控信息。 表1 监控信息 参数 配置项 带宽IP 带宽IP为实例的入口或出口IP,可在实例信息中查看。 时间段
可以不以“/”结尾。 添加规范查询字符串(CanonicalQueryString),以换行符结束。 释义: 查询字符串,即查询参数。如果没有查询参数,则为空字符串,即规范后的请求为空行。 格式: 规范查询字符串需要满足以下要求: 根据以下规则对每个参数名和值进行URI编码: 请勿对RFC
导入导出API 导入API失败有哪些原因? 使用Swagger文件导入API时是否有模板?
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间
进入共享版控制台 存量用户进入共享版控制台操作如下。 登录API网关控制台页面。 在“总览”页面的右上角单击“进入共享版控制台”,进入共享版页面。 父主题: 共享版操作指导(仅存量用户使用)
TTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 使用限制 无法修改API网关增加的系统响应头(x-apig
查看或编辑APIG的API信息 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证等信息。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 您可以管理当前实例下的所有API,支持编辑、发布、调试等操作。 在左侧导航栏选择“API管理
流控策略创建者的租户编号 - - api_call_limits Integer 单个API流控时间内能够被访问的最大次数 CRU 是 user_call_limits Integer 单个用户流控时间内能够访问的最大次数,遵循api_call_limits>=user_call_limits CRU
页面。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API创建流控策略、创建访问控制策略和创建并使用签名密钥。 父主题: API管理
api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer
配置API的传统策略 配置API的流量控制 配置API的访问控制 配置API的后端服务签名校验 父主题: 配置API策略