帮你捋顺 API 网关的 API、SDK和错误排查

简介: 整理一下 API 网关资源和错误排查方法,让用户快速定位问题。

API 网关的特殊之处

  用户使用 API 网关开放 API 服务,或者调用其他人开放的 API 服务。而且 API 网关自身也开放了管理接口 API。所以用户使用时需要弄清楚两套 API、两套 SDK、两套错误码。这里把这些资源整理一下,方便大家正确使用和问题排查。

开发资源List

  APIs

  •   用户在 API 网关开放的 API 服务,如天气查询 API等
  •   API 网关开放的管理接口,用于使用产品,如创建 API等

  SDKs

  •   API 网关为天气查询等用户开放的 API 服务提供的 SDK 样例
  •   API 网关为自身管理接口提供的 SDK

  错误码

  •   用户请求其他用户开放的 API 时产生的报错,如未授权、被流控、购买次数已用完等
  •   用户请求 API 网关管理接口时产生的报错,如AccessKeyId错误、时间戳格式不对等

请求用户开放的 API 服务接口

  场景一般为用户开放 API 进行自测,或者用户要使用其他用户开放的 API 服务。如天气查询 API、人脸识别 API等。
  目前对此类 API 请求的 SDK 支持有6种语言的 SDK 示例和2种移动端语言的 SDK。可以在 API 网关控制台 SDK下载页面获取。位置如图:

3a0a534642c6008e11e71db3937e393a10df6bb3
  
  页面同时给出了两种移动端 SDK 的使用手册。
  请求 API 获得返回结果时要注意获取一下返回结果的 Header 部分,有时候可能需要抓一下包,很多用户打印出的返回结果都只是 Body 部分。如果请求没有成功,关键的错误信息就在返回结果的 Header 里,其中 X-Ca开头的字段为 API 网关返回的信息。
  X-Ca-Request-Id 为请求唯一 ID,用户可以提供这个信息给客服/技术支持人员,方便搜索日志。建议用户后端也记录一下这个值,便于联调排查。X-Ca-Error-Message 为具体错误信息,如Quota Exhausted、Invalid Url、Invalid Signature等,基本看错误码可以知道错误原因,若不确定,可千万 错误码表查询。针对出现率较高的错误,API 网关还提供了详细的排查说明, 点此查看。请关注 API 网关的帮助文档中心。

请求 API 网关开放的管理接口 API

  用户使用 API 接口代替控制台的操作,接口均为管理类接口,如CreateApiGroup、CreateApi等,详见 API 概览表
  目前 API 网关为这些 API 提供了 Java 语言的 SDK,与其他产品的 SDK 是统一规范,请在官网 Java SDK 页面获取。
  API 请求失败返回的错误信息在 Body 里,有errorcode和errormessage两个字段。errorcode为错误说明短语,errormessage为一段详细描述及建议。此类错误同样可以在 错误码表查询。

祝使用顺利~ 有疑问请加用户交流旺旺群:1640106170

目录
相关文章
|
1月前
|
API
阿里云微服务引擎及 API 网关 2024 年 2 月产品动态
阿里云微服务引擎及 API 网关 2024 年 2 月产品动态
|
2月前
|
Prometheus 网络协议 JavaScript
api 网关 kong 数据库记录请求响应报文
Kong的tcp-log-with-body插件是一个高效的工具,它能够转发Kong处理的请求和响应。这个插件非常适用于需要详细记录API请求和响应信息的情景,尤其是在调试和排查问题时。
44 0
api 网关 kong 数据库记录请求响应报文
|
2月前
|
Java API 开发工具
支付与银行业线上客户协议应用中的DocuSign集成方式选择——SDK和API
跨境支付公司和Docusign进行集成时,碰到问题时的解决方案。分别用SDK和API集成后的各自使用体验。
42 2
支付与银行业线上客户协议应用中的DocuSign集成方式选择——SDK和API
|
2月前
|
监控 应用服务中间件 API
API 网关的功能用途及实现方式
API 网关的功能用途及实现方式
|
3天前
|
API
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态。
|
1月前
|
运维 Cloud Native 应用服务中间件
阿里云微服务引擎 MSE 及 API 网关 2024 年 02 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要。
|
2月前
|
Web App开发 前端开发 JavaScript
如何快速与呼叫中心系统CTI/API/SDK接口集成
由于呼叫中心系统涉及通信、CTI、终端设备、中继线路等技术与概念,从事信息管理系统、ERP、CRM、工单系统等的研发人员一般不是非常熟悉这部分技术,当需要提供具备呼叫中心能力的解决方案时,往往要用较多的时间来研究这些相对复杂的技术,对接过程比较长,开发调试有一定的阻力,基于此,我们提出一种更加简便高效的集成方法,可以零代码集成呼叫中心平台,实现项目快速上线。
如何快速与呼叫中心系统CTI/API/SDK接口集成
|
3月前
|
人工智能 监控 安全
百万并发,API 网关抗住了亚运会流量高峰
本文主要介绍作为亚运会所有核心流量的入口,阿里云推出了一款百万并发规格的 API 网关,抗住了亚运会流量高峰,为亚运会提供强大的技术支持。
|
3月前
|
存储 API 开发工具
如何使用Python SDK与OpenAI Assistants API构建助手?
在这篇文章中,我们将介绍如何使用Python SDK构建最基本的Assistant,你只需要在代码中添加你自己的OpenAI API密钥即可。
111 0
|
4月前
|
缓存 JavaScript Java
使用 API 网关
使用 API 网关
58 0