检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
重置密钥 功能介绍 重置指定APP的密钥。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/secret/{id} URI中的参数说明如下表所示。 表2 参数说明
健康检查详情 名称 类型 说明 id String 健康检查的编号。 vpc_id String VPC通道的编号。 protocol String 使用以下协议,对VPC中主机执行健康检查。 TCP HTTP HTTPS path String 健康检查时的目标路径。 说明: 需要服从URI规范。
配置特殊流控 开启特殊流控配置开关,特殊凭据与特殊租户流量控制的使用场景。 绑定API 流量控制2.0策略绑定到API。 验证 通过相应的请求URL调用API,验证流量控制2.0策略是否生效。 父主题: 使用APIG专享版的流量控制2.0策略实现API的精细流控
对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。
自定义认证管理 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题: 共享版API(仅存量用户使用)
API分组管理 创建API分组 绑定域名 删除分组 新增网关响应 父主题: 共享版操作指导(仅存量用户使用)
流量控制 创建流控策略 删除流控策略 添加特殊应用或租户 删除特殊应用或租户 父主题: 共享版操作指导(仅存量用户使用)
授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
使用APIG专享版跨VPC开放后端服务 使用APIG专享版跨VPC开放后端服务方案概述 使用APIG专享版跨VPC开放后端服务资源规划 使用APIG专享版跨VPC开放后端服务操作流程 使用APIG专享版跨VPC开放后端服务实施步骤 父主题: 开放API
对象模型 本节介绍环境的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境管理对象模型 参数 类型 说明 操作类型 是否必选 id String
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
查询API概况 功能介绍 查询租户名下的API概况:已发布到RELEASE环境的API个数,未发布到RELEASE环境的API个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/a
查询APP概况 功能介绍 查询租户名下的APP概况:已进行API访问授权的APP个数,未进行API访问授权的APP个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/r
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
右侧返回结果回显区域打印API调用的Response信息。 开发者可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 父主题: 共享版操作指导(仅存量用户使用)
使用APIG专享版的流量控制2.0策略实现API的精细流控方案概述 应用场景 当在公网中调用APIG上公开的业务API时,如果不限制API调用的次数,随着用户的不断增加,会引起后端性能的下降,甚至会因为恶意用户发送的大量请求导致网站或程序崩溃。APIG提供了传统流量控制策略,从A
tcp http CRU 是 path Integer 路径,仅当协议为http时生效 CRU 否 port Integer 端口,无值时,使用通道端口 CRU 否 threshold_normal Integer 正常阈值 CRU 是 threshold_abnormal Integer
String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略值,支持一个或多个值,使用英文半角逗号分隔 请求消息样例: { "acl_name": "string", "acl_type": "PERMIT", "acl_value":
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
使用FunctionGraph服务实现APIG的自定义认证 应用场景 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。 API网关支持的自定义