简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
TCP连接超时时间配置
使用API网关的TCP连接超时时间配置原则 下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端...
ListDataServiceAuthorizedApis
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListDataServiceAuthorizedApis 系统规定参数...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
API管理
通过API管理，可以快速对所属服务项目的API进行限流和告警设置。本文为您介绍如何对API进行限流和告警配置。使用限制 超级管理员、项目管理员、运维人员支持配置API的限流和告警。限流设置 在Dataphin首页，单击顶部菜单栏 服务。按照下图...
DATASOURCE:ApiGateway:Apis
Apis Properties:ApiId:Ref:ApiId Outputs:Apis:Description:The information about ApiGateway apis.Value:Fn:GetAtt:ExtensionDataSource-Apis ApiIds:Description:The list of The ApiGateway api ids.Value:Fn:GetAtt:...
版本说明
变更时间：2023-08-31 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetTableProfile OpenAPI 描述信息更新。查看API变更历史 查看API文档 变更项 变更内容 API 描述 OpenAPI 描述信息更新。变更时间：2023-06-09 变更集发布说明：Open...
版本说明
删除错误码：500 变更时间：2021-06-22 变更集发布说明：云测，运行自动化接口发布变更 OpenAPI 名称 变更内容概要 操作 QueryTaskResult 新增 OpenAPI。查看API变更历史 查看API文档 StartTaskByApp 新增 OpenAPI。查看API变更历史 查看...
通过日志服务查看API调用日志
appId 调用者应用ID appName 调用者应用名称 clientIp 调用者客户端IP exception 后端返回的具体错信息 exchangeTimestamp 整个请求链路的IO时间点 FrontRequestStart：API网关开始接收到客户端请求的时间点 FrontRequestEnd：API网关完成...
管理数据模型
绑定的 API：列出了绑定了该数据模型的所有 API 及其基本信息，包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...
函数计算内网访问API网关
1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
管理 API 分组
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
使用外部授权 API
} 创建外部授权 API 本地编写完外部授权接口后，您需要前往 API 网关的控制台上配置一个对应的外部授权 API。操作步骤如下：进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>外部授权 API。在外部授权 API 列表页，点击列表右上方的...
后端服务调不通
在API定义时会要求您录入一个超时时间，当您的后端服务没有在您指定的时间内返回时，API网关仍然会提示您无法连接后端服务。您可以根据后端服务的实际耗时对"后端超时"进行调整，共享实例最大支持30000ms，专享实例最大支持120000ms。说明 ...
HTTP API 入门
超时时间：必填，API 请求超时时间，单位为毫秒（ms），保持默认 3000 毫秒即可。路由策略：必选，表示当网关接收到语法后使用的路由策略。本例中选择 根据请求路径路由，即直接转发。系统集群：必选，选择步骤二创建的系统集群，即 ...
版本说明
变更时间：2023-05-23 变更集发布说明：OpenAPI 名称 变更内容概要 操作 ListAppSessions OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2023-05-23 变更集发布说明：...
HTTP 转 SOFARPC 入门
超时时间：必填，API 请求超时时间，单位为毫秒（ms），保持默认即可。路由策略：必选，表示当网关接收到语法后使用的路由策略。本例中选择 根据请求路径路由，即直接转发。系统集群：必选，选择步骤二创建的系统集群，即 sofarpc。单击 ...
版本说明
变更时间：2023-12-21 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetPipelineRun OpenAPI 入参发生变更。查看API变更历史 查看API文档 变更项 变更内容 入参 OpenAPI 入参发生变更。新增入参：TokenId GetPipelineRunNode OpenAPI ...
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
版本说明
变更时间：2022-03-08 变更集发布说明：ListMessages接口新增ErrorCode过滤 OpenAPI 名称 变更内容概要 操作 ListMessages OpenAPI 入参发生变更、OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 入参 OpenAPI 入...
版本说明
变更时间：2023-04-27 变更集发布说明：OpenAPI 名称 变更内容概要 操作 BindBatchAxg 新增 OpenAPI。查看API变更历史 查看API文档 DeleteAxgGroup 新增 OpenAPI。查看API变更历史 查看API文档 变更时间：2023-03-24 变更集发布说明：Open...
查看计量详情
API计量详情提供了各类可视化图表及统计数据，可以针对单个API分别查看监控图表，包括API网关状态码、数据服务错误码、App请求次数、流量带宽、平均响应时间。进入计量详情页面 登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框...
版本说明
变更时间：2024-02-26 变更集发布说明：OpenAPI 名称 变更内容概要 操作 AllotDatasetAccelerationTask OpenAPI 错误码发生变更。查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。错误码 400 变更 ...
API详情
API详情页提供指定时间段内应用中所有API请求的成功率、平均成功耗时、平均失败耗时、缓慢次数、错误次数，并以API请求发起端的地域、域名、网络制式等维度展示统计数据。功能入口 登录 ARMS控制台。在左侧导航栏选择 前端监控>前端列表。...
管理外部授权 API
外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间。...
QueryRequestLogs-获取请求日志
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
查看及管理运维监控API
为了保障应用能够正常调用API，同时能够保护系统，数据服务支持监控API的运行情况，包括查看异常影响分析、访问趋势分析、应用调用情况、查看API运行详情、API影响分析、配置API限流和API告警。本文为您介绍如何查看API调用情况及配置API限...
搭建无服务器应用之手机号归属地查询
选用Python2.7编译环境，设置执行时间：1500ms，执行的内存128MB，因为是调用云市场的接口来取到内容，该接口平均响应时间在1200ms左右。其中函数代码块：import logging import urllib,urllib2,sys import ssl import json def handler...
查看计量大屏
查看总体计量 查看API总数 您可以查看当前工作空间下，截至当前时间统计的所有API数目，包括已发布的API数目，未发布的API数目。总体计量 您可以查看当前工作空间下所有API在某段时间内的计量统计信息，包括累计总调用次数、累计总执行时长...
如何配置出访连接池告警
若购买的专享实例规格为api.s1.small，最大出访连接池大小为1200，如果后端服务每个请求的应答时间在1秒时，那么这个实例最大支持的出访RPS是1200，超过1200后，如果请求进入API网关，后端连接池被占满，API网关会让请求进入一个等待队列，...
API调用统计
API调用统计功能可以统计API被调用的详细信息，包括 开放API 和 数据服务 API。该功能仅对组织管理员可见。功能入口 您可以按照图示步骤进入API调用统计页面。API调用统计 在 API调用统计 页面，您可以查看 开放API 或 数据服务 API的 今日...
第三方鉴权插件
您可以通过本插件配置自己的鉴权服务为API的访问进行鉴权。1.概述 API网关在调用API后端服务之前将先调用用户的鉴权服务，收到鉴权服务的鉴权成功应答后才会继续调用后端服务，否则给客户端返回鉴权失败的应答。第三方鉴权插件支持的功能...
- 产品推荐
- 这些文档可能帮助您