导入标准OAS定义
标准OAS2.0格式与API网关的对应 说明 本章节重点介绍OAS 2.0的格式定义与API网关的API定义有对应的映射字段，对于没有对应映射的OAS中的定义，不会影响API的导入。Swagger Object：BasePath：对应分组的BasePath，导入时需要认证；Schemes...
导出标准OAS定义
勾选导出API网关扩展字段后，在API网关定义API以外的内容，如绑定的插件、授权的APP、分组的域名、后端服务在各环境上的定义等，均不会导出。示例 如下为使用API网关提供的分组导出带有扩展定义的OAS2.0内容：swagger:'2.0' info:...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
配置文件说明
CADT命令行交互过程中有几个命令需要指定一个配置文件，例如 apply,step-apply,create-app 等命令，配置文件以YAML文件格式定义，配置文件定义了一个应用创建所需的基本信息。单个应用的配置文件 单个应用的配置文件定义格式及支持的参数如...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
数据表管理
expr]-表的列定义[column_constraint[.]-列的约束定义]|table_constraint-表级别的约束定义])[WITH(storage_parameter=value[,.])-表存储格式定义[DISTRIBUTED BY(column,[.])|DISTRIBUTED RANDOMLY]-表的分布键定义[partition clause]-表...
网关开发
网关如何去发现以及连接子设备是由网关厂商与子设备厂商去协商和定义的，平台并不参与网关与子设备之间的通信过程和数据格式定义。但是当网关添加一个子设备后，需要使用平台提供的子设备验证机制来验证子设备的合法性。当手机App对子设备...
DescribeApiHistory-查询历史版本详情
接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...
I404NF错误码排查
这个报错是请求的Path或Method和API定义的不同，需要根据API定义来请求API。您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么...
公告：操作事件变更资源类型定义格式
变更前 2020年12月02日00:00:00后通过跟踪A投递的操作事件，在referencedResources字段会包含旧版和新版两种资源类型定义格式，例如：您在阿里云上对云服务器ECS（Elastic Compute Service）实例进行了操作，则事件内容中...
数据服务概述
设计理念 数据服务作为DMS的模块，其基于DMS上受控的数据定义API，与SQL Console中执行SQL时的权限控制、数据脱敏等功能检查保持一致。数据服务基于Serverless架构，您无需关注服务器、网络等运行环境相关的基础设施，只需专注于API的定义...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
ApiHisItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
API网关的审计事件
DescribeApisByApp 按应用查询定义中的API列表。DescribeApisByBackend 根据后端查询API列表。DescribeApisByIpControl 查询IP访问控制绑定的API。DescribeApisByRule 通过规则获取API列表。DescribeApisByRuleForConsole 通过规则获取API...
应用场景
API 提供者在此提供标准的 API 服务，开发者在此将标准化的 API 服务整合进自己的应用，从而衍生出新的应用，新的服务。API 网关以此促进企业建立商业生态、跨界创新。通过 API 网关将企业的核心能力，开放给合作伙伴，达成深度合作，协同...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
后端服务调不通
在API定义时会要求您录入一个超时时间，当您的后端服务没有在您指定的时间内返回时，API网关仍然会提示您无法连接后端服务。您可以根据后端服务的实际耗时对"后端超时"进行调整，共享实例最大支持30000ms，专享实例最大支持120000ms。说明 ...
HTTP自动跳转HTTPS
分组内的所有API定义的请求协议都已勾选HTTPS。操作步骤 登录 API网关控制台。左侧栏点击开放API，选择分组管理，找到目标分组，点击进入分组详情页。在分组详情页找到独立域名栏，开启指定域名的HTTP自动跳转HTTPS功能。点击确认，http的...
发布API商品
入参定义，本例中配置了三种不同位置的参数，同时配置了默认值、示例和描述，商品发布后，入参信息会在商品页中的如下位置出现：3.3.3 定义API后端服务 这部分用于配置API网关如何访问后端服务，相关信息都不会出现在API商品信息中，更多...
API说明
Authentication API 定义数据源相关性 Correlations API 数据源相关 Data source API 文件夹相关 Folder API 文件夹权限相关 Folder Permissions API 文件夹/仪表盘搜索相关 Folder/Dashboard Search API 库元素相关 Library Element API ...
对象存储
1.概述 您需要依次完成以下步骤：开通对象存储（OSS）服务 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 2.创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
使用后端服务提高管理效率
定义API后端服务：本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址，这里我们使用之前创建的后端服务进行说明：首先在后端配置选择使用已有的后端服务；然后选择后端服务类型，控制台会自动过滤您...
创建后端为函数计算的API
定义API；创建应用和API授权；调试API；调用API。2 创建函数 函数计算是一个事件驱动的服务。函数的执行可以由事件驱动，即当某个事件发生时，该事件触发函数的执行。现在，函数计算支持以API网关作为事件源。当请求设置函数计算为后端服务...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
导入API网关的扩展Swagger定义
后端服务参数，应用于 Operation Object，用于定义API后端服务的系统参数。属性说明：属性名称 类型 描述 systemName string 必填；系统参数名称 backendName string 必填；后端参数名称 location String 必填；常量参数存放位置，可选值：...
基本概念
编排实例是一个可运行的独立部署的应用程序，承载工作流以及工作流节点所依赖的相关服务连接。工作流 工作流是以步骤的方式完成对业务流程的编排定义，也是编排实例的运行核心。工作流由一系列触发器和操作节点组成。您可以通过可视化的...
Nacos
定义API后端服务 本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址。本例中的后端配置选择 使用已有的后端服务，后端服务类型选择 服务发现，后端服务选择之前创建的后端服务，后端请求的Path、...
阿里云API网关试用服务协议
在使用阿里云API网关服务过程中，您需要对API定义/API流控/API访问权限自行操作，您将对自行操作的行为及其产生的结果负责；3.2.2.尽管目前使用阿里云API网关服务您仍不需付费，但在使用阿里云API网关过程中如您使用了阿里云的其他收费服务...
新功能发布记录
每次允许导入的API上限个数为100 全部 导入标准OAS定义 第三方鉴权插件支持获取请求的Path信息 支持将请求侧的Path作为参数传递给鉴权服务 全部 第三方鉴权插件 新增API的操作历史日志 API网关记录了API所有相关操作日志，包括：创建、编辑...
搭建无服务器应用之手机号归属地查询
定义API请求：请求的Path即使最终暴露给客户的路径。入参定义：需定义入参名，传入手机号。本例中设置入参名为mob。定义API后端服务：后端服务类型需选择FunctionCompute；Service和Function填入之前在函数计算中设置好的参数。说明 建议...
断路器插件（仅专享实例）
若API定义的后端超时时间为10s，请求后端10s没有应答就会计为后端超时 timeoutThreshold:15#超时的阈值 windowInSeconds:30#超时时间窗口 openTimeoutSeconds:15#断路器开的时间 downgradeBackend:#降级后的后端配置 type:mock statusCode:...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
自定义事件源API网关
步骤四：创建应用及对API授权 在 API网关控制台 的左侧导航栏，选择 调用API>应用管理。在 应用列表 页面，单击右上角的 创建APP，然后在 创建应用 对话框设置应用的名称和描述，单击 确定。回到 API列表 页面，找到 步骤三：创建API 中...
数据服务
配置方式 选择API的配置方式，支持的选项：表引导模式：通过可视化的方式选择表、字段，定义API的数据查询配置。脚本模式：通过手动编写SQL脚本+变量的方式来定义API的数据查询配置。说明 从 表引导模式 切换为 脚本模式 时，系统将提示...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
表管理
定义表主题，详情请参见 定义表主题。定义表层级，详情请参见 定义表层级。定义表相关格式 在 表管理 页面，您可设置表的分区、前缀等相关格式，用于标识目标表，后续在DataWorks中，通过表名称即可判断该表所属类别。DataWorks为您提供了...
- 产品推荐
- 这些文档可能帮助您