检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
基本概念 API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。
如何获取API调用凭据?
仅在API安全认证方式为“APP认证”时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 也可以参考绑定API,将API授权给凭据,与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API中心服务页面。
获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页,避免一次查询获取的资源数量过多。 不支持分页查询,则服务应该要设置一个显示条数的默认值,避免一次返回过多资源。默认返回数量需要在接口参考中对外说明,避免调用者以为查询出了全量信息。
HTTP的头信息不超出以下范围: Accept Accept-Language Content-Language Last-Event-ID Content-Type:取值范围:application/x-www-form-urlencoded、multipart/form-data
使用前必读 API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。本文将详细介绍API中心服务的基本功能以及操作步骤。
某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。
403 APIC.0304 The app is not authorized to access the API. 检查APP是否授权访问API。 401 APIC.0305 Incorrect authentication information. 检查认证信息是否正确。
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
支持简易认证 仅当“安全认证”选择“APP认证”时可配置。 简易认证指APP认证方式下调用API时,在HTTPS请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。
HMAC:填写APP认证所使用密钥对的Secret。 Basic Auth:填写basic认证所使用的密码。 Aes:填写Aes认证所使用的向量。 Public Key:填写Public Key认证所使用的私钥。 确认Secret 填写与“Secret”一致的值。
通过汇聚丰富的行业能力API,帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心覆盖了API生产、API开放、API消费全场景,一站式体验。 本文档为您提供生产API、开放API、消费API的操作指导。
应用流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了应用流量限制时,返回此参数 X-Apig-RateLimit-ip 源IP流量限制信息 示例:remain:9,limit
API中心主要是作为API汇聚和运营API的平台,支撑API开发者和应用开发者更高效便捷的开放和使用API。API相关的技术支持等服务,由API提供方即API服务商负责。 父主题: API售卖与技术支持
如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前获取SSL证书的内容和密钥,并创建SSL证书。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击分组名称。 单击“分组信息”页签。
表3 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。
API消费快速匹配 支持智能搜索和推荐,缩短应用开发者和API资产的触达路径,帮助应用开发者快速找到所需API。 支持在线调测,快速试用和体验API。 与华为云集成工作台对接集成,支持API快速生成连接器,并用于SaaS开发和集成。
特殊应用 每个流控策略最多可以创建30个特殊应用。 特殊租户 每个流控策略最多可以创建30个特殊租户。 子域名访问次数 每个子域名每天最多可以访问1000次。 调用请求包的大小 API每次最大可以调用12M的请求包。
公测 API门户 2022年12月 序号 功能名称 功能描述 阶段 相关文档 1 API中心全新公测上线 API中心是华为云为API开发者和应用开发者构建的海量API汇聚运营平台。帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。
优化如下章节: 什么是API中心 应用场景 产品功能 与其他服务的关系 2023-03-22 第四次正式发布。 优化如下章节: 产品功能 2023-03-03 第三次正式发布。 优化如下章节: 产品功能 2023-02-10 第二次正式发布。