检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 分组的编号
配置API的传统策略 配置API的流量控制 配置API的访问控制 配置API的后端服务签名校验 父主题: 配置API策略
介绍如何调用API(简易认证) 02:01 调用API(简易认证) API网关 APIG 介绍如何创建访问控制策略 01:52 创建访问控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) 最佳实践 API网关 APIG 在API网关上开放内网ELB中的服务
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
API概览 API网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/in
操作步骤 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,例如“API01”。 所属分组 API所属分组,此处默认“DEFAULT”。
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps
查看专享版实例详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id
满足条件的记录数 apis Array of OrchestrationApiInfo objects 编排规则绑定的API列表。 表5 OrchestrationApiInfo 参数 参数类型 描述 api_id String API编号。 api_name String API名称。
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HT
表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id
方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询安全组列表”章节。 eip_id 否 String 弹性公网IP ID。 实例需要开启公网访问,且loadbalancer_provider为lvs时需要填写,绑定后使用者可以通过该入口从公网访问APIG实例中的API等资源
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。
查看API绑定的流控策略列表 功能介绍 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bin
检查APP是否授权访问API APIG.0305 Incorrect authentication information. 401 认证信息错误 检查认证信息是否正确 APIG.0306 API access denied. 403 不允许访问API 检查是否授权访问API APIG.0307
描述 $context.apiId API的ID $context.apiName API名称 $context.appId API调用者的凭据对象ID $context.appName API调用者的凭据对象名称 $context.requestId 当次API调用生成请求ID $context
管理APIG实例 查看或编辑APIG实例信息 配置APIG实例参数 配置APIG实例标签 配置APIG的终端节点信息 自定义APIG的客户端访问端口 变更APIG的实例规格