检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
管理APIG实例 查看或编辑APIG实例信息 配置APIG实例参数 配置APIG实例标签 配置APIG的终端节点信息 自定义APIG的客户端访问端口 变更APIG的实例规格
创建APIG实例 本小节指导您顺利创建实例,实例创建完成后,才能创建API并对外提供服务。 约束与限制 实例配额 同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例,可提交工单,申请修改配额。 用户权限 如果您使用系统角色相关权限,需要同时拥有“APIG Administrator
导入导出API 导入API失败有哪些原因? 使用Swagger文件导入API时是否有模板?
监控安全风险 云监控服务为用户的云上资源提供了立体化监控平台。通过云监控您可以全面了解云上的资源使用情况、业务的运行状况,并及时收到异常告警做出反应,保证业务顺畅运行。 APIG提供基于云监控服务CES的资源和操作监控能力,帮助用户日常监控API网关的运行状态,可以通过控制台直观的查看
责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击,华为云在遵从法律法规业界标准的基础上,以安全生态圈为护城河,依托华为独有的软硬件优势,构建面向不同区域和行业的完善云服务安全保障体系。 与传统的本地数据中心相比
HTTP状态码 常用状态码表如表1所示。 表1 HTTP请求状态返回码 返回值 说明 200 OK 处理正常。 204 No Content 无返回内容。 400 Bad Request 服务器未能处理请求。可能原因: 语义有误,当前请求无法被服务器解析; 请求参数有误。 401
使用场景 API网关主要涉及以下几个开发场景: API调用认证开发:API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。 使用APP认证(签名认证)调用API:API调用者通过API网关提供Key、Secret和SDK,对API
开放API流程 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之
创建API 通过APIG创建REST API 通过APIG创建GRPC API 父主题: 开放API
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
管理API概述 API创建完成后,您还可以进行以下相关操作管理API。 查看或编辑APIG的API信息:您可以通过查看API的基本信息来确认API的调用信息,通过编辑API的基本信息来更改服务信息。 配置API的自定义认证:您可以通过自定义认证来自定义认证系统。 配置API的参数编排规则
授权项变更公告 公告说明 自2024年9月起,当用户使用以下API的自定义策略授权时,用户需创建或更新自定义策略才可访问。 权限描述 对应的API 新增授权项 依赖授权项 IAM项目(Project) 企业项目(Enterprise Project) 获取SSL证书列表 GET /
漏洞修复策略 API网关漏洞修复周期 SDK漏洞: 针对APIG提供的SDK所涉及的漏洞会根据风险等级在修复时间内对外发布修复版本,由客户自行升级SDK版本进行修复。 其他漏洞: 按照版本正常升级流程解决。 修复声明 为了防止客户遭遇不当风险,除漏洞背景信息、漏洞详情、漏洞原理分析
按需计费 适用场景 按需计费适用于短期使用、实例无需7x24小时运行等场景。 适用计费项 表1 按需计费适用计费项 计费项 说明 版本(实例规格) API网关提供的实例版本有:基础版、专业版、企业版、铂金版等,您可以根据实际业务需要按需使用。实例版本说明,请参考产品规格。如果您当前使用的实例版本不能满足需要
快速开放并调用API 本章节将为您介绍如何快速使用API网关,这里以APP认证类型的简易认证为例,快速开放并调用API。简易认证仅支持HTTPS或GRPCS方式调用API。 图1 APIG使用流程 准备工作 在使用APIG之前,需要确保有可用的网络环境,请提前准备VPC、子网和安全组
获取项目ID 调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权
分页显示查询结果 查询资源列表时(例如,查询API列表),系统支持分页显示查询结果。 在url后面拼接如下参数: page_size:每页查询多少条数据,如果不指定,默认20,最大值500。 page_no:需要查询的页码。 示例: GET /v1.0/apigw/apis?page_size
过滤查询结果 查询资源列表时(例如,查询API列表),系统支持按照查询对象的属性过滤查询结果。 示例: GET /v1.0/apigw/apis?id=xxxx 父主题: 附录
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 Token认证:通过Token认证调用请求