检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击API分组名称,进入API分组详情页面。 单个下线API。在左侧选择API,然后在右上角单击“下线”,弹出“下线API”对话框。 批量下线API,最多同时下线1000个API。单击“批量操作”,选择API,然后单击下线按钮,弹出“下线API”对话框。
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
此时API调用者调用此API时,API的匹配模式为“绝对匹配”。 发布API相关的FAQ 对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问? API发布到不同环境后,会调用不同的后端服务吗? 父主题: API管理
String API所属分组的编号 group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method
授权API API在创建后,通过指定授权给某些凭据,让指定凭据能够调用API。 仅在API为APP认证时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
下线API 功能介绍 将API从某个已发布的环境上下线,下线后,API将无法再被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apis/publish/{api_id}[
POST /v1.0/apigw/apis/publish/{api_id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 api_id 是 String API的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 env_id 是 String
导出API 表1 导出API 参数名称 说明 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基
创建API 操作场景 API提供者把API接口配置在API网关中,开放后端能力。 创建API主要分为四个步骤:设置基本信息、定义API请求、定义后端服务和定义返回结果。 API网关服务基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建A
切换API版本 功能介绍 API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id
API管理 创建API分组 导入CSE微服务 导入CCE工作负载 绑定域名 创建环境变量 新增网关响应 创建API 创建GRPC API 克隆API 开启跨域访问 调试API 授权API 发布API 下线API 导入导出API 查看API列表 支持HTTP2.0
表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{id}
进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,下线API。 在待下线的API所在行,单击“更多 > 下线”,弹出“下线API”对话框。 单击“API名称”,进入API详情页面。在右上角单击“下线”,弹出“下线API”对话框。 如果需要
API发布 对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问? API发布到不同环境后,会调用不同的后端服务吗? API调试的时候,如何指定环境?
API策略 创建策略并绑定API 跨域资源共享策略说明 响应缓存策略说明 HTTP响应头管理策略说明 流量控制2.0策略说明 Kafka日志推送策略说明 断路器策略说明 第三方认证策略说明 流量镜像策略说明 流量控制策略说明 访问控制策略说明 签名密钥策略说明 自定义认证 SSL证书管理
克隆API API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请创建API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
API概览 API网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instanc
在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,单击“创建API > 创建API”。 根据下表参数信息,配置前端定义。 创建API时,当API所属分组、请求方法、请求路径、匹配模式都重复时,API无法创建成功。 表1 前端定义 参数 说明 API名称