检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
查询实例的终端节点服务的白名单列表 功能介绍 查询当前实例终端节点服务的白名单列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/permissions 表1
应用场景 企业内部系统解耦 随着企业的高速发展、业务的快速变化,需要企业内部系统跟随业务需求一同变化,但是企业内部系统存在相互依赖关系,为保持系统的通用性与稳定性,很难应对业务的变化。而API网关使用RESTful API, 帮您简化服务架构,通过规范化、标准化的API接口,快速
“无认证”方式的API该怎么鉴权与调用? “无认证”即API网关对收到的调用请求不做身份认证,您只需要按照API提供者提供的接口说明,封装规范的HTTP请求,发送给API网关即可。 无认证方式下,API网关把请求内容透传给后端服务。因此,如果您希望在API后端服务进行鉴权,可以使
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。
方案概述 应用场景 云容器引擎(Cloud Container Engine,即CCE)中的工作负载,以及微服务,可通过API网关将服务能力以API形式对外开放。 开放CCE工作负载支持以下两种方式,推荐使用方式一直接创建负载通道的方式开放CCE工作负载: 方式一 在API网关中
构造请求 本节介绍如何构造REST API的请求,并以调用APIG服务的创建API分组(专享版API)说明如何调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
第三方认证策略说明 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 第三方认证原理图如下,第三方认证策略绑定API后,您可以参考调用API调用。
共享版API(仅存量用户使用) API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理
使用API网关专享版开放本地数据中心的服务能力 API网关的后端服务有3类部署形态: 后端服务部署在虚拟私有云(以下简称VPC)中,仅支持私有地址访问。 可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。 后端服务部署在公网环境中,即可以直接通过公网地址访问。
创建专享版实例(包周期) 功能介绍 创建包周期专享版实例。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/prepay-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
专享版API(V2) 专享版-API分组管理 专享版-环境管理 专享版-环境变量管理 专享版-流控策略管理 专享版-API管理 专享版-签名密钥管理 专享版-签名密钥绑定关系管理 专享版-API绑定流控策略 专享版-设置特殊流控 专享版-APP授权管理 专享版-概要查询 专享版-域名管理
权限策略和授权项 如果您需要对您所拥有的API网关服务进行精细的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM)。 如果华为云账号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用API网关服务的其它功能。
JavaScript 操作场景 使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建,本章节以IntelliJ IDEA 2018
创建包周期规格变更订单 功能介绍 创建包周期规格变更订单。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/prepay-resize 表1 路径参数 参数 是否必选 参数类型 描述
删除编排规则 功能介绍 删除编排规则 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/orchestrations/{orchestration_id} 表1 路径参数 参数 是否必选
按需规格变更 功能介绍 创建按需规格变更订单。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid-resize 表1 路径参数 参数 是否必选 参数类型 描述 project_id
删除实例指定的自定义入方向端口 功能介绍 删除实例指定的自定义入方向端口,不包含默认端口80和443。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/custom-ingres
删除域名证书 功能介绍 如果域名证书不再需要或者已过期,则可以删除证书内容。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_i