检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
acl_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:api_id、env_id、env_name、acl_id、acl_name、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
配置API认证凭据的配额控制 凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。 操作步骤 进入API网关控制台页面。
仅在API为APP认证时,才支持授权给应用。 前提条件 已创建API分组和分组内的API。 (可选)已创建环境。 已创建应用。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,进入“授权应用”页面。 在待授权的API所在行,单击“更多 > 授权”,
前端双向认证。在绑定独立域名时,选择带有CA证书的SSL证书,开启客户端认证即双向认证。 后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API章节中的“TLS双向认证”参数说明。 共享版:不支持,API网关仅做HTTPS的单向认证。 父主题: API认证
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 环境上存在已发布的API时,该环境不能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{proj
专享版开放V2版本的接口,共享版开放V1.0版本的接口。共享版已下线,建议用户使用专享版管理您的API。 终端节点 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 基本概念 账号 用户注册华为云时的账号,账
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP请
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
RELEASE环境,请求X-Stage头的值需要填写发布的环境名称。 API认证鉴权 如果使用APP认证,Key和Secret是否正确。 API控制策略 访问控制策略是否设置正确。 是否超过了流量控制范围。系统默认的流控策略是单个API的访问不超过200次/秒,如果您未创建流控策
删除实例指定的自定义入方向端口 功能介绍 删除实例指定的自定义入方向端口,不包含默认端口80和443。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/custom-ingres
配置API的流量控制 添加特殊凭据或租户 配置API的流量控制2.0 API插件策略 配置API的跨域资源共享 配置API的HTTP响应头 配置API的Kafka日志推送 配置API的断路器 其他常用操作 配置API的发布环境和环境变量 配置API的访问控制 配置API的后端服务签名校验
删除凭据配额 功能介绍 删除凭据配额。删除凭据配额时,同时删除凭据配额和凭据的关联关系 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}
String 指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明
String 指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
配置API的流量镜像 API网关提供了镜像客户端请求的能力,将发送到源后端的流量复制一份到镜像服务中,在不影响业务后端的情况下,便于对请求内容进行具体的分析和统计。 约束与限制 同一个环境中,一个API只能被一个流量镜像策略绑定,但一个流量镜像策略可以绑定多个API。 镜像请求返回的响应会被忽略。
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。