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 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
实例生命周期介绍
控制台状态 API状态 状态属性 状态解释 是否计费 控制台上可见 准备中 Pending 中间状态 在控制台或通过API接口执行创建实例操作后，在进入 创建中 之前的中间状态。否 否 创建中 Creating 中间状态 在控制台或通过API接口执行创建实例操作...
管理应用
编辑应用信息 打开应用编辑界面有以下两种方式：在应用列表页，单击应用右侧 操作 列中的 编辑 即可打开编辑应用界面。单击应用名进入应用详情页后，单击页面右上方的 编辑 即可打开编辑应用界面。打开的 编辑应用 界面与创建应用界面内容...
API 版本管理
下线后，API 状态切换为 未发布，无法被该 API 的订阅方应用继续调用。您可以通过以下任一方法下线 API 当前版本：在 API 列表中选择要下线的 API，单击 下线>确认。在 API 详情页面，单击右上角的 下线 按钮。在 API 详情>版本管理 页签中...
管理授权对象
筛选 API 状态：单击 状态 右侧的筛选按钮。在打开的筛选框中，选择 已发布 或 未发布，并单击 确定 即可进行筛选。搜索 API：在 API 列表右上方的搜索框中，可通过 API 名称搜索已绑定的 API。更改展示设置：更改列设置：在 API 列表右...
管理 CORS 规则
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量治理、CORS、授权对象、API 调试 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的...
同步 API
同步 API 可将当前环境中的 API 同步至其他环境中。为保证系统稳定性，只同步目标环境不存在的 API 配置。同步后，会自动加载配置使其生效。操作步骤 登录 mPaaS 控制台，在左侧导航栏，点击 移动网关 菜单。在 API 管理 标签页中，点击 更...
查看、删除、移动、克隆、批量操作、代码搜索API
本文为您介绍如何查看、克隆、删除和移动API。查看API 登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框中选择对应工作空间后单击 进入数据服务。在 服务开发 页面，展开目标API所在的 业务流程>API。右键单击相应的API名称，...
结构体说明
page_info ApiInfoVO 名称 类型 是否必填 示例 描述 api_cache_model ApiCacheVO 否-API 缓存模型 api_group_id STRING 否 api_group_id1 API 分组标识 api_group_name STRING 否 api_group_name1 所属 API 分组名称 api_id STRING 否 8...
查看计量详情
API计量详情提供了各类可视化图表及统计数据，可以针对单个API分别查看监控图表，包括API网关状态码、数据服务错误码、App请求次数、流量带宽、平均响应时间。进入计量详情页面 登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框...
查看计量大屏
API网关状态码分布 您可以查看当前工作空间下所有已发布API，经过某段时间内的调用后，所返回的API网关状态码的分布情况，单击扇形图中代表不同状态码的色块即可查看。说明 常见的API网关状态码大致可分为三种类型，包括以2开头的状态码（2...
授权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授权状态后，单击 确定。应用维度：以应用为视角展示对应应用下的API，单击加号展开应用下的API列表。在 已获授权API 列表，单击待调试API 操作 列的 测试。进入 ...
下载密钥SDK
密钥SDK是包含配置API相关环境和关键信息的压缩文件，通过下载密钥SDK将执行API的关键信息保存至本地，提供使用API的访问凭证。本文介绍如何下载密钥SDK。前提条件 已申请API资产，具体操作，请参见 申请API资产。操作步骤 登录企业数据...
下载调用文档
按授权 状态 筛选：进入 已获授权API>API维度，单击 图标，选中待筛选的API授权状态后，单击 确定。应用维度：以应用为视角展示对应应用下的API。在已获授权API列表的 操作 列，选择 更多>下载调用文档pdf，或 更多>下载调用文档word。下载...
查看API授权详情
通过API的授权详情以便了解API授权人、授权时间、访问路径、认证方式、应用对API调用最大次数、最近调用最大次数、AppKey、AppSecret等API授权信息。本文介绍如何查看API授权详情。前提条件 API已上架成功，具体操作，请参见 上架API。操作...
查看API授权详情
通过API的授权详情以便了解API授权人、授权时间、访问路径、认证方式、应用对API调用最大次数、最近调用最大次数、AppKey、AppSecret等API授权信息。本文介绍如何查看API授权详情。前提条件 API已上架成功，具体操作，请参见 上架API。操作...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
ListDataServiceAuthorizedApis
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListDataServiceAuthorizedApis 系统规定参数...
发布API
如果您的API是为了供自己的应用程序调用，需要在API网关中创建应用，将API授权到应用中，然后通过AppKey和AppSecret加密签名调用，详情请参见 客户端调用API示例。同时API网关提供了主流编程语言的SDK，您可以快速集成API至自己的应用中，...
错误码
排查方式如下：检查网关是否配置了相应的 API 且 API 的状态是否为 已发布。检查客户端的 API 调用路径和分组等信息是否与网关维护的一致。检查请求的 host、path、method 是否正确。加签/验签失败 在对网关进行加签/验签操作失败时，常见...
ListDataServiceApiAuthorities
调用ListDataServiceApiAuthorities获取授权给他人的API列表。...Action=ListDataServiceApiAuthorities&ProjectId=10000&PageNumber=1&PageSize=10&TenantId=10001&ApiNameKeyword=我的API名称&公共请求参数 正常返回示例 XML 格式 ...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
DescribeApiHistory-查询历史版本详情
查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义。接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次...
GetDataAPIServiceDetail
调用该接口获取数据算法服务API详情。QPS限制 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
创建CADT连线拐点说明
鼠标保持单击状态拖拽拐点，可任意移动拐点，此时按住键盘 Shift键，可完成自动吸附。以同样操作，在另外一条SLB-ECS之间的连线创建拐点，并完成拖拽，即可达到示例中的效果。如果需要删除拐点，鼠标保持单击状态单击对应的连线，然后按住...
API网关的审计事件
API 网关已与操作审计服务集成，您可以在操作审计中查询用户操作API 网关产生的管控事件。操作审计支持将管控事件投递到日志服务SLS的LogStore或对象存储OSS的存储空间中，满足实时审计、问题回溯分析等需求。操作审计记录了用户通过Open...
API详情
API详情页提供指定时间段内应用中所有API请求的成功率、平均成功耗时、平均失败耗时、缓慢次数、错误次数，并以API请求发起端的地域、域名、网络制式等维度展示统计数据。功能入口 登录 ARMS控制台。在左侧导航栏选择 前端监控>前端列表。...
AttachPlugin-绑定插件到API上
接口说明 此接口面向开放 API 的用户 绑定操作只能选择发布状态的 API 绑定以后及时生效 修改插件后及时生效 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
新功能发布记录
本章节介绍了API网关的产品功能和对应的文档动态。更多有关阿里云产品动态，请订阅 云产品动态。2024-01 功能名称 功能描述 发布地域 相关文档 后端路由插件支持哈希 后端路由插件支持哈希分发策略 全部 后端路由 日志 日志中增加所有IO...
HTTP API
整体过程分为五步：注册 API 分组 创建 API 配置 API 服务 测试 API 服务 生成客户端 SDK 准备 登录控制台，在 产品与服务 中选择 移动开发平台 mPaaS 进入移动开发平台主页。切换至正确的工作空间后，单击需要接入 API 服务的 App 名称。...
- 产品推荐
- 这些文档可能帮助您