检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看或编辑APIG的API信息 API列表支持查看或编辑当前实例下所有的API,查看或编辑API的运行环境、请求方法、请求路径等信息。 查看或编辑API信息 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”,您可以查看或编辑当前实例下的所有
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
变更APIG的实例规格 当实例规格无法满足您的业务需求时,您可以进行规格变更操作升配到更高规格版本。 约束与限制 规格变更过程中,长连接会发生闪断,需要重新建链,建议业务低峰期进行规格变更。 只能升配到更高规格,无法降配规格。 规格变更时,出私网IP会发生变化,如有相关防火墙配置或者白名单配置需要完全放通
使用APIG专享版实现不同后端服务的调用方案概述 应用场景 API网关支持定义多个策略后端,通过不同的策略条件,将API请求转发到不同的后端服务中,用以满足不同的调用场景。例如为了区分普通调用与特殊调用,可以定义一个“策略后端”,通过调用前端自定义认证参数,为特殊调用方分配专用的后端服务
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
下线API 功能介绍 将API从某个已发布的环境上下线,下线后,API将无法再被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apis/publish/{api_id
查看API详情 功能介绍 查看指定的API的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/
删除APP 功能介绍 删除指定的APP。 APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
对象模型 本节介绍APP与API之间的授权关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP授权关系对象模型 参数
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/app-auths/{id
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL
查看或编辑APIG实例信息 实例创建完成后,可在控制台查看和编辑实例的配置信息。 查看或编辑实例信息 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上,单击“查看控制台”或实例名称。 在“实例信息”页签,根据下表参数说明,查看或编辑实例的配置信息。
授权API 操作场景 API在创建后,通过指定授权给某些应用,让指定应用能够调用API。 仅在API发布到环境后,才支持被授权。 仅在API为APP认证时,才支持授权给应用。 前提条件 已创建API分组和分组内的API。 (可选)已创建环境。 已创建应用。 操作步骤 进入共享版控制台
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍APP的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP对象模型 参数 类型 说明 操作类型 是否必选
重置密钥 功能介绍 重置指定APP的密钥。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/secret/{id} URI中的参数说明如下表所示。 表2 参数说明