Skip to main content

可迁移的端点

注意

此帮助页面介绍了 Server API 端点的用法。要开始使用 Server API,请先访问 Server API 概述API 概述

使用可迁移的端点跨 Server 环境迁移工作流。您可以使用它来管理开发和测试阶段的工作流部署。

首先,必须启用迁移工作流。将工作流标记为进行迁移后,请按照以下步骤将它们从源环境发布到目标环境的相应订阅(工作室)中。

第 1 步:获取准备迁移的工作流列表

接下来,使用以下端点获取准备迁移的工作流列表:

  • 环境:Source(来源)

  • 方法:GET

  • 端点:webapi/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/

包括逗号分隔的 subscriptionIds 列表作为查询参数。订阅 ID 用于标识特定的工作室。

返回的结果是在指定订阅(工作室)下标记为准备迁移的工作流数组。如果不提供 subscriptionsIds,返回的结果将包括所有标记为准备迁移的工作流。返回结果包括 3 个属性:appId、当前发布的 revisionId 和工作流所属的 subscriptionID

第2步:从源环境下载工作流

以下端点将工作流下载为 YXZP 文件。

  • 环境:Source(来源)

  • 方法:GET

  • 端点:webapi/admin/v1/{appID}/package/

包括 appID 作为路径参数。返回结果是一个下载包形式的完整工作流。

第 3 步:在目标环境中发布工作流

以下端点将下载的工作流发布到目标环境。

  • 环境:Target(目标)

  • 方法:POST

  • 端点:webapi/admin/v1/workflows/

参数

参数

描述

类型

必填

file(文件)

新工作流的文件名。

字符串

True

name(名称)

新工作流名称。

字符串

True

owner(所有者)

已迁移工作流的所有者。电子邮件地址必须存在于目标环境中。

字符串

True

validate(验证)

此标记用于在迁移到目标环境时验证工作流。

布尔值

True

isPublic

此标记用于将工作流设置为公开,以在目标环境中的“我的公司的 Server”中显示。

布尔值

True

sourceId

这是要迁移的工作流的源环境 appId。如果存在具有相同 sourceId 的工作流,该工作流的版本号将递增。否则,将生成新的工作流。

(如果不希望指定 appID,请发送空字符串。)

字符串

True

workerTag

将工作程序标签添加到工作流,来让特定工作程序运行工作流。

(如果不希望指定工作程序,请发送空字符串。)

字符串

True

canDownload

此标记用于将工作流设置为可供目标环境中的其他用户下载。

布尔值

True

(可选)第 4 步:在源环境中重置迁移设置工作流

如果需要,您可以在目标环境中迁移工作流后,使用可迁移的端点将源环境中工作流的此工作流已为迁移准备就绪设置切换回

  • 环境:Source(来源)

  • 方法:PUT

  • 端点:webapi/admin/v1/workflows/migratable/{appID}/