HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
简介
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...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
AuthorizedApp
描述 节点名 AuthorizedApp 子节点 StageName String 环境名称，取值：RELEASE TEST AppId Long 编号，系统生成，全局唯一 AppName String 应用名称 Operator String 授权的人，取值：PROVIDER：API所有者 CONSUMER：API调用者 ...
AuthorizedApi
系统生成，全局唯一 GroupName String API分组名称 StageName String API环境，取值：RELEASE：线上 TEST：测试 Operator String 授权的人，取值：PROVIDER：API所有者 CONSUMER：API调用着 ApiId String 系统自动生成API唯一标识符 Api...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
RemoveApisAuthorities-撤销应用APP对多个API访问权限
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DescribeAuthorizedApps-查询可访问APP列表
PROVIDER：API 所有者 CONSUMER：API 调用者 PROVIDER 示例 正常返回示例 JSON 格式 {"PageNumber":1,"RequestId":"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62","PageSize":10,"TotalCount":2,"AuthorizedApps":{"AuthorizedApp":[{"AppName":...
DescribeApisByApp-根据应用查询API列表
ID 38bed48d664149e4b9b5ea576319673f Operator string 授权的人，取值：PROVIDER：API 所有者 CONSUMER：API 调用者 PROVIDER StageName string 环境名称 RELEASE CreatedTime string 授权时间 Sun,02 Jan 2022 16:00:00 GMT ApiName ...
根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回...取值：PROVIDER：API 所有者 CONSUMER：API 调用者 PROVIDER CreatedTime string 授权时间 Sun,02 Jan 2022 16:00:00 GMT ApiName string API 名称 sd2_h5_player_history_competition RegionId string 地区 ID ...
DescribeAuthorizedApis-查询已授权的API列表
接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
管理外部授权 API
绑定的 API：列出了该外部授权 API 绑定的所有 API 及其基本信息，包括 API 名称、API 分组、发布状态、前端协议类型、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。配置信息：...
API分组同步
说明 当前编辑版本指的是分组内所有API最新保存的API定义，无论这个API是否有发布。API差异对比。可以对比的指标如下：新增API：源分组中有，而目标分组没有的API；仅VPC后端信息不一致API：其他定义一致，仅VPC后端配置信息不一致的API；...
新功能发布记录
每次允许导入的API上限个数为100 全部 导入标准OAS定义 第三方鉴权插件支持获取请求的Path信息 支持将请求侧的Path作为参数传递给鉴权服务 全部 第三方鉴权插件 新增API的操作历史日志 API网关记录了API所有相关操作日志，包括：创建、编辑...
使用SDK调用API
2.使用SDK调用API 通过控制台下载的SDK，下载解压后的目录结构如图：SDK文件夹*sdk/{{regionId}}`JavaSDK文件夹，包含每个Group的所有API的接口调用代码`*HttpApiClient{{group}}.java `包含对应Group所有HTTP通道的API方法`*...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
共享实例
计费币种：人民币 有效调用次数：API网关收到的所有API请求，均为有效调用，会计入收费范围；每月（自然月）前一百万次API调用免费，当月超过部分按阶梯计费。2.公网出访流量费用 共享实例的公网出访流量费用的计费逻辑，与专享实例的公网...
HTTP自动跳转HTTPS
分组内的所有API定义的请求协议都已勾选HTTPS。操作步骤 登录 API网关控制台。左侧栏点击开放API，选择分组管理，找到目标分组，点击进入分组详情页。在分组详情页找到独立域名栏，开启指定域名的HTTP自动跳转HTTPS功能。点击确认，http的...
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
RemoveIpControlApis-解除API与IP访问控制的绑定
若不传入：默认解绑该分组该环境下的所有 API。指定要查询的 API 编号，支持输入多个，“,”分隔，最多支持 100 个 123 StageName string 是 指定要操作 API 的环境。RELEASE:线上 TEST:测试 TEST 返回参数 名称 类型 描述 示例值 object ...
API网关-监控服务关联角色
背景信息 API网关-监控服务关联角色（AliyunServiceRoleForApiGatewayMonitoring）是为了方便用户对同一分组上的所有API应用相同的报警配置时，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关通过服务...
RemoveTrafficControlApis-解除API与流控策略的绑定
若不传入：默认解绑该分组该环境下的所有 API。若输入多个，“,”分隔，最多支持 100 个 3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12 StageName string 是 指定要操作 API 的环境。RELEASE:线上 TEST:测试 TEST ...
API调用统计
API近90天调用统计 该图表可展示用户名下所有API近90天的调用情况，默认显示所有API的调用情况，也可通过筛选功能查看单个API的调用情况。API单日调用排行榜 该列表可展示 调用量TOP10、失败率TOP10、平均响应时间 三部分内容。单击API名称...
RemoveSignatureApis-解除API与后端签名密钥的绑定
若不传入：默认解绑该分组该环境下的所有 API。指定要查询的 API 编号，支持输入多个，“,”分隔，最多支持 100 个 123 StageName string 是 指定要操作 API 的环境。RELEASE:线上 TEST:测试 TEST 返回参数 名称 类型 描述 示例值 object ...
API概览
DescribeApiTrafficControls 查询API流控策略绑定概况 查询指定分组指定环境下所有API的流控策略绑定概况。DescribeApiTrafficData 查询API监控数据中流量统计数据 查询指定API监控数据中对流量的统计数据。DescribeInstanceDropPacket ...
跨域资源共享（CORS）
这意味着使用这些API的Web应用程序只能加载同一个域下的资源，除非使用CORS机制（Cross-Origin Resource Sharing 跨源资源共享）获取目标服务器的授权来解决这个问题。上图画的是典型的跨域场景，目前主流浏览器为了用户的安全，都会默认...
管理数据模型
绑定的 API：列出了绑定了该数据模型的所有 API 及其基本信息，包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...
应用场景
异构系统集成场景 统一集成 降低企业内部系统集成的成本，无缝连接不同的软件应用程序。遗留系统兼容 允许 IT 团队选择最适合技术栈，在转型过程中并且可以兼容遗留系统，加速企业转型升级。集中管理 IT 团队可以从更集中的位置访问所有...
为分组绑定插件
绑定到分组上的插件可以对分组下的所有API均生效，如果API也绑定了相同类型的插件，那么API绑定的插件具有更高的优先级。2.使用规则 一个分组只能绑定一个相同类型的插件。插件绑定到分组的指定环境后，插件策略会自动对该环境下已发布的...
管理 CORS 规则
说明 当前环境级别规则：如果开启环境级别规则，则对所有 API 生效。但如果单个 API 已额外绑定其他规则，则已绑定的规则优先生效。如果关闭环境级别规则，则执行单个 API 额外绑定的规则。API 级别规则：如果开启/关闭 API 级别规则，则对...
管理参数映射
绑定的 API：列出了绑定了该映射规则的所有 API 及其基本信息，包括 API 名称，API 分组、发布状态、前端协议类型、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。配置详情：...
客户端调用API示例
X-Ca-Version:1#API 版本号，目前所有 API 仅支持版本号『1』，可以不设置此请求头，默认版本号为『1』。X-Ca-Signature-Headers:X-Ca-Request-Mode,X-Ca-Version,X-Ca-Stage,X-Ca-Key,X-Ca-Timestamp#参与签名的自定义请求头，服务端将...
CORS 配置
CORS ID 查询 API 列表 sofa.apigateway.cors.api.all 用于查询指定 ID 的 CORS 绑定的所有 API 列表。请求参数 名称 类型 是否必填 示例 描述 cors_id STRING 否 cors_id1 CORS 标识 param ApiInfoQueryVO 否-API 查询信息 tenant_id ...
管理系统集群
绑定的API：列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息，例如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 ...
DescribeApiIpControls-查询API的IP访问控制绑定情况
查询指定分组指定环境下，所有API的IP访问控制绑定情况。接口说明 此功能面向开放 API 的用户 非必填的参数，不传入则默认返回所有，分页返回·调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI...
API详情
API详情页提供指定时间段内应用中所有API请求的成功率、平均成功耗时、平均失败耗时、缓慢次数、错误次数，并以API请求发起端的地域、域名、网络制式等维度展示统计数据。功能入口 登录 ARMS控制台。在左侧导航栏选择 前端监控>前端列表。...
- 产品推荐
- 这些文档可能帮助您