检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。 API的真实后端服务目前支持三种类
后端服务地址(可选) 仅在不使用负载通道时,需要设置。 填写鉴权服务的访问地址,格式:“主机:端口”。主机为鉴权服务的访问IP地址/域名,未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。 目前仅支持IPv4地址。 路径 鉴权服务的路径,即服务的url。
址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 签名密钥 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 调试API 验证API服务的功能是否正常可用。 发布API 把API发布到环境中,API只有在发布到环境后,才支持被调用。
Administrator API网关服务的管理员权限。拥有该权限的用户可以使用API网关服务的所有功能。 系统角色 如果在操作过程中涉及其他服务资源的创建、删除、变更等,则还需要在同项目中勾选对应服务的Administrator权限。 APIG FullAccess API网关服务所有权限。拥有该权
身份认证与访问控制 身份认证 服务认证:APIG提供AKSK、Token等多种方式进行服务认证,只允许授权的访问。 自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。
审计与日志 审计 云审计服务(Cloud Trace Service,CTS),是华为云安全解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务后,系统将开始记录APIG
热门咨询 开放API API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? API可以绑定内网域名吗? 调用API 调用API失败的可能原因 调用API报“The API does not exist or has not been published
时,默认开启客户端认证即双向认证;反之,开启单向认证。 单向认证:客户端与服务端连接时,客户端需要校验服务端SSl证书合法性。 双向认证:客户端与服务端连接时,除了客户端需要校验服务端SSl证书合法性,服务端也需要校验客户端SSl证书合法性。 父主题: 配置APIG专享版与客户端间的单向认证或双向认证
删除自定义认证 操作场景 当自定义的认证已不再需要时,可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API
x-apigateway-plugins 含义:API网关定义的API插件服务。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-plugins:
删除环境 操作场景 已创建的环境不再提供服务,可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 在待删除的环境所在行,单击“删除”,弹出对话框。 仅在环境未被API发布时,支持删除。 单击“确定”,完成环境管理信息。
x-apigateway-backend.httpEndpoints 含义:API网关定义的HTTP类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
x-apigateway-backend.functionEndpoints 含义:API网关定义的FUNCTION类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
x-apigateway-backend.mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买API分组信息页面。
type" 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-backend 是 String API后端服务定义。 type 是 String 后端服务类型,支持HTTP、HTTP-VPC、FUNCTION、MOCK。 parameters 否 x-apigateway-backend
x-apigateway-backend.httpVpcEndpoints 含义:API网关定义的HTTP VPC类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考网关响应。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。 父主题: 开放API
配置APIG的监控告警 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
API网关服务的管理员权限。拥有该权限的用户可以使用专享版和共享版API网关服务的所有功能。 系统角色 如果在操作过程中涉及其他服务资源的创建、删除、变更等,则还需要在同项目中勾选对应服务的Administrator权限。 APIG FullAccess API网关服务所有权限。