API使用规范

API 本规范中“API”指:阿里云向您提供的应用程序编程接口(Application Programming Interface,简称API),您编程后通过该应用程序编程接口,可获取阿里云提供的弹性计算服务(ECS)、关系数据库服务(RDS)和对象存储服务(OSS)等阿里...

API使用规范

定义 1.1 API:指应用程序编程接口(Application Programming Interface),是指一些预先定义的函数,目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力,且用户无需访问源码,或理解内部工作机制的细节。1.2 云解析DNS...

HTTP API 概览

TSDB 提供了一个基于 HTTP 的应用程序编程接口,以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问,比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的,同时也提供了替代访问策略,因为...

路径匹配规则

不可避免的,多个 API 之间会出现冲突。比如/hello 和/{id} 这两个 API 当遇到路径为/hello 的请求时,就会冲突。针对这种冲突情况,API 网关会遵循 最长路径优先 规则。当路径长度相同时,继而遵循 绝对匹配>参数匹配>前缀匹配 的规则。...

基础术语

中文 释义 API 应用程序编程接口,是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组,同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识,用于定位在访问的 API。...

VPC授权连通性测试

VPC授权连通性测试用于验证API网关实例到您授权的VPC中实例的网络连通性,有助于将API调试阶段由于网络连通问题引发的调用失败提前暴露。本文将重点介绍VPC授权连通性测试功能,以及如何根据排错引导解决连通性测试失败的情况。1.概述 VPC...

使用前后端链路追踪诊断API错误原因

重要 配置 enableApiCors 为 true,后端服务也需要支持跨域请求及自定义header值,请确认所有请求都配合联调正常,否则会出现请求失败的问题。Nginx配置参考如下:upstream test { server 192.168.220.123:9099;server 192.168.220.123:...

为什么ZooKeeper客户端出现APIError?

本文介绍使用MSE ZooKeeper时,客户端出现APIError报错的问题现象、问题原因和解决方案。问题现象 ZooKeeper客户端出现APIError报错,如下所示:Exception in thread"xxx"org.apache.zookeeper.KeeperException$APIErrorException:...

简介

API 应用程序编程接口 用户开放API,在API网关录入API,以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API,首先需要创建API分组 每个API分组拥有一个二级域名,两个Stage 用户需要将已经备案且解析至...

API调试及自助排错

请求唯一ID,请求一旦进入API网关应用后,API网关就生成请求ID并通过响应头返回给客户端,建议客户端与后端服务都记录此请求ID,可用于问题排查与跟踪。X-Ca-Error-Message。API网关返回的错误消息,当请求出现错误时API网关通过响应头...

阿里云OpenAPI

API应用程序编程接口)是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务,使开发者更容易地实现连接两个应用程序之间的功能,也使开发人员可以更轻松地开发和扩展应用程序。Open...

如何处理查询API额度已用尽或即将用尽问题

问题原因 以下使用场景消耗查询监控数据API调用次数的额度:使用应用实时监控服务ARMS服务(Prometheus实例for云服务)。直接调用API。调用 DescribeMetricLast、DescribeMetricList、DescribeMetricData 和 DescribeMetricTop 接口的...

基于JWT的token认证

阿里云API网关在Json Web Token(JWT)这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制,满足用户个性化安全设置的需求。一、基于token的认证 1.1 简介 很多对外开放的API需要识别请求者的身份,并据此判断所...

返回值为空

其中较主要的为下面的几个信息:X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID,请求一旦进入API网关应用后,API网关就生成请求ID并通过响应头返回给客户端,建议客户端与后端服务都记录此请求ID,可用于问题排查与...

数据服务概述

相关概念 API(Application Programming Interface,应用程序编程接口):API是让应用、软件、系统能够面向数据源进行数据交互的接口,数据服务API支持“读数据”的操作,可以从数据库、数据表中不断地进行数据查询。函数:作为API过滤器,...

通过云控制API实现资源管理

云控制API出现可以有效的解决这个问题,客户可以通过云控制API访问云上所有的产品和资源类型,而无需熟悉底层云产品的API,免去开发者学习上百个产品、上万个OpenAPI的差异化成本;让开发者无需维护多套SDK、学习多个产品的OpenAPI。在极...

函数计算内网访问API网关

1 概述 API网关即能够和函数计算集成,构建起serverless架构,同时在实际场景中,也会出现在函数中需要调用API网关上发布的API,同时很多时候出于安全考虑,往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式:在同一...

同步 API

同步 API 可将当前环境中的 API 同步至其他环境中。为保证系统稳定性,只同步目标环境不存在的 API 配置。同步后,会自动加载配置使其生效。...在 基础信息 栏,选择要从当前环境...结果 同步成功后,当前页面上方会出现提示,显示同步的结果。

客户端调用API示例

响应头:X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF#请求唯一 ID,请求一旦进入 API 网关应用后,API 网关就生成请求 ID 并通过响应头返回给客户端,建议客户端与后端服务都记录此请求 ID,可用于问题排查与跟踪。...

如何获取错误信息

其中 X-Ca开头的均为网关返回,比较重要信息是:/请求唯一ID,请求一旦进入API网关应用后,API网关就生成请求ID并通过响应头返回给客户端,建议客户端与后端服务都记录此请求ID,可用于问题排查与跟踪 X-Ca-Request-Id:7AD052CB-EE8B-4...

发送 HTTP 请求(Java)

填写入参,他是一个object可以将实体类作为参数传进来,若想使用query方式传参需要将参数拼接至gatewayUrl 注意:若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直,否则会出现序列化失败或者找不到接口的情况,参数字段为...

专享实例集群

