API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
基础术语
中文 释义 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 Path。复制API 在API资源列表 操作 列，选择 更多>...
API 管理
编辑 API 在 API管理 页面，在目标 API 的 操作 列，单击 编辑。在 编辑自定义API 对话框中，修改 URL 匹配规则，也可以新增 URL 匹配规则。删除 API 在 API管理 页面，在目标 API 的 操作 列，单击 删除。在提示框中，单击 确定，将该 API...
创建空间服务API
说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。复制API 在API资源列表 操作 列，选择 更多>复制，在API资源列表中生成一个新的...
使用向导模式创建三方API
说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。修改服务资源组后，会影响API Path。复制API 在API资源列表 操作 列，选择 更多>...
使用SQL模式创建数据服务API
说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。修改服务资源组后，会影响API Path。复制API 在API资源列表 操作 列，选择 更多>...
使用SQL模式创建数据服务API
说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。修改服务资源组后，会影响API Path。复制API 在API资源列表 操作 列，选择 更多>...
产品数据API
编辑产品数据API 对于产品快照数据查询API和产品原始数据查询API，支持编辑API名称、入参和出参。在 数据API 页面，单击 产品数据API 页签。在API列表，找到目标产品的快照数据查询API或原始数据查询API，单击右侧 操作 列的 编辑。在 编辑...
使用向导模式创建数据服务API
说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。修改服务资源组后，会影响API Path。复制API 在API资源列表 操作 列，选择 更多>...
使用向导模式创建数据服务API
说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。修改服务资源组后，会影响API Path。复制API 在API资源列表 操作 列，选择 更多>...
数据服务API
区域 描述 ① 单击 编辑API 跳转至API所属工作空间的编辑窗口进行API编辑。详情请参见 发布API 和 注册API。说明：如果当前登录账号不在API所属的工作空间中，请联系目标工作空间对应管理员将您的账号添加到目标空间的成员列表中并赋予...
管理参数映射
需前往 API 编辑页面，将对应 API 的参数映射规则替换为其他规则后，方可编辑当前参数映射规则。您可以通过以下任一方式编辑参数映射规则：在参数映射列表中，找到目标规则，单击右侧 操作 列中的 编辑 按钮。在参数映射的详情页，单击右上...
数据服务权限列表
Y Y Y Y 交还Dataphin数据源 Y Y Y Y 查看应用列表 Y Y Y Y 创建应用 Y N Y Y 编辑应用 Y N 应用责任人：Y 非应用责任人：N 应用责任人：Y 非应用责任人：N 删除应用 Y N 应用责任人：Y 非应用责任人：N 应用责任人：Y 非应用责任人：N ...
管理系统集群
绑定的API：列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息，例如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 ...
管理路由规则
需前往 API 编辑页面，将对应 API 的路由规则替换为其他路由规则后，方可编辑当前路由规则。在 路由规则 页面，通过以下任一方式打开路由规则编辑界面：在路由规则列表页，单击路由规则右侧 操作 列中的 编辑 即可打开路由规则编辑界面。...
配置API触发
设置API触发 打开流水线编辑界面，具体操作参见 打开流水线编辑界面。在流水线编辑界面，单击 触发条件 阶段>API触发 选项的，打开 API触发配置 右侧栏。在 API触发配置 右侧栏，打开 是否开启 开关键，启用API触发，生成webhook地址。单击...
管理API端点
本文介绍如何创建、查看、编辑、...编辑API端点：在已创建的API端点右侧 操作 列单击 编辑 修改API端点的描述和API配置。删除API端点：在已创建的API端点右侧 操作 列单击 删除，然后阅读 提示 对话框内的信息，单击 确定，即可删除此端点。
CreatePipeline-创建流水线
创建流水线API，支持创建YAML化流水线。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求语法 POST/...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
DataWorks数据服务
本文为您介绍交互式分析Hologres如何连接DataWorks数据服务并生成API。前提条件 开通DataWorks，详情请参见 入门概述。开通Hologres实例，并绑定至DataWorks工作空间。背景信息 DataWorks数据服务旨在为您搭建统一的数据服务总线，支持快速...
通过脚本模式生成API
数据服务支持通过脚本模式或向导模式生成API，相对于向导模式，您可以自行编写API的查询SQL，支持多表关联、复杂查询和聚合函数等功能，满足您个性化查询需求。本文为您介绍如何通过脚本模式生成API。前提条件 配置API前，请先在 工作空间...
查看、删除、移动、克隆、批量操作、代码搜索API
不能重复提交，需要进入API编辑页面，在右侧的 版本管理 里，废弃前一次提交的版本 发布 发布的前置条件是已提交，因此对于未提交API，需要先执行提交，再操作发布 发布的前置条件是已提交，因此对于未提交API，需要先执行提交，再操作发布...
通过向导模式生成API
数据服务支持通过向导模式或脚本模式生成API，相对于脚本模式，您无需编码能力，可以可视化地配置API。本文为您介绍如何通过向导模式生成API。前提条件 配置API前，请先在 工作空间管理>数据源管理 页面配置数据源。详情请参见 配置数据源...
发布API
如果您的API是为了供自己的应用程序调用，需要在API网关中创建应用，将API授权到应用中，然后通过AppKey和AppSecret加密签名调用，详情请参见 客户端调用API示例。同时API网关提供了主流编程语言的SDK，您可以快速集成API至自己的应用中，...
新建YAML流水线
编辑流水线 YAML 进入 流水线 Flow>我的流水线，找到目标 YAML 流水线，单击编辑进入流水线编辑页 左侧区域为 YAML 编辑区域，根据云效流水线 YAML语法规范 编写 YAML。单击右侧工具栏 任务，按需添加任务YAML。单击右侧工具栏 YAML手册，...
配置流水线源
在流水线编辑页，点击 添加流水线源，在 添加流水线源 弹框中选择 制品源，添加Packages服务连接，仓库类型选择通用制品（目前仅支持Packages通用制品），选择仓库、制品和默认版本。Jenkins源 Flow 支持将你的 Jenkins 服务配置为流水线源...
YAML辅助编辑器
编辑器内置 YAML 手册，随手查阅 Flow 流水线 YAML 编辑器提供内置 YAML 手册，可一边编写 YAML，一边查阅手册。YAML 手册开启自动定位，文档支持自动切换到鼠标光标定位的语法篇幅，做到随写随看，贴身“小抄”。支持 YAML 语法自动补齐 ...
流水线的配置
阶段的添加、修改与删除 在流水线编辑页面的中间部分，显示流水线各阶段。当把鼠标移动到两阶段之间的连线时，页面显示两阶段间的加号图标（下图中红色框），和一个阶段的删除图标（下图中黄色框）。点击可分别新建阶段或删除一个已有阶段...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
管理中心应用流水线
编辑三方流水线 在 流水线管理 页面的 三方流水线 页签，单击目标流水线名称或目标流水线名称右侧 操作 列下的 编辑。在 编辑第三方流水线 面板，完成相关配置项修改后，单击 保存。删除三方流水线 在 流水线管理 页面的 三方流水线 页签，...
管理代码类型组件的流水线
编辑三方流水线 在 流水线管理 页面的 三方流水线 页签，单击目标流水线名称或目标流水线名称右侧 操作 列下的 编辑。在 编辑第三方流水线 面板，完成相关配置项修改后，单击 保存。删除三方流水线 在 流水线管理 页面的 三方流水线 页签，...
管理流水线
流水线配置 流水线配置主要包括流水线触发方式、流水线执行环境、资源描述YAML、钉钉机器人通知四个配置项，其中只有流水线触发方式、流水线执行环境可以在创建应用、创建环境阶段进行配置，这四项都可以在创建成功后单击编辑按钮配置。...
管理流水线
流水线配置 流水线配置主要包括流水线触发方式、流水线执行环境、资源描述YAML、钉钉机器人通知四个配置项，其中只有流水线触发方式、流水线执行环境可以在创建应用、创建环境阶段进行配置，这四项都可以在创建成功后单击编辑按钮配置。...
API 概览
流水线控制 API 名称 描述 运行流水线 运行流水线 终止运行流水线 可以取消运行流水线 删除流水线成员 可以删除流水线成员 更新流水线成员 可以更新流水线成员 增加流水线成员 可以增加流水线成员 使用流水线模板创建流水线 使用流水线模板...
创建 H5 离线包
在创建 H5 离线包资源时，您需要填写基本信息和配置信息。前置任务 您已经在配置管理页面，完成 H5 离线包相关配置。详细信息，参见 配置离线包。关于此任务 您可以选择单个创建 H5 离线包，也可以选择以批量导入 H5 离线包文件的方式一次...
- 产品推荐
- 这些文档可能帮助您