简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
API服务变更
截止到2021年6月30日，将停止对以下接口的支持：API 描述 DescribeRtcDurationData 获取应用在一段时间内按照音视频规格进行统计的累计通信时长。DescribeRtcUserCntData 查询应用在一段时间内的活跃用户数（发生通信的用户终端数）。...
DescribeUsers-查询便捷用户信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 MaxResults long 否 分页...
DescribeUsers-查询便捷用户信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 MaxResults long 否 分页...
可视对讲服务API
SyncApiClient syncApiClient=new SyncApiClient(ioTApiClientBuilderParams);IoTApiRequest request=new IoTApiRequest();设置请求ID String uuid=UUID.randomUUID().toString();String id=uuid.replace("-","");request.setId(id);设置...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
版本说明
变更时间：2023-08-31 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetTableProfile OpenAPI 描述信息更新。查看API变更历史 查看API文档 变更项 变更内容 API 描述 OpenAPI 描述信息更新。变更时间：2023-06-09 变更集发布说明：Open...
API网关的审计事件
API 网关已与操作审计服务集成，您可以在操作审计中查询用户操作API 网关产生的管控事件。操作审计支持将管控事件投递到日志服务SLS的LogStore或对象存储OSS的存储空间中，满足实时审计、问题回溯分析等需求。操作审计记录了用户通过Open...
版本说明
删除错误码：500 变更时间：2021-06-22 变更集发布说明：云测，运行自动化接口发布变更 OpenAPI 名称 变更内容概要 操作 QueryTaskResult 新增 OpenAPI。查看API变更历史 查看API文档 StartTaskByApp 新增 OpenAPI。查看API变更历史 查看...
版本说明
变更时间：2023-05-23 变更集发布说明：OpenAPI 名称 变更内容概要 操作 ListAppSessions OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2023-05-23 变更集发布说明：...
版本说明
变更时间：2023-12-21 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetPipelineRun OpenAPI 入参发生变更。查看API变更历史 查看API文档 变更项 变更内容 入参 OpenAPI 入参发生变更。新增入参：TokenId GetPipelineRunNode OpenAPI ...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
支持HTTP2.0
API网关支持HTTP2.0 API网关支持HTTP2.0新特性，支持API请求多路复用、支持请求头压缩。多路复用（MultiPlexing）：消除了 HTTP 1.x 中并行处理和发送请求及响应时对多个连接的依赖。可客户端和服务器可以把HTTP消息分解为互不依赖的帧，...
版本说明
变更时间：2023-04-27 变更集发布说明：OpenAPI 名称 变更内容概要 操作 BindBatchAxg 新增 OpenAPI。查看API变更历史 查看API文档 DeleteAxgGroup 新增 OpenAPI。查看API变更历史 查看API文档 变更时间：2023-03-24 变更集发布说明：Open...
版本说明
变更时间：2023-08-31 变更集发布说明：OpenAPI 名称 变更内容概要 操作 UpdateCampaign API 内部配置变更，不影响调用。查看API变更历史 查看API文档 变更项 变更内容 API 内部配置变更，不影响调用。变更时间：2023-03-24 变更集发布说明...
使用外部授权 API
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为...
HTTP API 入门
超时时间：必填，API 请求超时时间，单位为毫秒（ms），保持默认 3000 毫秒即可。路由策略：必选，表示当网关接收到语法后使用的路由策略。本例中选择 根据请求路径路由，即直接转发。系统集群：必选，选择步骤二创建的系统集群，即 ...
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
HTTP 转 SOFARPC 入门
超时时间：必填，API 请求超时时间，单位为毫秒（ms），保持默认即可。路由策略：必选，表示当网关接收到语法后使用的路由策略。本例中选择 根据请求路径路由，即直接转发。系统集群：必选，选择步骤二创建的系统集群，即 sofarpc。单击 ...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
API详情
API详情页提供指定时间段内应用中所有API请求的成功率、平均成功耗时、平均失败耗时、缓慢次数、错误次数，并以API请求发起端的地域、域名、网络制式等维度展示统计数据。功能入口 登录 ARMS控制台。在左侧导航栏选择 前端监控>前端列表。...
版本说明
变更时间：2024-02-26 变更集发布说明：OpenAPI 名称 变更内容概要 操作 AllotDatasetAccelerationTask OpenAPI 错误码发生变更。查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。错误码 400 变更 ...
TCP连接超时时间配置
使用API网关的TCP连接超时时间配置原则 下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
ListDataServiceAuthorizedApis
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListDataServiceAuthorizedApis 系统规定参数...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
管理 API 分组
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
后端服务调不通
在API定义时会要求您录入一个超时时间，当您的后端服务没有在您指定的时间内返回时，API网关仍然会提示您无法连接后端服务。您可以根据后端服务的实际耗时对"后端超时"进行调整，共享实例最大支持30000ms，专享实例最大支持120000ms。说明 ...
管理外部授权 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 ...
查看及管理运维监控API
为了保障应用能够正常调用API，同时能够保护系统，数据服务支持监控API的运行情况，包括查看异常影响分析、访问趋势分析、应用调用情况、查看API运行详情、API影响分析、配置API限流和API告警。本文为您介绍如何查看API调用情况及配置API限...
ListDataServiceApiAuthorities
调用ListDataServiceApiAuthorities获取授权给他人的API列表。...Action=ListDataServiceApiAuthorities&ProjectId=10000&PageNumber=1&PageSize=10&TenantId=10001&ApiNameKeyword=我的API名称&公共请求参数 正常返回示例 XML 格式 ...
- 产品推荐
- 这些文档可能帮助您