在添加专享实例到集群之后,如果集群的出口地址有新增,请注意将新增的出口地址添加到您后端服务的白名单中,避免出现配置后访问不通的问题;在添加或移除专享实例时,集群下API分组的域名添加或解除DNS解析,解析配置的TTL为60秒。

注册API

请求Body定义 仅请求方式为 POST 和 PUT 时,会出现该参数。请求Body定义支持输入JSON和XML类型的Body描述,相当于一个请求Body的示例,以供API调用者参考格式。在 返回内容定义 区域,输入 正常返回结果示例 和 异常返回结果示例,以便API...

错误反馈

解决方法:如果您业务场景的图片中文字比较多,建议您调用异步OCR图文识别接口(异步检测),系统增加重试次数并执行更多优化处理,将不会出现超时问题。为什么调用API时返回错误码592(DOWNLOAD_TIMEOUT)?报错原因:表示下载超时。...

阿里云SDK

阿里云OpenAPI提供多种编程语言和开发框架的SDK,方便开发者快速构建与阿里云相关的应用程序(包括Java、Python、Node.js、Go等语言)。如果您还不了解什么是OpenAPI,请参见 什么是OpenAPI?阿里云SDK的分类 云产品提供的用于使用OpenAPI...

创建及管理API标签

如果您输入的标签名称在当前工作空间的标签列表内不存在,则在下拉列表中会出现 Add<标签名称>,单击 Add<标签名称>即可为当前API成功添加该标签。配置其它参数后,单击 确认,则所有配置生效,新增的标签会显示在当前工作空间的标签列表。...

错误码映射插件

API网关的系统错误码会出现在 X-Ca-Error-Code 应答头及日志的 errorCode 字段中,这个值不会被 错误码映射插件 改写。日志中的 statusCode 字段记录的是网关递送给客户端的应答码的值,会被 错误码映射插件 改写。4.配置示例 4.1.映射包体...

断路器插件

1.断路器概述 断路器是API网关在后端出现性能问题时保护系统的内置机制,默认配置下,当某个API的后端在30秒钟内出现1000次超时,系统触发断路器保护,断路器进入打开状态,断路时间为90秒,90秒内所有的请求均快速返回Status=503,X-Ca-...

D504CO错误码排查

排查后端服务是否有黑白名单、后端服务应用程序是否启动、及防火墙是否有拦截;若后端是VPC类型,链路涉及到跨Region或是通过云企业网访问的IDC机房,则需要配置回程路由,文档可以参考 访问云服务。2、Backend service connect failed `...

API调用返回20004 错误码

1.问题背景 API 调用可能报“调用后端服务时发生异常”的错误;这类错误可以通过表面意思来解读;但除了API 依赖后台服务真出现异常,还包括了一种常见的错误,就是入参类型不匹配(cause:argument type mismatch)2.问题现象 response:{...

API错误中心

您可以在API错误中心查询使用API过程中出现的错误码,从而排查和尝试解决问题。请访问 错误中心 查看详细的错误码说明。icmsDocProps={'productMethod':'created','language':'zh-CN',};

异常排查

本文为您介绍调用 OpenAPI 出现异常返回时,如何定位问题。使用问题诊断 OpenAPI 门户 提供接口调用异常的问题诊断功能。当您在调用 OpenAPI 出现报错时,可将错误码粘贴到输入框中,点击诊断按钮,查看诊断结果和修复建议。使用示例:在...

VPC融合专享实例

适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例,重点对API网关和您的VPC之间的网络架构进行了优化,适用场景:API网关需要访问同一VPC内的多个资源(如ECS、SLB),即托管在网关上的API,其后端服务是同一VPC下的多个...

使用SDK调用API请求服务端时出现Wait future timeout...

另外,当机器的负载较高、网络异常率高、CPU使用率高时,也会出现Wait future timeout错误,一般是请求可能还未发出就已超时。确认客户端中是否在请求期间主动调用了 client.shutdown()方法导致callBack回调线程被关闭。登录 表格存储控制...

告警规则指标说明

如果Full GC耗时过长,可能导致应用程序出现明显的停顿,从而影响用户体验。JVM YoungGC次数(瞬时值)无 是 最近N分钟JVM执行Young GC(Young Generation Garbage Collection)的次数。Young GC次数的瞬时值可以反映出当前JVM中对象的...

如何配置出访连接池告警

若购买的专享实例规格为api.s1.small,最大出访连接池大小为1200,如果后端服务每个请求的应答时间在1秒时,那么这个实例最大支持的出访RPS是1200,超过1200后,如果请求进入API网关,后端连接池被占满,API网关让请求进入一个等待队列,...

自定义 JSAPI

JavaScript API(JSAPI)是为 H5 应用提供原生能力的接口,您可以利用这些接口使用更多的原生能力和操控能力,提高 H5 应用的用户体验。H5 容器组件提供以下能力:丰富的内置 JSAPI,实现例如页面 push、pop、标题设置等功能。更多信息查看...

HTTPS 证书报错

证书不合法 API 提供者使用的证书其他非主流机构颁发的证书,此类证书使用浏览器访问是没有问题的,因为浏览器自动更新根证书。但老版本操作系统的根证书对这些机构(证书颁发机构)的不信任或者信任时间已经过期。解决方案 升级客户端根...

批量操作API

注意事项 批量修改API基础配置后,可一键发布API,发布API功能对已经发布到环境上的API再次发布以更新环境上的API数据,没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用(APP)。...

API 调用返回400 错误码

否则调用API 提示400 ​ 3.2 查看API 入参是否准确 现在遇到最常见的API 调用返回400 错误码是因为入参不准确,常见错误如下:字段类型不匹配:比如Integer 字段,别复制String 类型 API 版本:version 不正确 必须字段忘记设置或者设置...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 风险识别 视觉智能开放平台 短信服务 对象存储 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用