阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
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）等阿里...
SQL洞察
说明 执行耗时分布：展示了选定时间范围内，所有SQL的执行耗时分布，将执行耗时分为了7个区间，每分钟计算一次，分别是：[0,1]ms 是指满足0ms≤执行耗时≤1ms SQL执行次数占比（1,2]ms 是指1ms<执行耗时≤2ms SQL执行次数占比（2,3]ms 是指...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
SQL洞察
SQL洞察信息说明 执行耗时分布：展示了选定时间范围内，所有SQL的执行耗时分布，将执行耗时分为了7个区间，每分钟计算一次，分别是：[0,1]ms 是指满足0ms≤执行耗时≤1ms SQL执行次数占比。（1,2]ms 是指1ms<执行耗时≤2ms SQL执行次数占比...
使用说明
3]ms 是指2ms<执行耗时≤3ms SQL执行次数占比（3,10]ms 是指3ms<执行耗时≤10ms SQL执行次数占比（10,100]ms 是指10ms<执行耗时≤100ms SQL执行次数占比（0.1,1]s 是指0.1s<执行耗时≤1s SQL执行次数占比>1s 是指1s<执行耗时 SQL执行次数占...
后端服务调不通
API网关实例出口IP查看方法：API网关的出口IP请查看分组所在实例的出口IP，具体查看方法：1、先登录 API网关控制台-【API管理】-【分组管理】-【分组详情】查看分组所在实例信息。2、到【实例与集群】页面查看对应实例的出口地址。
通过脚本模式生成API
数据服务支持通过脚本模式或向导模式生成API，相对于向导模式，您可以自行编写API的查询SQL，支持多表关联、复杂查询和聚合函数等功能，满足您个性化查询需求。本文为您介绍如何通过脚本模式生成API。前提条件 配置API前，请先在 工作空间...
超时配置
配置HSFApiConsumerBean的clientTimeout属性，单位是ms，我们把接口的超时配置为1000ms，方法queryOrder配置为100ms,代码如下。HSFApiConsumerBean consumerBean=new HSFApiConsumerBean();接口级别超时配置 consumerBean.setClientTimeout...
超时配置
配置HSFApiConsumerBean的clientTimeout属性，单位是ms，我们把接口的超时配置为1000ms，方法queryOrder配置为100ms,代码如下。HSFApiConsumerBean consumerBean=new HSFApiConsumerBean();接口级别超时配置 consumerBean.setClientTimeout...
异步调用
} } 接口Callback方法配置 HSFApiConsumerBean hsfApiConsumerBean=new HSFApiConsumerBean();hsfApiConsumerBean.setInterfaceName("com.alibaba.middleware.hsf.guide.api.service.OrderService");hsfApiConsumerBean.setVersion("1.0.0...
异步调用
} } 接口Callback方法配置 HSFApiConsumerBean hsfApiConsumerBean=new HSFApiConsumerBean();hsfApiConsumerBean.setInterfaceName("com.alibaba.middleware.hsf.guide.api.service.OrderService");hsfApiConsumerBean.setVersion("1.0.0...
SDK插件使用说明
core-synch-l1-2-0.dll api-ms-win-crt-heap-l1-1-0.dll api-ms-win-core-string-l1-1-0.dll api-ms-win-crt-string-l1-1-0.dll api-ms-win-crt-stdio-l1-1-0.dll api-ms-win-crt-convert-l1-1-0.dll api-ms-win-crt-time-l1-1-0.dll api-...
第三方鉴权插件
您可以通过本插件配置自己的鉴权服务为API的访问进行鉴权。1.概述 API网关在调用API后端服务之前将先调用用户的鉴权服务，收到鉴权服务的鉴权成功应答后才会继续调用后端服务，否则给客户端返回鉴权失败的应答。第三方鉴权插件支持的功能...
基础功能
1 SDK原理概述 1.1 原理 SDK提供两种API调用方式 通过aplus环境变量直接调用API的方式 向SDK的指令队列aplus_queue发送API指令的方式 注：两种方式任选其一，可以混用 1.1.1 通过aplus环境变量直接调用API API直接调用的方式代码书写上更为...
DetachApiProduct-解除API与API产品的绑定关系
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID ba84c55eca46488598da17c0609f3ead StageName string 是 环境名称，取值...
AttachApiProduct-将API绑定到指定API产品
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID 551877242a4b4f3a84a56b7c3570e4a7 StageName string 是 环境名称，枚举...
DeleteApiProduct-删除API产品
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e 返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID CEF72CEB-54B6-4AE8-B225-F876FF7BZ002 示例 正常返回示例 ...
API网关-事件总线服务关联角色
背景信息 API网关-事件总线服务关联角色（AliyunServiceRoleForApigatewayPutEventsToEventBridge）是API网关为了访问用户的事件总线产品，上传事件到用户的事件总线而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用...
BatchAbolishApis-批量下线API
API 分组编号 ced5ab777f7b440398ea70e4470124de ApiUid string 是 API 唯一标识 994f72dcdaf04af0b38022c65fdbd1ac StageName string 否 环境名称 RELEASE 返回参数 名称 类型 描述 示例值 object OperationId string 操作 ID。...
RemoveApiProductsAuthorities-批量移除API产品对指定...
批量移除API产品对指定APP的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
BatchDeployApis-批量发布API
描述 test Api object[]否 指定要操作的 api 列表 GroupId string 是 API 分组编号 b4f5c342b8bc4ef88ccda0332402*ApiUid string 是 API 唯一标识 2b35dd68345b472f8051647306a1*返回参数 名称 类型 描述 示例值 object OperationId string...
DeleteApi-删除 API 定义
接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
SetApiProductsAuthorities-批量授权API产品给指定APP
批量授权API产品给指定APP 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...
DetachPlugin-解绑API绑定的插件
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DeployApi-发布 API
接口说明 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，...
AbolishApi-下线 API
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
DescribeApiMarketAttributes-获取API的属性
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribeApiMarketAttributes Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID b693252f3f19445e9a01dac177c4454c ApiId string 是 API ...
SetAppsAuthToApiProduct-批量授权多个APP给指定API...
批量授权多个APP给指定的API产品 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
CreateTrafficControl-创建流控策略
接口说明 此功能面向开放 API 的用户 策略创建后，未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
SetTrafficControlApis-添加指定流控策略与API的绑定
调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
- 产品推荐
- 这些文档可能帮助您