检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看变量详情 功能介绍 查看指定的环境变量的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/env-variables/{id}
操作流程 开启重定向 开启重定向功能的API的前端请求协议必须为“HTTPS”或“HTTP&HTTPS”。 验证重定向 验证重定向功能是否生效。 父主题: 使用APIG专享版实现http到https自动重定向
查看变量详情 功能介绍 查看指定的环境变量的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/env-variables/{id} URI中的参数说明如下表所示。 表2 参数说明
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances
华为云账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的IAM用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,I
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
)。 单击“导入参数”下方的“文件”,选择待导入的API文件。 支持yaml和json两种文件格式的API导入,界面可预览待导入API内容。 图2 导入参数 (可选)修改待导入API的全局配置。 您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。 图3 修改全局配置
查询API分组概况 功能介绍 查询租户名下的API分组概况:上架的API分组个数,未上架的API分组个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/resources/outline/groups
查询API概况 功能介绍 查询租户名下的API概况:已发布到RELEASE环境的API个数,未发布到RELEASE环境的API个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/a
API网关支持的自定义认证需要借助函数工作流服务实现,用户在函数工作流中创建自定义认证函数,API网关调用该函数,实现自定义认证。 API网关流量控制2.0策略 当在公网中调用APIG上公开的业务API时,如果不限制API调用的次数,随着用户的不断增加,会引起后端性能的下降,甚至会
功能介绍 删除指定的流控策略,以及该流控策略与API的所有绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttles/{id} URI中的参数说明如下表所示。
查询APP概况 功能介绍 查询租户名下的APP概况:已进行API访问授权的APP个数,未进行API访问授权的APP个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/r
删除流控策略 功能介绍 删除指定的流控策略,以及该流控策略与API的所有绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instan
info的title作为API分组名称,新创建的API分组名称不能与已有的API分组名称重名。 导入的API定义中,如果存在冲突,那么根据系统导入的先后顺序,先导入的API会显示导入成功,后导入的API会显示导入失败。例如导入的API定义中存在2个名称相同或请求路径相同的API,那么先导入的API会显示导入成功,后导入的会显示导入失败。
随着用户多样性以及需求多样性的增加,传统流控策略无法满足更加精细的流量控制场景。比如针对某一请求参数的流控或者某一租户的流控,APIG在传统流量控制策略的基础上提供了插件策略(流量控制2.0),通过制定更加精细的方案来进行流控。 使用APIG的APP认证和自定义认证实现API的双重认证 在AP
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https) 约束与限制
the environment” 调用API网关中开放的API报错,请按以下顺序排查可能原因: 调用API所使用的域名、请求方法、路径不正确。 比如创建的API为POST方法,您使用了GET方法调用。 比如访问的URL比API详情中的URL少一个“/”也会导致无法匹配上此API,例如
响应消息 表3 参数说明 名称 类型 说明 variables 字典数据类型 本次返回的环境变量列表 total Integer 满足条件的环境变量总数 size Integer 本次返回的列表长度 表4 variables参数说明 参数 类型 说明 id String 环境变量编号 env_id