API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
配置API触发
设置API触发 打开流水线编辑界面，具体操作参见 打开流水线编辑界面。在流水线编辑界面，单击 触发条件 阶段>API触发 选项的，打开 API触发配置 右侧栏。在 API触发配置 右侧栏，打开 是否开启 开关键，启用API触发，生成webhook地址。单击...
管理流水线
根据你的开发语言和部署场景，选择合适的流水线模板，单击 创建 即可完成一条流水线创建，创建完成会自动进入流水线编辑页面。编辑流水线 进入流水线编辑页面，添加流水线源（详见 流水线源）、配置任务步骤（详见 流程配置），单击保存...
新建YAML流水线
编辑流水线 YAML 进入 流水线 Flow>我的流水线，找到目标 YAML 流水线，单击编辑进入流水线编辑页 左侧区域为 YAML 编辑区域，根据云效流水线 YAML语法规范 编写 YAML。单击右侧工具栏 任务，按需添加任务YAML。单击右侧工具栏 YAML手册，...
配置流水线源
在流水线编辑页，点击 添加流水线源，在 添加流水线源 弹框中选择 制品源，添加Packages服务连接，仓库类型选择通用制品（目前仅支持Packages通用制品），选择仓库、制品和默认版本。Jenkins源 Flow 支持将你的 Jenkins 服务配置为流水线源...
流水线的配置
阶段的添加、修改与删除 在流水线编辑页面的中间部分，显示流水线各阶段。当把鼠标移动到两阶段之间的连线时，页面显示两阶段间的加号图标（下图中红色框），和一个阶段的删除图标（下图中黄色框）。点击可分别新建阶段或删除一个已有阶段...
使用批量方式创建三方API
相关操作 操作项 说明 编辑API 在API资源列表中，单击目标API 操作 列的 编辑，在API编辑向导页面，可对API进行编辑修改。说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果...
流水线简介
Serverless应用中心依托Serverless产品，为所有用户和平台提供平滑易用、灵活、易集成的流水线编辑以及执行能力，帮助用户在Serverless场景以及其他场景下，实现应用的持续集成和持续交付（CI/CD）。功能介绍 与开源产品GitHub Actions类似...
流水线简介
Serverless应用中心依托Serverless产品，为所有用户和平台提供平滑易用、灵活、易集成的流水线编辑以及执行能力，帮助用户在Serverless场景以及其他场景下，实现应用的持续集成和持续交付（CI/CD）。功能介绍 与开源产品GitHub Actions类似...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
创建参数映射
API 网关支持参数映射。参数映射是将请求或响应参数中的不规范或者不统一的参数，映射为符合客户端或者服务端规范的参数。...后续操作 参数映射创建成功后，即可在后续创建 API 或编辑 API 时，选择该映射配置实现请求或响应参数映射。
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
最佳实践：API请求参数的选填设置
通过数据源封装数据API时，在某些业务场景下，需要设置API的请求参数为选填参数。当开发人员设置API的请求参数为选填参数后，调用方即可在调用API时自行选择是否要传入具体的请求参数值，实现更灵活的查询方式。本文将为您介绍如何在不同的...
使用向导模式创建三方API
相关操作 操作项 说明 编辑API 在API资源列表中，单击目标API 操作 列的 编辑，在API编辑向导页面，可对API进行编辑修改。说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果...
使用SQL模式创建数据服务API
相关操作 操作项 说明 编辑API 在API资源列表中，单击目标API 操作 列的 编辑，在API编辑向导页面，可对API进行编辑修改。说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果...
使用SQL模式创建数据服务API
相关操作 操作项 说明 编辑API 在API资源列表中，单击目标API 操作 列的 编辑，在API编辑向导页面，可对API进行编辑修改。说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果...
管理参数映射
需前往 API 编辑页面，将对应 API 的参数映射规则替换为其他规则后，方可编辑当前参数映射规则。您可以通过以下任一方式编辑参数映射规则：在参数映射列表中，找到目标规则，单击右侧 操作 列中的 编辑 按钮。在参数映射的详情页，单击右上...
数据服务
场景 数据服务资源组类型 独享数据服务资源组 公共数据服务资源组 实例模式 同租户访问RDS 数据服务API能够正常编辑和保存 数据服务API能够正常编辑和保存 跨租户访问RDS 数据服务API能够正常编辑和保存 保存API时报错：存在安全风险，需要...
管理系统集群
绑定的API：列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息，例如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 ...
使用向导模式创建数据服务API
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，可减少资源操作成本。向导模式适用于单表的简单查询，零代码通过界面化的设置完成API的封装。本文介绍如何使用向导模式创建数据API。前提条件 已...
使用向导模式创建数据服务API
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，可减少资源操作成本。向导模式适用于单表的简单查询，零代码通过界面化的设置完成API的封装。本文介绍如何使用向导模式创建数据API。前提条件 已...
管理路由规则
需前往 API 编辑页面，将对应 API 的路由规则替换为其他路由规则后，方可编辑当前路由规则。在 路由规则 页面，通过以下任一方式打开路由规则编辑界面：在路由规则列表页，单击路由规则右侧 操作 列中的 编辑 即可打开路由规则编辑界面。...
DataWorks数据服务
本文为您介绍交互式分析Hologres如何连接DataWorks数据服务并生成API。前提条件 开通DataWorks，详情请参见 入门概述。开通Hologres实例，并绑定至DataWorks工作空间。背景信息 DataWorks数据服务旨在为您搭建统一的数据服务总线，支持快速...
代码源触发
进入目标 Flow 流水线编辑页，点击编辑代码源。开启代码源触发，并将对应的 Webhook 复制出来。将复制出来的 Webhook地址配置到相应的代码库中。云效支持Gitlab、Github、Gitee、通用Git代码仓库类型开启代码源触发，各类型代码仓库配置...
通过脚本模式生成API
数据服务支持通过脚本模式或向导模式生成API，相对于向导模式，您可以自行编写API的查询SQL，支持多表关联、复杂查询和聚合函数等功能，满足您个性化查询需求。本文为您介绍如何通过脚本模式生成API。前提条件 配置API前，请先在 工作空间...
注册API
在API编辑页面的右侧导航栏中，单击 版本，找到待申请版本单击 申请发布 跳转到申请页面，申请类型默认为 发布数据服务API，填写 申请原因 后单击 申请权限 完成发布申请。说明 工作空间定义审批流后需要走流程审批才可以发布API，详情请...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
查看、删除、移动、克隆、批量操作、代码搜索API
本文为您介绍如何查看、克隆、删除和移动API。查看API 登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框中选择对应工作空间后单击 进入数据服务。在 服务开发 页面，展开目标API所在的 业务流程>API。右键单击相应的API名称，...
数据服务入门
DataWorks数据服务的主要目标是为个人、团队和企业构建统一的数据服务总线，帮助用户统一管理面向内外部的API服务。例如，您可以将查询数据表功能快速的生成对应的API，或将已有的API注册至数据服务平台进行统一发布和管理。本文以MySQL...
发布API
如果您的API是为了供自己的应用程序调用，需要在API网关中创建应用，将API授权到应用中，然后通过AppKey和AppSecret加密签名调用，详情请参见 客户端调用API示例。同时API网关提供了主流编程语言的SDK，您可以快速集成API至自己的应用中，...
数据服务API
数据地图支持对当前租户下所有工作空间的数据服务API进行搜索和定位，实现数据服务API的高效查找。进入API查找界面 进入数据地图页面。登录 DataWorks控制台，切换至目标地域后，单击左侧导航栏的 数据治理>数据地图，在右侧页面中单击 ...
管理 API 分组
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
管理 API 渠道
API 引入指按照 API 引入协议实现内容的同步。进行内容同步前，需要先创建 API 引入渠道，完成 API 配置。...编辑 API 渠道 在 API 列表中，找到要编辑的 API，单击 操作 列下的 编辑 菜单，编辑 API 信息。重要 API 标识一旦创建，不可修改。
数据服务权限列表
Y API责任人：Y 非API责任人：N N N 新建API Y Y N N 测试API Y API责任人：Y 非API责任人：N N N 发布API Y API责任人：Y 非API责任人：N N N 删除API Y API责任人：Y 非API责任人：N N N 编辑API Y API责任人：Y 非API责任人：N N N 查看...
CreatePipeline-创建流水线
创建流水线API，支持创建YAML化流水线。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求语法 POST/...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API 版本管理
创建后的 API 可以根据业务需求进行编辑、下线和编辑重发布等操作。新版本发布上线后，老版本自动成为历史版本被下线。API 版本的生命周期如下：版本说明：每次发布一个版本时，系统为当前版本分配一个新的版本号。每次保存草稿时，系统为...
YAML辅助编辑器
编辑器内置 YAML 手册，随手查阅 Flow 流水线 YAML 编辑器提供内置 YAML 手册，可一边编写 YAML，一边查阅手册。YAML 手册开启自动定位，文档支持自动切换到鼠标光标定位的语法篇幅，做到随写随看，贴身“小抄”。支持 YAML 语法自动补齐 ...
- 产品推荐
- 这些文档可能帮助您