简介
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。...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
SOFARPC 客户端接入
前置条件 在进行本地订阅方应用开发、接入网关前，需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体...
发送 HTTP 请求（Java）
填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
管理数据模型
绑定的 API：列出了绑定了该数据模型的所有 API 及其基本信息，包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
发送 HTTP 请求（NodeJS）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
使用HTTPS并用域名访问
用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
WAF接入配置
1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP TOP10常见Web攻击等）、暴力破解等情况，您可以考虑接入云盾Web应用...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
API 流量治理
本文列出了 API 流量治理相关的所有 OpenAPI 及其请求参数、返回参数。编辑限流配置 sofa.apigateway.api.limitconfig.update 用于编辑指定 ID 的 API 的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 NQ3MMyVqDX6...
新功能发布记录
本章节介绍了API网关的产品功能和对应的文档动态。更多有关阿里云产品动态，请订阅 云产品动态。2024-01 功能名称 功能描述 发布地域 相关文档 后端路由插件支持哈希 后端路由插件支持哈希分发策略 全部 后端路由 日志 日志中增加所有IO...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
使用限制
限制项 限制描述 使用API网关服务的用户限制 用户需实名认证 用户创建API分组数量限制-每个账号下，每个Region的API分组（含绑定域名和未绑定域名的分组）的总数上限200个；每个账号下，每个Region默认最多创建5个未绑定域名的API分组，...
参数映射与校验规则
123"${User}.${Group}.api.io 123.g01.api.io User:"123"Group:"g01"${Admin}.admin.api.io${User}.${Group}.api.io.123.api.io User:"123"${Admin}.admin.api.io${User}.${Group}.api.io 123.admin.api.io Admin:"123"${Admin}.admin.api...
API 分组
本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
错误代码表
{Reason} B403MO 403 Api Market Subscription overdue API提供商欠费，请联系服务商处理 B403MQ 403 Api Market Subscription quota exhausted 购买的云市场API配额已耗尽，请续费次数 B403ME 403 Api Market Subscription expired API...
DeleteIpControl-删除IP访问控制
接口说明 此功能面向 API 提供者 若该访问控制已经绑定了 API，则需要先解除绑定才能操作删除，否则会报错 删除一个不存在的 IP 访问控制，会直接返回成功 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DeleteSignature-删除后端签名密钥
接口说明 此功能面向开放 API 的用户 此功能效果是删除已经存在的后端签名密钥 调用该接口时，若要删除的密钥已经绑定了 API，则不能删除。需先解除绑定关系，再调用该接口操作删除 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
API 管理
},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
D504CO错误码排查
排查后端服务是否有黑白名单、后端服务应用程序是否启动、及防火墙是否有拦截；若后端是VPC类型，链路涉及到跨Region或是通过云企业网访问的IDC机房，则需要配置回程路由，文档可以参考 访问云服务。2、Backend service connect failed `...
DeleteTrafficControl-删除指定的用户自定义流控策略
接口说明 此功能面向开放 API 的用户 若该策略已经绑定了 API，则需要先解除绑定才能操作删除，否则会报错 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
Grafana基于API Key分享大盘
通过API Key鉴权方式生成免登录的可分享的大盘链接。背景信息 原生的Grafana若需要直接访问大盘，要么使用Snapshot功能，要么开启匿名模式。前者对访问的数据做了镜像，随着时间变化无法查看后续更新的数据，后者若不配合IP白名单功能，则...
Grafana基于API Key分享大盘
通过API Key鉴权方式生成免登录的可分享的大盘链接。背景信息 原生的Grafana若需要直接访问大盘，要么使用Snapshot功能，要么开启匿名模式。前者对访问的数据做了镜像，随着时间变化无法查看后续更新的数据，后者若不配合IP白名单功能，则...
- 产品推荐
- 这些文档可能帮助您