API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
管理流水线
本文介绍新建、编辑、查看流水线等基本操作。新建流水线 进入 流水线 Flow>我的流水线，点击 新建流水线。根据你的开发语言和部署场景，选择合适的流水线模板，单击 创建 即可完成一条流水线创建，创建完成会自动进入流水线编辑页面。编辑...
管理参数映射
需前往 API 编辑页面，将对应 API 的参数映射规则替换为其他规则后，方可编辑当前参数映射规则。您可以通过以下任一方式编辑参数映射规则：在参数映射列表中，找到目标规则，单击右侧 操作 列中的 编辑 按钮。在参数映射的详情页，单击右上...
管理系统集群
需前往 API 编辑页面，将对应 API 的系统集群替换为其他系统集群后，方可编辑当前系统集群。您可以通过以下任一方式编辑系统集群：在系统集群列表中，找到目标集群，单击右侧 操作 列中的 编辑 按钮。在系统集群的详情页，单击右上角的 ...
管理路由规则
需前往 API 编辑页面，将对应 API 的路由规则替换为其他路由规则后，方可编辑当前路由规则。在 路由规则 页面，通过以下任一方式打开路由规则编辑界面：在路由规则列表页，单击路由规则右侧 操作 列中的 编辑 即可打开路由规则编辑界面。...
使用批量方式创建三方API
相关操作 操作项 说明 编辑API 在API资源列表中，单击目标API 操作 列的 编辑，在API编辑向导页面，可对API进行编辑修改。说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果...
DataWorks数据服务
在API编辑页面，单击顶部菜单栏右侧的 测试。在 API测试 对话框，输入 请求参数，单击 开始测试。如果 API测试 对话框页面底部显示 测试成功，则表示API测试通过。您也可以使用数据服务的测试API模块来完成测试，详情请参见 测试API。发布...
查看、删除、移动、克隆、批量操作、代码搜索API
如果API未发布，您可以单击该API编辑页面右侧的 属性，查看其基本信息。克隆API 您可以为API创建副本，存放至目录树的指定路径下：在 服务开发 页面，展开目标API所在的 业务流程>API。右键单击相应的API名称，选择 克隆。在 API克隆 ...
通过脚本模式生成API
说明 当数据服务的API在编辑页面右侧导航栏的 返回参数 已经开启了 返回结果分页，如果您在该API编辑页面的 编写查询SQL 区域，使用SQL语句配置了 limit 限制（即返回结果的条数限制），则该 limit 限制不生效，返回结果的条数限制仍然会以...
创建空间服务API
相关操作 操作 说明 编辑API 在API资源列表中，单击目标API 操作 列的 编辑，在API编辑向导页面，可对API进行编辑修改。说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致...
发布API
如果您的API是为了供自己的应用程序调用，需要在API网关中创建应用，将API授权到应用中，然后通过AppKey和AppSecret加密签名调用，详情请参见 客户端调用API示例。同时API网关提供了主流编程语言的SDK，您可以快速集成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 跳转至API所属工作空间的编辑窗口进行API编辑。详情请参见 发布API 和 注册API。说明：如果当前登录账号不在API所属的工作空间中，请联系目标工作空间对应管理员将您的账号添加到目标空间的成员列表中并赋予开发...
使用向导模式创建数据服务API
相关操作 操作项 说明 编辑API 在API资源列表中，单击目标API 操作 列的 编辑，在API编辑向导页面，可对API进行编辑修改。说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果...
使用向导模式创建数据服务API
相关操作 操作项 说明 编辑API 在API资源列表中，单击目标API 操作 列的 编辑，在API编辑向导页面，可对API进行编辑修改。说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果...
CreatePipeline-创建流水线
创建流水线API，支持创建YAML化流水线。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求语法 POST/...
管理 API 分组
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
API概览
流水线 API 标题 API概述 服务连接 服务连接 CreateServiceConnection 创建服务连接 创建服务连接 CreateServiceAuth 创建服务授权 创建服务授权 CreateServiceCredential 创建服务证书 创建用户名密码类型的证书 ListServiceCredentials ...
管理 API 渠道
API 引入指按照 API 引入协议实现内容的同步。进行内容同步前，需要先创建 API 引入渠道，完成 API 配置。...编辑 API 渠道 在 API 列表中，找到要编辑的 API，单击 操作 列下的 编辑 菜单，编辑 API 信息。重要 API 标识一旦创建，不可修改。
API 管理
在 AHAS 网关流控中，您可以创建 API 分组，并自定义每个 API 下面的 URL 路径匹配规则。AHAS 网关流控可以针对自定义的 API 分组进行流量控制。新建自定义 API 按照以下步骤新建需要流控的 API 分组。登录 AHAS 控制台。在 AHAS 控制台...
产品数据API
产品数据API包括产品下设备的快照数据API、原始数据API和事件数据API，您可以新建指定的产品数据API后，调用对应API获取产品下指定设备的原始数据、快照数据或事件数据。本文介绍如何新建和编辑产品数据API。前提条件 已创建产品和设备。...
管理API端点
本文介绍如何创建、查看、编辑、删除连接配置和API端点，帮助您快速集成其他应用。前提条件 开通事件总线EventBridge并授权 背景信息 API端点（API Destinations）可以帮助您调用第三方SaaS系统或自建系统的HTTP接口，提供低代码的接入方式...
配置API触发
设置API触发 打开流水线编辑界面，具体操作参见 打开流水线编辑界面。在流水线编辑界面，单击 触发条件 阶段>API触发 选项的，打开 API触发配置 右侧栏。在 API触发配置 右侧栏，打开 是否开启 开关键，启用API触发，生成webhook地址。单击...
数据服务权限列表
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 查看...
YAML辅助编辑器
云效 Flow 基于流水线 YAML 语法提供辅助编辑能力，提供常用流水线、常用任务 YAML 模板，提供内置 YAML 手册随手查阅，支持 YAML 语法自动补齐、实时校验并推荐修复方案，以及多种快捷键操作等，帮助提升 YAML 编写效率。提供常用流水线 ...
新建YAML流水线
编辑流水线 YAML 进入 流水线 Flow>我的流水线，找到目标 YAML 流水线，单击编辑进入流水线编辑页 左侧区域为 YAML 编辑区域，根据云效流水线 YAML语法规范 编写 YAML。单击右侧工具栏 任务，按需添加任务YAML。单击右侧工具栏 YAML手册，...
流水线的配置
本文介绍流水线的配置。若您尚不熟悉云效流水线服务，推荐从 流水线概述 开始阅读。流水线的添加、修改与删除 当进入一个项目后，左侧菜单栏的“流水线”菜单项，是流水线的入口。（如果左侧菜单栏没有出现“流水线”菜单项，请前往“设置...
配置流水线源
在流水线编辑页，点击 添加流水线源，在 添加流水线源 抽屉中选择 Flow流水线，选择 源流水线 和 默认版本，当流水线被执行时就会下载源流水线默认版本的构建产物。同时，流水线之间也支持自动触发，打开 触发事件 开关，可选择自动触发的...
版本管理
API编辑完成后，需要发布API到测试，预发或者线上，API才能进行调用新的版本。说明 当您需要编辑某个API的定义时，如果该API已经发布，对定义的修改不会对线上产生影响，定义修改后需要再次发布才能把修改后的定义同步到线上环境。2 对比...
管理中心应用流水线
编辑三方流水线 在 流水线管理 页面的 三方流水线 页签，单击目标流水线名称或目标流水线名称右侧 操作 列下的 编辑。在 编辑第三方流水线 面板，完成相关配置项修改后，单击 保存。删除三方流水线 在 流水线管理 页面的 三方流水线 页签，...
管理代码类型组件的流水线
编辑三方流水线 在 流水线管理 页面的 三方流水线 页签，单击目标流水线名称或目标流水线名称右侧 操作 列下的 编辑。在 编辑第三方流水线 面板，完成相关配置项修改后，单击 保存。删除三方流水线 在 流水线管理 页面的 三方流水线 页签，...
管理流水线
流水线配置 流水线配置主要包括流水线触发方式、流水线执行环境、资源描述YAML、钉钉机器人通知四个配置项，其中只有流水线触发方式、流水线执行环境可以在创建应用、创建环境阶段进行配置，这四项都可以在创建成功后单击编辑按钮配置。...
管理流水线
流水线配置 流水线配置主要包括流水线触发方式、流水线执行环境、资源描述YAML、钉钉机器人通知四个配置项，其中只有流水线触发方式、流水线执行环境可以在创建应用、创建环境阶段进行配置，这四项都可以在创建成功后单击编辑按钮配置。...
流水线配置
编辑流水线模板 在 流水线配置 页面中，选择要修改的流水线模板，单击 操作 列下的 编辑，修改模板信息或重新编排流水线。复用流水线模板 支持基于已有的流水线模板快速创建新模板。选择目标流水线模板，单击 操作 列下的 复制，修改模板...
最佳实践：API请求参数的选填设置
在API编辑页面的右侧导航栏中，单击 请求参数。进入请求参数的详细设置面板，在请求参数的列表中，对目标请求参数勾选是否必填的配置项，如下图所示：勾选：表示调用API时必须对参数传入具体的值，否则将会出现参数校验异常，导致API调用...
- 产品推荐
- 这些文档可能帮助您