检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Integer 是否需要编排 1:是 2:否 目前默认为:2 R - backend_type String 后端服务类型: HTTP:web后端 FUNCTION:函数服务 MOCK: MOCK CRU 是 register_time Timestamp API创建时间 R - update_time
删除应用 操作场景 已创建的应用不再提供服务,可以将应用删除。 从云商店购买的API生成的应用,不支持删除。 前提条件 已创建应用。 操作步骤 进入共享版控制台。 单击“调用API > 应用管理”,进入到应用管理信息页面。 通过以下任意一种方式,进入对话框。 在待删除的应用所在行,单击“删除”。
环境变量是指在环境上创建的一种变量,该变量固定在环境上。如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量。通过环境变量,可实现同一个API,在不同环境中调用不同的后端服务。 例如创建API时,后端服务请求Path中定义了变量“Path”。在环境1中创建了变量“Pat
铂金版X依次增加4个私有地址。),上下游服务(服务端和客户端)需要酌情调整网络安全策略,保证网络可达。如果下游存在跨VPC调用的场景时,需要通过VPC终端节点对接到APIG专享版的VPC终端节点服务上,以保证网络可达。具体操作详见实施步骤。 调试域名的变化 原共享版的分组调试域名{group-id}
工作负载类型的介绍请参考工作负载概述。 服务标识名 选择工作负载的Pod标签,通过Pod标签指定某个工作负载。服务标识名为Pod标签的键,服务标识值为Pod标签的值。 Pod标签相关内容指导,请参考设置标签与注解。 服务标识值 标签 选择工作负载的Pod标签。如果服务标识名和服务标识值不唯一,且不能
共享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,API网关会拒绝该请求。这种场景,推荐考虑使用对象存储服务。 专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,根据业务需求,请在“实例概览”的配置参数中修改
ey、Secret),在调用API时,API网关服务根据密钥对进行身份核对,完成鉴权。Key唯一且不可重置,支持重置Secret。 配置APIG的API简易认证AppCode API配置简易认证模式后,在调用API时,API网关服务既可以根据AppCode进行简易认证,也可以根据密钥对进行鉴权。
例如,后端服务部署在外部网络,则需要设置相应的安全组规则,允许访问后端服务地址与API调用端口。 说明: 如果开启公网入口,安全组入方向需要放开80(HTTP)和443(HTTPS)端口的访问权限。 终端节点服务名称 填写终端节点服务名称。购买实例后,同步创建VPC终端节点服务,可以被终端节点连接和访问。
通过创建负载通道,可访问指定服务器中已部署的后端服务。 创建API 把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。 API创建成功后,您可根据业务需求配置API策略,管理API等。 调试APIG创建的API 验证API服务的功能是否正常可用。 配置API的发布环境和环境变量(可选)
账单出账时间通常在当前计费周期结束后一小时内,最长不超过三个小时。 适用计费项 使用量(包含API调用量和公网流量) 如果后端服务与API网关不在同一区域,或后端服务不在华为云,将会额外收取API网关到后端服务的流量费用。 适用场景 适用于API需求较小的场景。 父主题: 计费模式
基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。
x-apigateway-backend.httpEndpoints HTTP类型服务定义 httpVpcEndpoints 否 x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型服务定义 functionEndpoints 否 x-apigateway-backend
VPC通道的创建、更新、删除、查看,查询VPC通道列表。 后端实例的添加、查看、删除。 后端服务器状态的批量修改。 VPC通过健康检查的修改。 后端服务器组的添加、更新、删除、查看,查询VPC通道后端服务器组列表。 监控信息查询 包括查询最近一段时间的API统计信息,查询最近一小时内的分组统计信息。
访问控制策略的IP地址不一定取客户端的IP地址。 APIG的访问控制是根据$remote_addr的值进行校验。$remote_addr代表客户端的IP,它的值是服务端根据客户端的IP指定的,当客户端访问APIG时,如果中间没有任何代理,那么就会把remote_addr设为客户端IP;如果使用了某个代理
析到1个分组。 如果您使用的公网域名,需要在DNS服务公网解析内注册CNAME记录(共享版)/A记录(专享版)。 如果您使用的内网域名,需要在DNS服务内网解析内注册CNAME记录(共享版)/A记录(专享版),还需要关联后端服务所属的VPC。 父主题: API创建
境1中调用此API时,后端服务请求Path为“/Stage/test”。在环境2中创建了变量名“Path”,变量值“/Stage/AA”,则API在发布到环境2时,使用“/Stage/AA”代替“Path”,API调用者在环境2中调用此API时,后端服务请求Path为“/Stage/AA”。
创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考《开发指南》。 使用无认证、华为IAM认证的API、自定义认证,无需创建凭据。
在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全问题。 约束与限制 API网关支持的自定义认证需要借助函数工作流服务实现。 父主题: 使用APIG的APP认证和自定义认证实现API的双重认证
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
通过API设计文件导入API 从本地导入已有的API文件,同步创建分组。 导入CSE微服务 导入微服务引擎(Cloud Service Engine,简称CSE)的微服务,提供API注册开放CSE服务能力。具体步骤请参见通过CSE微服务导入API。 导入CCE工作负载 导入云容器引擎(Cloud Container