HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
DDoS防护接入配置
针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大...您的API由于受到黑客DDoS攻击而导致被API网关限制的请求，不会被计入API网关SLA的错误率统计。您可以购买阿里云的DDoS高防产品配合API网关使用，避免因为DDoS攻击导致的业务中断。
后端服务调不通
请保证安全组可以被API网关的出口IP段访问。需要强调，API网关访问外部的出口IP不能保证不会变动，通过设置安全组来判断请求来源的方法可能会由于API网关出口IP变化而导致API网关访问后端服务失败，因此我们不建议使用安全组方法。API网关...
API调试及自助排错
当请求被API网关拦截时，API网关会返回相应的 错误信息，并附有简单的 错误原因说明（X-Ca-Error-Message），可以根据该部分内容排查错误原因。更多错误码解释请参考 错误代码表。2.1.2.后端服务报错 当本次调用的 HTTP状态码 不为200，且 ...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
D504CO错误码排查
请保证安全组可以被API网关的出口IP段访问。排查后端服务是否有黑白名单、后端服务应用程序是否启动、及防火墙是否有拦截；若后端是VPC类型，链路涉及到跨Region或是通过云企业网访问的IDC机房，则需要配置回程路由，文档可以参考 访问...
功能概览
请求转发 支持参数清洗，包括参数类型、参数值（范围、枚举、正则）校验，无效校验会被 API 网关直接拒绝；支持参数映射，实现前端、后端请求信息映射；安全防护支持多种认证方式 支持 HMAC(SHA-1，SHA-256)算法签名；支持HTTPS双向认证、...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
ModifyVpcAccessAndUpdateApis-修改VPC授权信息，并且...
VpcName Token string 否 口令 c20d86c4-1eb3-4d0b-afe9-c586df1e2136 NeedBatchWork boolean 否~是否需要刷新关联的 API，警告 如果您的 VPC 授权需要更新，并且该授权被 API 关联并已经发布上线，需要配置为 true，否则您的 API 的后端...
参数映射与校验规则
入参映射（过滤未知参数）模式：API网关会根据用户配置的所有参数执行校验与映射，如果客户端传递了未在配置中的参数，参数将会被API网关过滤掉，不会转发给后端，详细请参考 章节4。入参映射（透传未知参数）模式：在此模式下，如果用户...
专享实例集群
专享实例的配置如 IPv6入口能力，IPv6出访能力，是否允许被API网关自身调用 不同时，无法将实例添加到集群中；专享实例的配置如 HTTPS安全策略，入访VPC，IPv6 访问控制，IPv4 访问控制，自定义内网网段 不同时，专享实例的配置会被集群的...
VPC融合专享实例
如果您的其他服务在其他网段中，需要被API网关访问，可以手动添加。步骤如下：登录API网关控制台，左侧导航栏选择 实例，进入实例列表；找到要操作的VPC融合类型专享实例，单击 VPC可被访问网段 的 新增；添加网段支持两种方式：按列表选择...
创建服务项目
绑定应用或者被组合API引用时，拦截不允许发布：API绑定应用或者被组合API引用时，不允许新版本发布到线上，保证下游应用和组合API的正常调用。适用于使用范围广，影响面大的重要API，如果变更发布到线上会严重影响下游时可以拦截。被组合...
IP访问控制插件
黑名单：您可以配置 IP 黑名单，黑名单中 IP 的访问将被 API 网关拒绝。重要 IP访问控制插件仅支持Ipv4地址，不支持Ipv6地址。2.插件配置 可以选择JSON或者YAML格式的来配置您的插件，两种格式的schema相同，可以搜索 yaml to json 转换...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
API基础定义是什么
可以配置您 API 被访问的方式，包含：http 或 https ，以及使用 HTTP 方法，目前网关支持所有标准的 HTTP 方法。
产品使用是怎么收费的？
按 API 被调用的次数、使用的流量及指定的缓存大小收费，公测期间免费。
断路器插件
1.断路器概述 断路器是API网关在后端出现性能问题时保护系统的内置机制，默认配置下，当某个API的后端在30秒钟内出现1000次超时，系统会触发断路器保护，断路器进入打开状态，断路时间为90秒，90秒内所有的请求均快速返回Status=503,X-Ca-...
上线API
API上线后，才能使API被调用。数据服务API的上线方式相似，本文以数据服务API上线为例介绍如何上线API。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 操作步骤 登录企业...
上线API
API上线后，才能使API被调用。数据服务API、数据上报API、三方API、空间服务API 的上线方式相似，本文以数据服务API上线为例介绍如何上线API。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式...
操作流程
服务封装流程及说明 流程图 流程说明 流程 说明 创建应用 对API的应用管理，按应用获取密钥和访问域名信息供外部调用已获得授权API。创建工作组 创建工作组，达到各工作组之间空间隔离的效果。添加云计算资源 添加需要的云计算资源类型。...
操作流程
服务封装流程及说明 流程图 流程说明 流程 说明 创建应用 对API的应用管理，按应用获取密钥和访问域名信息供外部调用已获得授权API。创建工作组 创建工作组，达到各工作组之间空间隔离的效果。添加云计算资源 添加需要的云计算资源类型。...
API调用统计
API调用统计功能可以统计API被调用的详细信息，包括 开放API 和 数据服务 API。该功能仅对组织管理员可见。功能入口 您可以按照图示步骤进入API调用统计页面。API调用统计 在 API调用统计 页面，您可以查看 开放API 或 数据服务 API的 今日...
授权API
在API发布后，您可以将API授权给他人，或获取他人已授权的API，以实现数据共享。本文为您介绍如何对API进行授权及不同场景下API的授权方案。前提条件 仅支持对已发布的API进行下线、授权和变更协议等操作，详情请参见 发布API。进入API管理...
数据服务概述
数据服务与API网关（API Gateway）完全集成，支持您将数据服务快速发布到API网关，从而使用API网关提供的API权限管控、IP白名单控制、流量控制、计量计费、SDK下载等全面的API服务。因此在使用数据服务前，请先开通 API网关。更多API网关...
管理 CORS 规则
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量治理、CORS、授权对象、API 调试 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
DeployApi-发布 API
接口说明 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
导致域名交易账号被冻结的情况
未按平台要求关闭“60天内禁止转出阿里云”设置 根据ICANN域名转移政策要求，为了确保域名交易的顺利进行，所有卖家需同意关闭转出阿里云限制，否则不能使用域名交易功能。可通过 阿里云控制台 的 我是卖家>我要卖域名 菜单，按照页面上...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
产品续费到期暂停时间、删除时间
按量付费，无服务期限限制，用户欠费后其 API 会被锁定，不允许被调用，但不影响管理和维护 API 操作，当欠费 6 个月，阿里云有权删除 API 配置信息；公测期间免费，无此限制。
后端路由
可以使用$CaAppId 形式来引用当前请求的系统参数，系统参数不需要API中被定义即可引用，但如果您在API中定义了重名的参数，取到的值会被自定义参数覆盖，可用于路由插件的系统参数列表如下：CaStage:当前API请求的环境，RELEASE,PRE,TEST ...
查看及管理API
说明 若API已被应用绑定或被组合API引用时，新版本发布到线上会影响API的调用，会根据API所属项目配置的发布管控机制，判断是否允许新版本发布到线上。版本管理：若下游应用调用API的API_ID无法修改，在API的数据源或查询条件发生变更后，...
TCP连接超时时间配置
确保后端应答返回的时候TCP连接没有被关闭。警告 如果不按照这个原则进行配置，那么在用户后端服务延时较大的情况下，客户端会在API网关返回应答前提前关闭TCP连接，导致API网关在应答的时候找不到可用的TCP连接报N502RE的错误，严重的时候...
- 产品推荐
- 这些文档可能帮助您