检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
新增网关响应 操作场景 网关响应,指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
导入CCE工作负载 API网关支持导入云容器引擎(Cloud Container Engine,简称CCE)工作负载,提供API注册开放CCE服务能力。 如果当前实例不支持“导入CCE工作负载”,请联系客服。 注意事项 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。
HTTP状态码 常用状态码表如表1所示。 表1 HTTP请求状态返回码 返回值 说明 200 OK 处理正常。 204 No Content 无返回内容。 400 Bad Request 服务器未能处理请求。可能原因: 语义有误,当前请求无法被服务器解析; 请求参数有误。 401
Android 操作场景 使用Android语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 已安装Android Studio 4.1.2或以上版本,如果未安装,请至Android
Go 操作场景 使用Go语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考调用API示例调用API。 本章节以IntelliJ IDEA 2022.2.1版本为例介绍。 前提条件 已获取API的调用信息,具体参见认证前准备。 已安装Go安装包1.14或以上版
为简易认证绑定AppCode 简易认证指调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认证,且开启
为简易认证添加AppCode 操作场景 简易认证指调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填应用详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认
删除环境 操作场景 已创建的环境不再提供服务,可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 在待删除的环境所在行,单击“删除”,弹出对话框。 仅在环境未被API发布时,支持删除。 单击“确定”,完成环境管理信息。
查询专享版实例列表 功能介绍 查询专享版实例列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
PHP 操作场景 使用PHP语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 已获取API的调用信息,具体参见认证前准备。 已安装IntelliJ IDEA
x-apigateway-access-controls.policy 含义:访问控制策略定义。 作用域:x-apigateway-access-controls 示例: x-apigateway-access-controls: customAccessControlName:
更新专享版实例 功能介绍 更新专享版实例 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
删除自定义认证 操作场景 当自定义的认证已不再需要时,可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API
包年/包月 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买专享版API网关并获得一定程度的价格优惠。下面介绍包年/包月API网关的计费规则。 适用场景 包年/包月计费模式需要用户预先支付一定时长的费用
克隆API API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请创建API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
创建访问控制策略 操作场景 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。
怎样保证API网关调用后端服务器的安全? 通过以下方法确保API网关调用后端服务器的安全: 为API绑定签名密钥。 在绑定签名密钥后,API网关到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与API网关的签名信息是否一致。 使用HTTPS对请求进行加密。
APIG使用流程 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关的开放API和调用API功能,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放。 开放API 企业或开发者通过API网关开放自身的服务与数据。
C# 操作场景 使用C#语言调用APP认证的API时,您需要先获取SDK,然后打开SDK包中的工程文件,最后参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 已安装Visual Studio 2019 version 16.8.4或以上版本,如果未安装,请至Visual
查询APP列表 功能介绍 查询APP列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps[?page_size, page_no, id, name, app_key