API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
版本说明
变更时间：2024-03-14 变更集发布说明：OpenAPI 名称 变更内容概要 操作 AllocateEipAddress OpenAPI 错误码发生变更。查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。错误码 400 变更 删除错误码：403 删除...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
SDK下载及使用指南
若您需要使用 SDK 调用您自己或者其他人在 API 网关开放的 API 服务（包括在 API 市场购买的 API 服务）注意这里的 API 服务是指在 API 市场购买的，或者您在 API 网关接入开放的，或者您的合作伙伴在 API 网关接入开放的那些 API 服务。...
应用 API 开放
IDaaS 为应用开发者开放应用 Developer API 供调用。... IDaaS 管理员拥有应用管理的最高权限，可以指定应用的 API 开放... IDaaS 提供多种语言的 SDK，您可以在 阿里云 OpenAPI 开发者门户 下载/查看调用样例，并直接尝试调用接口查看效果。
安装SDK
语言 安装方式 Java Java SDK安装 Go Go SDK安装 Python Python SDK安装 TypeScript TypeScript SDK安装 PHP PHP SDK安装 Swift Swift SDK安装 使用说明 OpenAPI开发者门户也为您提供了详细的SDK使用步骤以及完整的代码示例。更多信息，请...
应用场景
API 网关为您在各种场景下开放API 提供支撑，具体有：支持建立 API 生态，将 API 开放给合作伙伴、开发者，实现企业核心能力的货币化；支持将 API 适配多端，如：移动、互联网、物联，实现系统前后端分离；支持内部系统整合，模块化、微...
产品简介
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...
产品简介
云控制API（CloudControl API）是一款面向开发者的资源化API开发者工具。云控制API降低了开发者集成阿里云的学习和维护成本。并能够在云产品新特性发布时，通过简单新增资源属性即可完成新特性集成。产品优势 选择云控制API，您可以轻松...
IDaaS“开发友好”设计
可以前往 阿里云 IDaaS API 开发者平台，在左侧可切换到不同接口，在右侧可选择对应语言【下载完整工程】，参照其中代码实现 SDK 安装、应用和调用。功能四：API 在线调试 IDaaS 对外开放的 API 均提供在线调试能力，可直接在浏览器中录入...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
开放平台概览
DataWorks开放平台提供开放API（OpenAPI）、开放事件（OpenEvent）、扩展程序（Extensions）的能力，可以帮助您快速实现各类应用系统对接DataWorks、方便快捷的进行数据流程管控、数据治理和运维，及时响应应用系统对接DataWorks的业务状态...
开放平台：能力全面开放
DataWorks开放平台提供开放API（OpenAPI）、开放事件（OpenEvent）、扩展程序（Extensions）的能力，可以帮助您快速实现各类应用系统对接DataWorks、方便快捷的进行数据流程管控、数据治理和运维，及时响应应用系统对接DataWorks的业务状态...
DescribePurchasedApis-获取购买的 API 列表
RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...
服务接入点
southeast-2 apigateway.ap-southeast-2.aliyuncs.com apigateway-vpc.ap-southeast-2.aliyuncs.com 菲律宾（马尼拉）ap-southeast-6 apigateway.ap-southeast-6.aliyuncs.com apigateway-vpc.ap-southeast-6.aliyuncs.com韩国（首尔）ap-...
API/SDK数据导入
2.API/SDK不支持设置数据源插件，请自行拼接、处理后传入OpenSearch应用中。比如，array类型使用API上传时，注意不要上传为string格式，而是上传为数组类型。例：/定义Map对象存储上传文档数据,此为文档2 Map,Object>doc2=Maps....
创建并管理业务流程
数据服务基于业务流程实现以业务为单元的API开发，并基于业务流程对API、函数和服务编排进行组织管理。因此在生成API前，您需要创建业务流程。本文为您介绍如何创建及管理业务流程。前提条件 在创建业务流程之前，您需要登录 API网关控制台...
数据服务入门
本文以MySQL数据源为例，为您介绍API开发的全套流程。前提条件 已开通API网关（API Gateway）服务，用于统一管理及调用API，详情请参见 API网关服务。已创建目标数据源，作为生成API所需的源端输入数据。详情请参见 配置数据源。本文示例...
调用API
阿里云 OpenAPI开发者门户 提供 API在线调试工具。在 API调试 页面，您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧 SDK示例 页签下供您参考。在 调用结果 页签下，可...
名词解释
API定义 API服务方创建API时，设置的API的后端服务、请求格式、接收格式、返回格式等规则内容。参数映射 用户实际请求的参数与API服务后端参数不一致时，支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则，由网关根据规则...
支持 HTTPS
为这个域名申请一个SSL证书 自定义上传证书，包含证书/私钥，均为 PEM 格式（注：API网关Tengine服务是基于Nginx，因此只支持Nginx能读取的证书，即PEM格式）。SSL证书会包含两部分内容：XXXXX.key、XXXXX.pem，可以使用文本编辑器打开。...
产品简介
API网关（API Gateway），提供API托管服务，覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等API各个生命周期阶段，帮助您快速建设以API为核心的系统架构。构建中台。通过API网关强大的适配和集成能力，可以将各种业务系统的...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
API网关-事件总线服务关联角色
本文为您介绍API网关-事件总线服务关联角色（AliyunServiceRoleForApigatewayPutEventsToEventBridge）的应用场景以及如何删除API网关-事件总线服务关联角色。背景信息 API网关-事件总线服务关联角色（AliyunServiceRoleForApi...
DescribeRegions-查询支持的区域
接口说明 查询支持的区域列表 此功能面向开放 API 和调用 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透...
如何发布对外可用的API
多端低代码平台魔笔（以下简称魔笔）触发器里的 发布API 功能，可以将搭建出来的应用以开放API的形式开放给外部使用。您可以快速、便捷地将发布出来的能力集成到其他应用中。前提条件 已创建应用，具体请参见 添加应用。已创建使用此API所...
如何关闭公网访问
操作步骤如下：登录API网关控制台，在左侧栏单击 开放API —— 分组管理。在分组列表中找到想要关闭公网访问的分组，单击分组名称进入分组详情页。在分组详情页的公网二级域名后面找到 关闭公网访问 按钮，单击确定后即可关闭公网访问。...
使用SDK调用API
{{group}}.md`对应Group的API接口文档` lib文件夹*sdk-core-java-1.1.5.jar `sdk的core包，为本SDK的依赖包`*sdk-core-java-1.1.5-sources.jar`上述依赖包的源码`*sdk-core-java-1.1.5-javadoc.jar`core包的文档` Readme.md`本SDK使用指南`...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
为分组绑定插件
本文主要介绍如何为API分组绑定插件，并验证插件是否对分组下的API生效。1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效...
CreateApi-创建 API
接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...
HTTP自动跳转HTTPS
分组内的所有API定义的请求...操作步骤 登录 API网关控制台。左侧栏点击开放API，选择分组管理，找到目标分组，点击进入分组详情页。在分组详情页找到独立域名栏，开启指定域名的HTTP自动跳转HTTPS功能。点击确认，http的自动跳转开启成功。
CreatePlugin-创建API网关插件
接口说明 此接口面向开放 API 的用户 限制每个用户同一类型的插件可以创建的数量，不同类型，上限不同 高级功能的插件定义限制使用 插件创建后未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。调试 您可以在OpenAPI ...
- 产品推荐
- 这些文档可能帮助您