HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
数据服务
使用场景包括：最小粒度的数据输出：当企业需要对外提供数据时，相较于直接对外提供表数据，使用API的方式可以控制到行级（SQL过滤条件）和列级（查询字段），这样能帮助用户只对外暴露最小单元的数据，保障数据安全。可视化制作：对于多数...
操作流程
服务封装流程及说明 流程图 流程说明 流程 说明 创建应用 对API的应用管理，按应用获取密钥和访问域名信息供外部调用已获得授权API。创建工作组 创建工作组，达到各工作组之间空间隔离的效果。添加云计算资源 添加需要的云计算资源类型。...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
通过云控制API实现资源管理
为什么要用云控制API管理云资源 随着云计算服务业务越来越丰富，很多云厂商为客户提供的相关的API数量也多达上万个。而在云服务被集成过程中，客户/伙伴面对上万单点API往往无从下手。从“找到正确API”到“了解使用方式”再到“弄清楚上...
操作流程
服务封装流程及说明 流程图 流程说明 流程 说明 创建应用 对API的应用管理，按应用获取密钥和访问域名信息供外部调用已获得授权API。创建工作组 创建工作组，达到各工作组之间空间隔离的效果。添加云计算资源 添加需要的云计算资源类型。...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
新功能发布记录
可以用authResultPassThrough来配置发送给后端服务的参数映射 全部 第三方鉴权插件 流控插件支持固定窗口算法 API网关流控插件秒级别默认使用的是令牌桶流控算法，可以通过配置切换成固定时间窗口流控算法 全部 流量控制插件 2023-02 功能...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
管理与使用
本文介绍如何管理并使用预置指标API、产品数据API以及自定义服务API。前提条件 如果需要管理和使用预置指标API，需确保已创建产品和设备，并完成备份。具体操作，请参见 数据接入。如果管理和使用产品数据API或自定义服务API，需确保已创建...
Restful API
Elasticsearch官方参考文档 单文档API：Index API Get API Delete API Update API 多文档API：Multi Get API Bulk API Delete By Query API Update By Query API Reindex API 使用REST Client交互 客户端访问仅支持HTTP/TCP方式，建议您...
生成API概述
在脚本模式下，您可以自行编写API的查询SQL，支持多表关联、复杂查询和聚合函数等功能。本文为您介绍向导模式和脚本模式下API支持的功能。以下为 向导模式生成API 和 脚本模式生成API 的区别：功能分类 功能点 向导模式 脚本模式 查询对象 ...
通过脚本模式生成API
数据服务支持通过脚本模式或向导模式生成API，相对于向导模式，您可以自行编写API的查询SQL，支持多表关联、复杂查询和聚合函数等功能，满足您个性化查询需求。本文为您介绍如何通过脚本模式生成API。前提条件 配置API前，请先在 工作空间...
查看API操作日志
通过查看API操作日志，了解当前API的使用情况，数据服务API、数据上报API、三方API、空间服务API 查看API操作日志方式相似。本文以数据服务API为例介绍如何查看API操作日志。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导...
实例类型与选择指南
1.API网关实例类型 API网关实例指用于接入并处理您的API的一组资源，包含公网IP、内网IP、公网出口、负载均衡、服务器、存储等，API分组必须挂载在合法的实例下才能运行，目前API网关有如下的实例类型供您选择：1.1.实例类型说明 共享实例...
数据服务入门
步骤三：新建业务流程 数据服务基于业务流程实现以业务为单元的数据服务API开发，并通过业务流程对API及创建API所使用的函数等文件进行组织管理。因此，在数据服务创建API前，需先新建业务流程。步骤四：生成API 业务流程创建完成后，您可...
API版本说明
本文为您介绍API两个版本之间的关系和2020-09-07版本API的使用说明。API两个版本之间的关系 2020-09-07版本API新增合规包、修正设置、账号组、标签和集成服务功能。2020-09-07版本API可以覆盖2019-01-08版本API的所有功能（包括：资源、...
通过向导模式生成API
在API编辑页面的右侧导航栏中，单击 服务资源组，您可以在 资源组类型 区域配置API调用时使用的资源组类型。支持您选择 独享服务资源组 或 公共服务资源组，独享服务资源组 可以在列表中选择目标资源组名称。公共服务资源组 不可选择资源组...
创建服务项目
API发布管控 API发布到线上使用的过程中，有四种变更场景（新增必填请求参数；删减请求参数；删减返回参数；变更请求参数的数据类型），导致影响API以及关联的组合API的正常调用。因此，在API绑定应用或者被组合API引用后，API发布新版本到...
功能简介
已获授权API 对已获授权API通过API维护和应用维度进行查看，支持测试API、下载API使用文档、下载密钥SDK和归还权限，也支持查看单个API的授权详情，包括：授权人、授权时间、访问路径、AppKey和AppSecret等。已对外授权API 支持查看通过...
使用限制
本文描述了API网关的使用限制。限制项 限制描述 使用API网关服务的用户限制 用户需实名认证 用户创建API分组数量限制-每个账号下，每个Region的API分组（含绑定域名和未绑定域名的分组）的总数上限200个；每个账号下，每个Region默认最多...
TCP连接超时时间配置
概述 用户的客户端调用API网关的引擎，API网关的引擎调用用户的后端服务，目前都使用的是TCP连接，关于TCP连接，一些超时时间的配置会影响到整个通信过程，配置不合理会导致不同情形的问题，甚至导致故障。本文档站在API网关的角度对API...
跨域资源访问（CORS）
用逗号分隔 allowCredentials:true#是否允许Cookie maxAge:172800 说明 若使用API网关的公网二级域名调用API，仅线上环境支持跨域插件。因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
调用API商品
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
插件数据集
API网关为用户提供了功能强大、支持热更新插件体系，大量核心能力均被迁移到插件体系中，截止目前为止API网关已经为用户提供了12种插件。插件功能的上线极大丰富了API网关为用户提供服务的功能点，也很大程度提升了API网关元数据管理的灵活...
API网关灰度发布最佳实践
本文主要用于介绍在API后端服务版本迭代过程中，新版本服务正式发布前通过API网关进行灰度发布，A/B Test的通用方法实践。该方法的核心是通过配置后端路由插件来确保可以控制服务升级对用户造成的影响。一、概述 灰度发布是指在API的新、旧...
产品简介
云控制API（CloudControl API）是一款面向开发者的资源化API开发者工具。云控制API降低了开发者集成阿里云的学习和维护成本。并能够在云产品新特性发布时，通过简单新增资源属性即可完成新特性集成。产品优势 选择云控制API，您可以轻松...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
使用OpenAPI
本文为您介绍使用API网关OpenAPI的基本信息及注意事项。说明 关于如何使用阿里云OpenAPI，请参见学习文档：使用OpenAPI。基本信息 版本说明 版本号 说明 2016-07-14 推荐 接入点说明 参见 服务接入点。用户身份 用户身份 支持情况 阿里云...
API类商品使用
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
名词解释
使用API网关，您需要对以下名词有所了解。名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
跨域资源共享（CORS）
这意味着使用这些API的Web应用程序只能加载同一个域下的资源，除非使用CORS机制（Cross-Origin Resource Sharing 跨源资源共享）获取目标服务器的授权来解决这个问题。上图画的是典型的跨域场景，目前主流浏览器为了用户的安全，都会默认...
环境管理
目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的测试环境资源，从而可以保证在同一套API配置的情况下，供您的测试人员进行测试使用。在API网关上进行环境管理的时候，您需要做两部分工作：API的后...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
API参考
KMS提供了OpenAPI和实例API，请根据您的不同操作选择合适的API。操作类型 说明 管控类操作 例如管理密钥、凭据、标签、别名等资源，仅支持使用OpenAPI。接口列表，请参见 OpenAPI概览。业务类操作 密码运算操作：仅支持使用实例API。接口...
- 产品推荐
- 这些文档可能帮助您