DataStage 命令行工具

在线编辑

CPDCTL 和 dsjob 工具是命令行界面 (CLI)，您可以用它们来管理 中的资源。 DataStage®IBM Cloud Pak for Data 中的资源。

使用命令行工具来复用系统上存在的任何 DataStage 脚本。
您可以使用以下命令行工具来运行 DataStage 任务:
  • CPDCTL: cpdctl dsjob 或 cpdctl datastage
通过使用 CLI 工具，您可以使用:

资源

有关安装、配置、可用命令、支持的输出和使用场景，请参阅 IBM Cloud Pak for Data 命令行界面。

有关 CPDCTL 命令的更多信息，请参阅 IBM Cloud Pak for Data 命令行界面。

有关安装，配置和使用 DataStage 作业命令行界面的详细信息，请参阅 安装。

要创建概要文件并启用 dsjob ，请使用以下脚本。

对于 Cloud Pak for Data as a Service:
#!/bin/bash
export DSJOB_URL=https://dataplatform.cloud.ibm.com
export CPDCTL_ENABLE_DSJOB=true
DSJOB_APIKEY=<YOUR APIKEY>
cpdctl config profile set ibmcloud-profile --url $DSJOB_URL --apikey $DSJOB_APIKEY --watson-studio-url https://api.dataplatform.cloud.ibm.com
对于 IBM Cloud Pak® for Data :
#!/bin/bash
export DSJOB_URL=<CP4D CLUSTER URL>
export DSJOB_USER=<USER>
export DSJOB_PWD=<PASSWD>


cpdctl config user set CP4D-user --username $DSJOB_USER --password $DSJOB_PWD
cpdctl config profile set CP4D-profile --url $DSJOB_URL --user CP4D-user
cpdctl config profile use CP4D-profile
如果您有多个概要文件，那么可以使用 cpdctl project list --profile <PROFILE> 或 CPD_PROFILE=<PROFILE> cpdctl project list对特定概要文件运行命令。 例如，要在概要文件中运行多个命令而不更改缺省概要文件，可以运行以下命令。
export CPD_PROFILE=<PROFILE-1>
cpdctl project list
cpdctl ....
export CPD_PROFILE=<PROFILE-2>
cpdctl project list
cpdctl ....
unset CPD_PROFILE <go back to default profile>

命令

注意： 要启用 cpdctl dsjob 命令，必须在安装命令行界面的环境中将环境变量 CPDCTL_ENABLE_DSJOB 设为 true 。 IBM Cloud Pak for Data 安装命令行界面的环境中，将环境变量 CPDCTL_ENABLE_DSJOB 设为。
注: 设置 dsjob 命令行环境时，必须对任何特殊字符 ($， ") 进行转义 在密码中使用反斜杠。 例如， myPa$$word 必须编写为 myPa\$\$word。
列出项目
以下语法显示指定项目上所有已知项目的列表:
cpdctl dsjob list-projects [--sort|--sort-by-time] [--with-id]
  • 指定时， with-id 将打印项目标识和项目名称。
  • 指定时， sort 将返回按字母顺序排序的项目列表。 此字段是可选字段。
  • 指定时， sort-by-time 按创建或更新时间对列表进行排序。 可以指定 sort 或 sort-by-time 之一。

将显示所有项目的列表，每行一个项目。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建项目
以下语法用于创建项目:
cpdctl dsjob create-project -n NAME
  • name 是要创建的项目的名称。

已创建项目的项目标识将打印到输出中。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除项目
以下语法用于删除项目:
cpdctl dsjob delete-project {--project PROJECT | --project-id PROJID}
  • project 是要删除的项目的名称。
  • project-id 是要删除的项目的标识。 必须指定 project 或 project-id 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出作业
以下语法显示指定项目中所有作业的列表：
cpdctl dsjob list-jobs {--project PROJECT | --project-id PROJID} [--sort] [--with-id]
  • project 是包含要列示的作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • 指定时， sort 将返回按字母顺序排序的作业列表。 此字段是可选字段。
  • 指定时， with-id 将打印作业标识以及作业的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建作业
以下语法在指定的项目中创建作业:
cpdctl dsjob create-job {--project PROJECT | --project-id PROJID} {--flow NAME | --flow-id ID} [--name NAME] [--description DESCRIPTION] [--schedule-start yyyy-mm-dd:hh:mm] [--schedule-end yyyy-mm-dd:hh:mm] [--repeat every/hourly/daily/monthly --minutes (0-59) --hours (0-23) --day-of-week (0-6) --day-of-month (1-31)]
  • project 是为其创建作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的作业的名称。
  • description 是要创建的作业的描述。 此字段是可选字段。
  • flow 是流的名称。 必须指定此字段。
  • repeat 指示作业运行的频率。 允许的值为 every， hourly， daily， weekly和 monthly。 缺省值为 none。
  • minutes 指示运行作业的时间间隔 (以分钟计) 或分钟数。 接受范围 0-59 中的值。
  • hours 指示运行作业的时间。 接受范围 0-23 中的值。
  • day-of-month 在每月的某一天重复，使用分钟和小时。 接受范围 0-31 中的值。 例如: 2 (在月份的第二个月运行)。
  • schedule-start 是调度作业的开始时间。
  • schedule-end 是调度作业的结束时间。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取作业
以下语法从指定的项目中按名称访存作业:
cpdctl dsjob get-job {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是包含作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是查询的作业的名称。
  • id 是作业的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除作业
以下语法按名称从指定项目中删除作业:
cpdctl dsjob delete-job {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是包含作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要删除的作业的名称。
  • id 是作业的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

更新作业
以下语法按名称更新指定项目中的作业:
cpdctl dsjob update-job {--project PROJECT | --project-id PROJID} {--job NAME | --job-id ID} [--run-name RUNNAME] [--param PARAM] [--param-file FILENAME] [--env ENV]
  • project 是包含作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • job 是作业的名称。
  • job-id 是作业的标识。 必须指定 job 或 job-id 之一。
  • run-name 是提供给作业运行的名称。
  • param 指定要传递给作业的参数值。 值的格式为 name=value，其中 name 是参数名称， value 是要设置的值。 此标志可以重复，例如: --param k1=v1 --param k2=v2
  • paramfile 指定包含要传递给作业的参数值的文件。 此字段当前未实现。
  • env 指定运行作业的环境。 env 指定为 "键/值" 对。 可以使用键 "env" 或 "env-id" 来选择运行时环境。 示例： --env $APT_DUMP_SCORE=true --env env=ds-px-default

状态码将打印到输出中。 状态码 0 指示命令成功完成。

清除孤立作业
以下语法将删除因删除其相应流而孤立的 DataStage 作业:
cleanup-jobs [--project PROJECT | --project-id PROJID] --dry-run"
  • project 是包含作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • dry-run 设置为 true时，将尝试在不删除作业的情况下试运行。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

显示作业信息
以下语法显示有关指定作业的可用信息：
cpdctl dsjob jobinfo {--project PROJECT | --project-id PROJID} {--job NAME | --job-id ID}  [--full] [--list-params]
  • project 是包含作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • job 是作业的名称。
  • job-id 是作业的标识。 必须指定 job 或 job-id 之一。
  • full 显示有关作业的更详细信息，包括有关所有作业运行的信息。 此字段是可选字段。
  • list-params 显示作业级别配置/局部参数和环境变量。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

运行作业
您可以使用 run 命令来启动，停止，验证和重置作业。 运行操作本质上是异步的，状态代码表示作业运行是否成功提交，除非指定了 --wait 选项。 请参阅 --wait 标志说明，了解行为如何变化。
cpdctl dsjob run {--project PROJECT | --project-id PROJID} {--job NAME | --job-id ID} --run-name RUNNAME] [--param PARAM] [--param-file FILENAME] [--env ENVJSON] [--paramset PARAMSET] [--wait secs] [--warn-limit <n>]
  • project 是包含作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • job 是作业的名称。
  • job-id 是作业的标识。 必须指定 job 或 job-id 之一。
  • run-name 是提供给作业运行的名称。
  • param 指定要传递给作业的参数值。 值的格式为 name=value，其中 name 是参数名称， value 是要设置的值。 此标志可以重复，例如: --param k1=v1 --param k2=v2
  • paramfile 指定包含要传递给作业的参数值的文件。 当前未实现此字段。
  • env 指定运行作业的环境。 env 指定为 "键/值" 对。 可以使用键 "env" 或 "env-id" 来选择运行时环境。 示例： --env $APT_DUMP_SCORE=true --env env=ds-px-default
  • paramset 指定要传递到作业运行的参数集/值集字段。 有三个变体: 1。 --paramset PS1 将参数集 PS1 中的所有字段作为作业参数发送到运行 2。 --paramset PS2.VS2 将值集值作为作业参数 3 发送。 --paramset PS1=PROJFDEF 覆盖 paramset PS1 PROJDEF 中的值，并将参数集 PS1 中所有字段的值作为作业参数发送到运行。
  • wait 作业运行将等待指定的作业完成时间量。 将作业记录打印到输出，直到作业完成或等待时间到期。 返回状态指示作业是否已完成，已完成但有警告，发生错误或等待后超时。 此字段是可选字段。
  • warn-limit 指定在此之后终止作业的警告数。

当 job 参数以 $ 开头时，还会将其添加为环境变量。

状态码将打印到输出中。
  • 0: 已成功完成
  • 1: 已完成，但有警告
  • 2: 已完成，但有错误
  • 3: 失败
  • 4: 已取消
  • -1 其他
停止作业
您可以使用 stop 命令来停止或取消正在运行的作业。 停止操作在本质上是异步的，状态码指示是否成功提交了作业停止。
cpdctl dsjob stop {--project PROJECT | --project-id PROJID} {--job NAME | --job-id ID} [--run-id RUNID]
  • project 是包含作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • job 是作业的名称。
  • job-id 是作业的标识。 必须指定 job 或 job-id 之一。
  • 可以指定 runid 以取消或停止现有作业运行。 如果未指定 runid ，那么缺省情况下将使用未完成的最新作业运行的 runid 。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

显示特定日志条目
以下语法显示作业日志文件中的指定条目：
cpdctl dsjob logdetail {--project PROJECT | --project-id PROJID} {--job NAME | --job-id ID} [--run-id RUNID] [--eventrange EVENTRANGE] [--compatible] --follow
  • project 是包含具有指定日志条目的作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • job 是作业的名称。
  • job-id 是作业的标识。 必须指定 job 或 job-id 之一。
  • runid 处理特定 runid的日志条目。 如果未指定 runid ，那么缺省情况下将使用最新运行。 此字段是可选字段。
  • eventrange 是分配给打印到输出的条目的事件编号范围。 文件中的第一个条目为 0。 如果未指定 eventrange ，那么将处理完整日志。 例如，如果指定 eventrange 2-4，那么将打印日志中的第三个，第四个和第五个条目。
  • compatible 将以 DataStage 组件先前使用的格式输出日志。 此字段是可选字段。
  • 指定时， follow 将启用日志跟踪。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

显示简短日志条目
以下语法显示作业日志文件中条目的摘要：
cpdctl dsjob logsum {--project PROJECT | --project-id PROJID} {--job NAME | --job-id ID} [--run-id RUNID] [--type TYPE] [--max MAX] [--compatible]
  • project 是包含作业以及要检索的日志条目的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • job 是作业的名称。
  • job-id 是作业的标识。 必须指定 job 或 job-id 之一。
  • runid 处理特定 runid 的日志条目。 如果未指定 runid ，那么缺省情况下将使用最新运行。 此字段是可选字段。
  • type 指定要检索的日志条目的类型。 如果未指定 type ，那么将检索所有条目。 type 可以是以下某个选项：
    • 信息: 信息
    • 警告: 警告
    • 致命错误
    • 拒绝拒绝来自 Transformer stage
    • STARTED: 所有控制日志
    • RESET: 作业重置
    • BATCH: 批处理控件
    • ANY: 任何类型的所有条目。 如果未指定 type ，那么此选项是缺省值。
  • compatible 将以 DataStage 组件先前使用的格式输出日志。 此字段是可选字段。
  • max n 将检索到的条目数限制为 n。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

标识最新日志条目
以下语法显示指定类型的最新日志条目的标识：
cpdctl dsjob lognewest {--project PROJECT | --project-id PROJID} {--job NAME | --job-id ID} [--run-id RUNID] [--type TYPE]
  • project 是包含具有要检索的日志条目的作业的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • job 是作业的名称。
  • job-id 是作业的标识。 必须指定 job 或 job-id 之一。
  • type 可以是以下某个选项：
    • 信息: 信息
    • 警告: 警告
    • 致命错误
    • 拒绝拒绝来自 Transformer stage
    • STARTED: 所有控制日志
    • RESET: 作业重置
    • BATCH: 批处理控件

状态码将打印到输出中。 状态码 0 指示命令成功完成。

获取作业运行统计信息
以下语法获取项目中特定作业运行的作业运行统计信息:
cpdctl dsjob jobrunstat {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}  [--run-id RUNID] [--all] [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是作业的名称。
  • id 是作业的标识。 必须指定 name 或 id 之一。
  • run-id 是特定作业运行的运行标识。 此字段是可选的，如果省略此字段，那么将显示最后一个作业运行统计信息。
  • all 将显示作业的所有运行的统计信息。 使用此标志时，将忽略 run-id 。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

修剪作业运行
修剪命令可用于根据运行时间或运行次数删除作业运行。 可以使用以下语法来修剪在项目中运行的作业:
cpdctl dsjob prune {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--keep-runs NUMRUNS] [--keep-days NUMDAYS] [--threads n] [--dry-run]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是作业的名称。
  • id 是作业的标识。 必须指定 name 或 id 之一。
  • keep-runs 指定要保留和删除其余作业运行清除空间的最新运行数。
  • keep-days 指定天数，并删除早于该数字的所有作业运行。
  • threads 指定要对每个作业运行一个并行并发清除例程的数目。 该值应该在 5-20 范围内，缺省值为 5。 此字段是可选字段。
  • dry-run 执行模拟运行而不删除作业运行。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取作业运行清除
可以使永不完成的作业运行保持旧的状态。 这些作业处于 "正在启动" 或 "正在运行" 状态。 以下语法将清除项目中的作业运行:
cpdctl dsjob jobrunclean {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--run-id RUNID] [--dry-run] [--threads n]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是作业的名称。
  • id 是作业的标识。 必须指定 name 或 id 之一。
  • run-id 是要清除的特定作业运行的运行标识。 此字段是可选字段。
  • threads 指定要对每个作业运行一个并行并发清除例程的数目。 该值应该在 5-20 范围内，缺省值为 5。 此字段是可选字段。
  • dry-run 执行模拟运行而不删除作业运行。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示作业运行
以下语法列出了针对指定作业运行的作业:
cpdctl dsjob list-jobruns {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--detail] [--output file|json] [--file-name FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是作业的名称。
  • id 是作业的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取作业运行
以下语法从指定的作业获取作业运行详细信息:
cpdctl dsjob get-jobrun {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--run-id RUNID] [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是作业的名称。
  • id 是作业的标识。 必须指定 name 或 id 之一。
  • run-id 是作业运行的标识。
  • output 指定输出的格式。 您可以生成 JSON 或输出到文件。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 如果未指定，那么将使用作业运行标识作为名称。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示活动作业运行
以下语法列出了所有活动作业运行，包括未完成，已取消和失败的作业:
cpdctl dsjob list-active-runs [--sort-by-time|--sort-by-jobname|--sort-by-assettype|--sort-by-duration|--sort-by-state] [--output json|file] [--file-name FILENAME]
  • sort-by-time 列出按创建或更新时间排序的作业。
  • sort-by-jobname 列出按作业名按字母顺序排序的作业。
  • sort-by-assettype 列出按作业类型排序的作业。
  • sort-by-duration 列出按作业处于活动状态的持续时间排序的作业。
  • sort-by-state 列出按作业运行状态排序的作业。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

迁移作业
"迁移" 命令可用于从导出的 ISX 文件创建数据流。 您可以使用该命令来检查状态或取消正在进行的迁移。
cpdctl dsjob migrate {--project PROJECT | --project-id PROJID} [--on-failure ONFAILURE] [--conflict-resolution CONFLICT-RESOLUTION] [--attachment-type ATTACHMENT-TYPE] [--import-only] [--create-missing] [--enable-local-connection] [--enable-dataquality-rule] [--create-connection-paramsets] [--file-name FILENAME] [--status IMPORT-ID --format csv/json] [--stop IMPORT-ID] --wait secs
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • on-failure 指示导入过程失败时要执行的操作。 可能的选项为 continue 或 stop。 此字段是可选字段。
  • conflict-resolution 指定要导入的数据流与项目或目录中的现有数据流发生名称冲突时的解决方案。 可能的解决方案为 skip， rename或 replace。 此字段是可选字段。
  • attachment-type 是附件类型。 缺省附件类型为 isx。 此字段是可选字段。
  • 当指定时， import-only 将导入流，而不进行编译或创建作业。
  • 指定时， create-missing 将创建缺少的参数集和作业参数。
  • enable-local-connection 支持将连接作为流连接迁移到流中。
  • 指定时， enable-dataquality-rule 会将数据规则从 Information Analyzer 迁移为 Watson Knowledge Catalog 规则。
  • 指定时， create-connection-paramsets 将为连接中缺少的属性创建参数集。
  • file-name 是输入文件的名称。 此字段是导入操作所必需的，但不包含选项 -stop 或 -status。
  • status 返回先前提交的导入作业的状态。 必须使用此选项指定 importid 的值。
  • stop 取消正在进行的导入操作。 必须使用此选项指定 importid 的值。
  • wait 指定等待命令完成的时间 (以秒计)。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出流
以下语法显示指定项目中所有流的列表:
cpdctl dsjob list-flows {--project PROJECT | --project-id PROJID} [--sort|--sort-by-time] [--with-id]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • 指定时， sort 将返回按字母顺序排序的流列表。 此字段是可选字段。
  • 指定时， sort-by-time 按创建或更新时间对列表进行排序。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印流标识以及流的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建流
以下语法在指定的项目中创建流:
cpdctl dsjob create-flow {--project PROJECT | --project-id PROJID} --name NAME [--description DESCRIPTION] [--pipeline-file FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的流的名称。
  • description 是要创建的流的描述。 此字段是可选字段。
  • pipeline-file 是包含流 JSON 的文件的名称。 必须指定此字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取流
以下语法从指定的项目中按名称访存流:
cpdctl dsjob get-flow {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是查询的流的名称。
  • id 是流的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除流
以下语法从指定的项目中按名称删除流:
cpdctl dsjob delete-flow {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是流的名称。
  • id 是流的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

编译流
以下语法允许您编译指定项目中的流:
cpdctl dsjob compile {--project PROJECT | --project-id PROJID} [{--name NAME | --id ID}...] [--osh] [--threads <n>]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是流的名称。
  • id 是流的标识。 可以指定 name 或 id 之一。 可以为 name 和 id 指定多个值以编译多个项，格式为 --name NAME1 --name NAME2...。 名称可以是有效的正则表达式，例如: Flow.*, ^.*THIS.* 如果不存在，那么将编译项目中的所有流。
  • osh 输出将显示已编译的 "osh" 输出。 此字段是可选字段。
  • threads 指定要运行的并行编译数。 该值应该在 5-20 范围内，缺省值为 5。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出管道
以下语法显示指定项目中所有管道的列表:
cpdctl dsjob list-pipelines {--project PROJECT | --project-id PROJID} [--sort | --sort-by-time] [--with-id]
  • project 是包含要列示的管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有管道的列表，每行一个管道。
  • 指定时， sort 将返回按字母顺序排序的管道列表。 此字段是可选字段。
  • sort-by-time 指定时，将按创建时间对管道列表进行排序，最晚在列表顶部。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印管道标识以及管道的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取管道
以下语法从指定的项目中按名称访存管道:
cpdctl dsjob get-pipeline [--project PROJECT | --project-id PROJID] [--name name | --id ID] [--output file] [--file-name <name>]
  • project 是包含管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是管道的名称。
  • id 是管道的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除管道
以下语法按名称从指定的项目中删除管道:
cpdctl dsjob delete-pipeline {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是包含管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要删除的管道的名称。
  • id 是管道的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

导入管道
以下语法将管道导入到指定的项目中:
cpdctl dsjob import-pipeline [--project PROJECT | --project-id PROJID] --name name [description DESCRIPTION] [--volatile] --file-name FILENAME
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是管道的名称。
  • description 是管道的描述。
  • 指定时， volatile 将创建管道的试用版。
  • file-name 是包含管道 JSON 的文件的名称。 必须指定此字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

导出管道
以下语法将管道从指定项目导出到文件:
cpdctl dsjob export-pipeline [--project PROJECT | --project-id PROJID] [--name name | --id ID] [--format TEMPLATE|FLOW|ALL] [--output file] [--file-name <name>]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是管道的名称。
  • id 是管道的标识。 必须指定 name 或 id 之一。
  • format 指定是导出管道模板和/或管道流。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定要将导出的管道 JSON 写入的文件的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出管道版本
以下语法显示指定项目中所有管道版本的列表:
cpdctl dsjob list-pipeline-versions {--project PROJECT | --project-id PROJID} [--sort | --sort-by-time]
  • project 是包含管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有管道版本的列表，每行一个。
  • name 是管道的名称。
  • id 是管道的标识。 必须指定 name 或 id 之一。
  • 指定时， sort 将返回按字母顺序排序的管道版本列表。 此字段是可选字段。
  • sort-by-time 指定时，将按创建时间对管道版本列表进行排序，最新版本位于列表顶部。 可以指定 sort 或 sort-by-time 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出管道运行
以下语法显示指定项目中所有管道运行的列表:
cpdctl dsjob list-pipeline-runs [--project PROJECT | --project-id PROJID] [--name name | --id ID] [--sort | --sort-by-time] [--detail] [--output file|json] [--file-name FILENAME]
  • project 是包含管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有管道运行的列表，每行一个。
  • name 是管道的名称。
  • id 是管道的标识。 必须指定 name 或 id 之一。
  • 指定时， sort 将返回按字母顺序排序的管道运行列表。 此字段是可选字段。
  • sort-by-time 指定时，将按创建时间对管道运行列表进行排序，最晚在列表顶部。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， detail 将打印管道运行详细信息。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建和调度管道作业

以下语法在指定的项目中创建管道作业:

cpdctl dsjob create-pipeline-job {--project PROJECT | --project-id PROJID} {--pipeline NAME | --pipeline-id ID} [--name NAME] [--description DESCRIPTION] [--schedule-start yyyy-mm-dd:hh:mm] [--schedule-end yyyy-mm-dd:hh:mm] [--repeat every/hourly/daily/monthly --minutes (0-59) --hours (0-23) --day-of-week (0-6) --day-of-month (1-31)] [--version n]
  • project 是包含管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • pipeline 是管道的名称。
  • pipeline-id 是管道的标识。 必须指定 pipeline 或 pipeline-id 之一。
  • name 是要创建或使用的作业的名称。 此字段是可选字段。
  • description 是作业的描述。 此字段是可选字段。
  • schedule-start 是调度作业的开始时间。
  • schedule-end是调度作业的结束时间。
  • repeat 指定作业运行的频率。 允许的值为 every， hourly， daily， weekly和 monthly。 缺省值为 none。
  • hours 指定运行作业的时间。 接受范围 0-23 中的值。
  • day-of-week 在一周中的某一天重复，使用分钟和小时。 接受范围 0-6 中的值。 例如: 1,2 (在周一和周二运行，缺省为所有天数)。
  • day-of-month 在每月的某一天重复，使用分钟和小时。 接受范围 0-31 中的值。 例如: 2 (在月份的第二个月运行)。
状态码将打印到输出中。 状态码 0 指示命令成功完成。
运行管道

通过为管道创建作业并运行该作业来触发管道运行。 以下语法在指定的项目中运行管道:

cpdctl dsjob run-pipeline [--project PROJECT | --project-id PROJID] [--name name | --id ID] [--job-name name] [--description description] [--version VERSION] [--param PARAM] [--param-file FILENAME] [--env ENVJSON] [--paramset PARAMSET] [--wait SEC]
  • project 是包含管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是管道的名称。
  • id 是管道的标识。 必须指定 name 或 id 之一。
  • job-name 是要创建或使用的作业的名称。 此字段是可选字段。
  • description 是运行的作业的描述。
  • version 指定运行的管道的版本。
  • param 指定要传递给作业的参数值。 值的格式为 name=value，其中 name 是参数名称， value 是要设置的值。 此标志可以重复，例如: --param k1=v1 --param k2=v2
  • paramfile 指定包含要传递给作业的参数值的文件。 当前未实现此字段。
  • env 指定运行作业的环境。 env 指定为 "键/值" 对。 可以使用键 "env" 或 "env-id" 来选择运行时环境。 示例： --env $APT_DUMP_SCORE=true --env env=ds-px-default
  • 指定时， paramset 会将参数集传递到管道。
  • wait 作业运行将等待指定的作业完成时间量。 将作业记录打印到输出，直到作业完成或等待时间到期。 返回状态指示作业是否已完成，已完成但有警告，发生错误或等待后超时。 此字段是可选字段。
状态码将打印到输出中。
  • 0: 已成功完成
  • 1: 已完成，但有警告
  • 2: 已完成，但有错误
  • 3: 失败
  • 4: 已取消
  • -1 其他
打印管道运行日志
以下语法访存指定项目中管道运行的运行日志:
cpdctl dsjob get-pipeline-logs [--project PROJECT | --project-id PROJID] [--name name | --id ID] [--run-id RUNID] [--output file] [--file-name <name>]
  • project 是包含管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是管道的名称。
  • id 是管道的标识。 必须指定 name 或 id 之一。
  • 如果指定了 run-id ，那么将打印该运行标识的日志。 如果未指定，那么将打印来自最新运行的日志。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

验证管道
以下语法验证指定项目中的管道，以验证管道是否正确引用了 DataStage :
cpdctl dsjob validate-pipeline {--project PROJECT | --project-id PROJID} {--name name | --id ID} [--detail]
  • project 是包含管道的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是管道的名称。
  • id 是管道的标识。 可以指定 name 或 id 之一。 如果两者都未指定，那么将验证项目中的所有管道。
  • 指定时， detail 将生成详细输出。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在导入
以下语法将指定的项目导入到文件中:
cpdctl dsjob import {--project PROJECT | --project-id PROJID} --import-file FILENAME
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • import-file 是包含先前导出的资产的文件的名称。
状态码将打印到输出中。
  • 0: 已成功完成
  • 1: 已完成，但有警告
  • 2: 已完成，但有错误
  • 3: 失败
  • 4: 已取消
  • -1 其他
正在导出
以下语法将指定的项目导出到文件:
cpdctl dsjob export {--project PROJECT | --project-id PROJID} [--name NAME] [--description DESCRIPTION] [--export-file FILENAME] [--wait secs] [--asset-type TYPE] [--asset <name,type>...] [--all]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • asset list 是要导出的所有资产名称的列表。 格式: --asset type=assetname1,assetname2。
  • name 是导出的名称。
  • asset-type 是要导出的所有资产类型的列表，例如: --asset-type Connection --asset-type data_flow。
  • description 是导出的资产的描述。
  • export-file 是要导出到的资产的文件。
状态码将打印到输出中。
  • 0: 已成功完成
  • 1: 已完成，但有警告
  • 2: 已完成，但有错误
  • 3: 失败
  • 4: 已取消
  • -1 其他
列出导出
以下语法显示来自指定项目的所有导出的列表:
cpdctl dsjob list-exports {--project PROJECT | --project-id PROJID}
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在保存导出
以下语法将导出保存到文件。
cpdctl dsjob save-export {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} --export-file FILENAME
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是导出的名称。
  • id 是导出的标识。 必须指定 name 或 id 之一。
  • export-file 是要将导出保存到的文件的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除导出
以下语法从指定项目中删除导出:
cpdctl dsjob delete-export {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是导出的名称。
  • id 是导出的标识。 必须指定 name 或 id 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

导出 DataStage 流

以下语法将 DataStage 组件从指定项目导出到文件:

cpdctl dsjob export-project {--project PROJECT | --project-id PROJID} [--wait <n>, --file-name <PROJECTZIP>] [--include-data-assets]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • file-name 是要导出到的资产的文件。 仅当指定了 wait 并且在指定的等待超时内完成导出时，才会使用此字段。
  • wait 是等待导出完成的时间 (以秒计)。
  • include-data-assets 在导出过程中包含项目的数据资产。
状态码将打印到输出中。
  • 0: 已成功完成
  • 1: 已完成，但有警告
  • 2: 已完成，但有错误
  • 3: 失败
  • 4: 已取消
  • 5: 处于正在删除状态
  • -1 其他
正在检查流导出状态

以下语法获取正在进行的导出操作的状态。

cpdctl dsjob get-export-project {--project PROJECT | --project-id PROJID} [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

将导出保存到文件

以下语法将导出从指定项目保存到文件:

cpdctl dsjob save-export-project {--project PROJECT | --project-id PROJID} --file-name FILENAME
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • file-name 是将项目导出内容写入的文件。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

取消导出
以下语法将停止对指定项目的导出操作:
cpdctl dsjob stop-export-project {--project PROJECT | --project-id PROJID}
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

导入 .zip 文件
以下语法将 DataStage 从 .zip 文件导入到指定的项目中:
cpdctl dsjob import-zip {--project PROJECT | --project-id PROJID} [--on-failure ONFAILURE] [--conflict-resolution CONFLICT-RESOLUTION] [--skip-on-replace LIST] [--file-name FILE-NAME] [--wait-sec]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • on-failure 指示导入失败时要执行的操作。 此字段是可选字段。 缺省选项为 "继续" ，另一个选项为 "停止"。
  • conflict-resolution 指定要导入的数据流与项目或目录中的现有数据流同名时的解决方案。 此字段是可选字段。 缺省选项为 skip ，其他选项将重命名并替换。
  • skip-on-replace 指定要跳过的对象类型的列表。 以下值对对象类型有效: connection, data_intg_subflow, data_definition, parameter_set, data_asset, ds_message_handler, data_intg_build_stage, data_intg_custom_stage, data_intg_wrapped_stage, standardization_rule, ds_xml_schema_library, custom_stage_library, function_library, ds_routine, ds_match_specification, data_intg_parallel_function, data_intg_java_library, data_quality_rule, data_quality_definition。
  • file-name 是包含要导入的所有 DataStage 流和 DataStage 组件的 .zip 文件的名称。 该字段是必填字段。
  • wait-sec 等待指定的时间，并定期显示导入的状态。 -1 表示无限期等待，直到命令完成。
状态码将打印到输出中。
  • 0: 已成功完成
  • 1: 已完成，但有警告
  • 2: 已完成，但有错误
  • 3: 失败
  • 4: 已取消
  • -1 其他
从 .zip 文件获取导入请求的状态
以下语法使用 import-zip 获取导入请求的状态:
cpdctl dsjob get-import-zip {--project PROJECT | --project-id PROJID} --import-id [--format json|csv] [--file-name FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • import-id 是导入的标识。 该字段是必填字段。
  • format 指定输出文件的格式。 此字段是可选字段。 缺省值为 JSON。 另一个选项是 csv。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

导出 .zip 文件
以下语法将 DataStage 流和从属 DataStage 组件从指定项目导出到 .zip 文件:
cpdctl dsjob export-zip {--project PROJECT | --project-id PROJID} {--name FLOW | --id ID} {--pipeline SEQFLOWNAME | --pipeline-id SEQFLOWID} [--file-name FILENAME] [--no-secrets] [--no-deps] [--include-data-assets]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是流的名称。
  • id 是流的标识。 必须指定 name 或 id 之一。
  • pipeline 是流的名称。
  • pipeline-id 是流的标识。 必须指定 name 或 id 之一。
  • no-deps 指定将不导出流依赖关系。 此字段是可选字段。 缺省选项为 false。
  • no-secrets 指定将不导出私钥。 此字段是可选字段。 缺省选项为 false。
  • file-name 指定要将流导出到的 .zip 文件的名称。

  • include-data-assets 在导出过程中包含项目的数据资产。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

导出 DataStage 组件
以下语法将指定项目中的所有 DataStage 组件导出到 .zip 文件中:
cpdctl dsjob export-datastage-assets {--project PROJECT | --project-id PROJID} [--file-name <FILENAME>] [--include-data-assets]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • file-name 指定要将资产导出到的 .zip 文件的名称。
  • include-data-assets 在导出过程中包含项目的数据资产。

此调用是同步的，并打印出导出进度的状态，以及写入输出文件的独立组件的摘要。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出连接
以下语法显示指定项目中所有连接的列表:
cpdctl dsjob list-connections {--project PROJECT | --project-id PROJID} [--sort|--sort-by-time] [--with-id]
  • project 是包含要列示的连接的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有 DataStage 连接的列表，每行一个连接。
  • 指定时， sort 将返回按字母顺序排序的连接列表。 此字段是可选字段。
  • 指定时， sort-by-time 按创建或更新时间对列表进行排序。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印连接标识以及连接的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建连接
以下语法在指定的项目中创建流:
cpdctl dsjob create-connection  {--project PROJECT | --project-id PROJID} --name NAME [--description DESCRIPTION] [--datasource-type TYPE] [--country COUNTRY] [--property-file FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的连接的名称。
  • description 是要创建的连接的描述。 此字段是可选字段。
  • datasource-type 是连接的数据源类型，例如：, 等。 MySQL, DB2 AzureBlobStorage,
  • country 是连接的来源国。 缺省值为 "us"。
  • property-file 是包含连接属性的文件的名称。 必须指定此字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

获取连接
以下语法从指定的项目中按名称访存连接:
cpdctl dsjob get-connection {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是从中访存连接的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是查询的连接的名称。
  • id 是连接的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 是输出写入的输出文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除连接
以下语法从指定的项目中按名称删除连接:
cpdctl dsjob delete-connection {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是要从中删除连接的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是连接的名称。
  • id 是连接的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

更新连接
以下语法按名称更新来自指定项目的连接:
cpdctl dsjob update-connection {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--property name=value]... [--file-name PROPERTYFILE] [--make-personal]
  • project 是包含连接的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是连接的名称。
  • id 是连接的标识。 必须指定 name 或 id 之一。
  • property 指定要更新的特定属性。 该值的格式为 name=value，其中 name 是连接属性的名称， value 是要设置的值。 此标志可以重复，例如: --property k1=v1 --property k2=v2
  • file-name 指定包含要传递以更新连接的属性值的文件。
  • make-personal 将连接设置从 "共享" 更改为 "个人"。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

验证连接
以下语法验证指定项目中的连接:
cpdctl dsjob validate-connection {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是连接的名称。
  • id 是连接的标识。 如果未同时指定 name 和 id ，那么将验证项目中的所有连接。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示硬件规范
以下语法显示指定项目中所有硬件规范的列表:
cpdctl dsjob list-hardware-specs {--project PROJECT | --project-id PROJID} [--full FULL] [--all] [--sort|--sort-by-time] [--with-id]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有 DataStage 硬件规范的列表，每行一个。
  • all 显示项目中指定类型的所有硬件规格列表，例如：、Spark 和节点： DataStage、Spark 和节点。
  • full 提供了每个硬件规范的完整配置详细信息。 此字段是可选字段。
  • 指定时， sort 将返回按字母顺序排序的硬件规范列表。 此字段是可选字段。
  • 指定时， sort-by-time 按创建或更新时间对列表进行排序。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印硬件规范标识以及硬件规范的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建硬件规范
以下语法为指定的项目创建硬件规范:
cpdctl dsjob create-hardware-spec {--project PROJECT | --project-id PROJID} [[--name NAME] [--description DESCRIPTION] [--body BODY-JSON]] [--file-name FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的硬件规范的名称。
  • description 是要创建的硬件规范的描述。 此字段是可选字段。
  • body 应包含 JSON 格式的硬件规范。 或者，可以使用 --filename在文件中提供硬件规范。
  • filename 是包含硬件规范的文件的名称。 另外，也可以使用 --body 来提供硬件规格。 必须指定 --body 或 --filename。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

获取硬件规范
以下语法从指定的项目中按名称访存硬件规范:
cpdctl dsjob get-hardware-spec {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--file-name FILENAME] [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是硬件规范的名称。
  • id 是硬件规范的标识。 必须指定 name 或 id 之一。
  • file-name 是将硬件规范写入的输出文件的名称。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出运行时环境
以下语法显示指定项目中所有环境的列表:
cpdctl dsjob list-envs {--project PROJECT | --project-id PROJID} [--types TYPE] [--full] [--sort] [--with-id]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有 DataStage 环境的列表，每行一个环境。
  • type 显示类型指定的项目中所有环境的列表。 值应该是 notebook， wml_flow， rstudio， default_spark， remote_spark， jupyterlab， remote_yarn， datastage， profiling， modeler或 data_privacy之一。 此字段是可选字段。
  • full 提供了每个环境的完整配置详细信息。 此字段是可选字段。
  • 指定时， sort 将返回按字母顺序排序的环境列表。 此字段是可选字段。
  • 指定时， with-id 将打印环境标识以及环境名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建运行时环境
以下语法为指定的项目创建运行时环境:
pdctl dsjob create-env {--project PROJECT | --project-id PROJID} [--name NAME] [--display-name DISPLAY-NAME] [--type TYPE] [--location LOCATION] [--hwspec HWSPEC-NAME]] [--file-name FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的环境的名称。 在未指定 file-name 时使用。
  • display-name 是要创建的环境的长名称。 在未指定 file-name 时使用。
  • type 是要创建的环境类型，例如: datastage。 在未指定 filename 时使用。
  • location (如果指定) 是访问环境所需的 JSON 格式的位置信息。 在未指定 filename 时使用。
  • hwspec 是用于创建环境的硬件规范的名称。 在未指定 filename 时使用。
  • file-name 是包含硬件规范，位置和其他属性的文件的名称。 指定时，将忽略所有其他选项。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

获取运行时环境
以下语法从指定的项目中按名称访存运行时环境:
cpdctl dsjob get-env {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--file-name FILENAME] [--with-metadata]
  • project 是从中访存环境的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是查询的环境的名称。
  • id 是环境的标识。 必须指定 name 或 id 之一。
  • file-name 是将环境写入的输出文件的名称。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示子流
以下语法显示指定项目中所有子流的列表:
cpdctl dsjob list-subflows {--project PROJECT | --project-id PROJID} [--sort|--sort-by-time] [--with-id]
  • project 是包含要列示的子流的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有子流的列表，每行一个子流。
  • 指定时， sort 将返回按字母顺序排序的子流列表。 此字段是可选字段。
  • 指定时， sort-by-time 按创建或更新时间对列表进行排序。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印子流标识以及子流的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建子流
以下语法在指定的项目中创建子流:
cpdctl dsjob create-subflow {--project PROJECT | --project-id PROJID} --name NAME [--pipeline-file FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是子流的名称。
  • id 是子流的标识。 必须指定 name 或 id 之一。
  • pipeline-file 是包含子流 JSON 的文件的名称。 必须指定此字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取子流
以下语法从指定的项目中按名称访存子流:
cpdctl dsjob get-subflow {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output file|json] [--file-name FILENAME] [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是子流的名称。
  • id 是子流的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除子流
以下语法从指定的项目中按名称删除子流:
cpdctl dsjob delete-subflow {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是子流的名称。
  • id 是子流的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示参数集
以下语法显示指定项目中所有参数集的列表:
cpdctl dsjob list-paramsets {--project PROJECT | --project-id PROJID} [--sort|--sort-by-time] [--with-id]
  • project 是包含要列示的参数集的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有参数集的列表，每行一个参数集。
  • 指定时， sort 将返回按字母顺序排序的参数集列表。 此字段是可选字段。
  • 指定时， sort-by-time 按创建或更新时间对列表进行排序。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印参数集标识以及参数集的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建参数集
以下语法在指定的项目中创建参数集:
cpdctl dsjob create-paramset {--project PROJECT | --project-id PROJID} --name NAME [--description DESCRIPTION] [--file-name FILENAME] [--param type:name:[value]...]
  • project 是包含要列示的参数集的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的参数集的名称。 该字段是必填字段。
  • description 是要创建的参数集的详细描述。 此字段是可选字段。
  • file-name 是包含参数集定义的文件的名称。
  • param 用于在命令行上指定参数，而不是使用 file-name 选项。
必须指定 file-name 或 param 之一。 下面显示的样本文件内容:

[
  {
    "name": "parm3",
    "prompt": "parm3",
    "type": "int64",
    "value": 33
  },
  {
    "name": "parm33",
    "prompt": "parm33",
    "type": "string",
  },
  {
    "name": "parm333",
    "prompt": "parm333",
    "type": "Float64",
    "value": 33.3
  }
]
使用 param 的样本命令行内容如下所示:
"--param", "int64:parm1:12", "-param", "sfloat:parm2:12.3", "-param", "string:parm3:abc", "-param", "time:ptime:12:12:12", "-param", "date:pdate:11/06/2021", "-param", "timestamp:pts:11/06/2021:12:12:12"
格式为 type:name:value ，类型可以是 time ， timestamp ， date ， int64， sfloat ， string ， list 和 path 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取参数集
以下语法从指定的项目中访存按名称设置的参数:
cpdctl dsjob get-paramset {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output file|json] [--file-name FILENAME] [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是参数集的名称。
  • id 是参数集的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除参数集
以下语法从指定的项目中删除按名称设置的参数:
cpdctl dsjob delete-paramset {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是参数集的名称。
  • id 是参数集的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

更新参数集
以下语法更新指定项目中的现有参数集:
cpdctl dsjob update-paramset {--project PROJECT | --project-id PROJID} --name NAME [--file-name FILENAME] [--to-name RENAME] [--param type:name:[value] ...] [--delete-param name ...]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要更新的参数集的名称。
  • file-name 是包含参数集定义的文件的名称。
  • 指定时， to-name 会将参数集重命名为指定的名称。
  • param 在命令行上指定参数集定义。 必须指定 file-name 或 param 之一。
  • 指定时， delete-param 将从参数集中删除特定字段。
样本文件内容:
[
{
"name": "parm3",
"prompt": "parm3",
"type": "int64",
"value": 33
},
{
"name": "parm33",
"prompt": "parm33",
"type": "string",
},
{
"name": "parm333",
"prompt": "parm333",
"type": "Float64",
"value": 33.3
}
]
用于在添加三个字段和删除两个字段时重命名参数集的样本命令行内容:
cpdctl dsjob update-paramset --project PROJ1 --name paramset1 --param int64:parm1:12 -param sfloat:parm2:12.3 -param string:parm3:abc -delete-param ptime -delete-param pdate --to-name newparamset1
param 的格式为 type:name:value ， type 可以是时间，时间戳记，日期， int64， sfloat ， string ， list 或 path。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示参数集中的值集:
以下语法显示指定参数集中所有值集的列表:
cpdctl dsjob list-paramset-valuesets {--project PROJECT | --project-id PROJID} {--paramset PARAMSET | --paramset-id PARAMSETID}
  • project 是包含参数集的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示参数集中所有值集的列表，每行显示一个值集。
  • paramset 是参数集的名称。
  • paramset-id 是参数集的标识。 必须指定 paramset 或 paramset-id 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

在参数集中创建值集:
以下语法在指定的参数集中创建值集:
cpdctl dsjob create-paramset-valueset {--project PROJECT | --project-id PROJID} {--paramset PARAMSET | --paramset-id PARAMSETID} --name NAME [--file-name FILENAME] [--value name=value ...]
  • project 是包含参数集的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • paramset 是参数集的名称。
  • paramset-id 是参数集的标识。 必须指定 paramset 或 paramset-id 之一。
  • name 是要创建的值集的名称。
  • file-name 是包含值集定义的文件的名称。
  • value 用于指定在命令行上设置的值的参数值，而不是使用 file-name 选项。
包含具有三个字段 parm33， parm333 和 parm3的参数集的值集 vset1 的值集定义的文件:
{
"name": "vset1",
"values": [
{
"name": "parm33",
"value": "vset3333"
},
{
"name": "parm333",
"value": "33.3333333"
},
{
"name": "parm3",
"value": "33333"
}
]
}
命令行替代方法:
cpdctl dsjob create-paramset-valueset --project PROJ1 --paramset pset1 --name vset1 --value parm22="vset3333" --value parm333=33.333333 --value parm3=33333

状态码将打印到输出中。 状态码 0 指示命令成功完成。

获取参数集中的值集:
以下语法从指定的参数集中获取按名称设置的值:
cpdctl dsjob get-paramset-valueset {--project PROJECT | --project-id PROJID} {--paramset PARAMSET | --paramset-id PARAMSETID} --name NAME [--output file|json] [--file-name FILENAME]
  • project 是包含参数集的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • paramset 是参数集的名称。
  • paramset-id 是参数集的标识。 必须指定 paramset 或 paramset-id 之一。
  • name 是要检索的值集的名称。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除参数集中的值集:
以下语法从指定的参数集中删除按名称设置的值:
cpdctl dsjob delete-paramset-valueset {--project PROJECT | --project-id PROJID} {--paramset PARAMSET | --paramset-id PARAMSETID} --name NAME
  • project 是包含参数集的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • paramset 是参数集的名称。
  • paramset-id 是参数集的标识。 必须指定 paramset 或 paramset-id 之一。
  • name 是要删除的值集的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

更新参数集中的值集:
以下语法更新指定参数集中的现有值集:
cpdctl dsjob update-paramset-valueset {--project PROJECT | --project-id PROJID} {--paramset PARAMSET | --paramset-id PARAMSETID} --name NAME [--to-name RENAME] [--value name=value ...] [--file-name FILENAME]
  • project 是包含参数集的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • paramset 是参数集的名称。
  • paramset-id 是参数集的标识。 必须指定 paramset 或 paramset-id 之一。
  • name 是要更新的值集的名称。
  • 指定时， to-name 将重命名该值集。
  • file-name 指定包含参数集定义的文件的名称。
  • value 用于指定在命令行上设置的值的值，而不是使用 file-name 选项。 必须指定 file-name 或 value 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示 TableDefinitions
以下语法显示指定项目中所有 TableDefinitions 的列表:
cpdctl dsjob list-tabledefs {--project PROJECT | --project-id PROJID} [--sort|--sort-by-time] [--with-id]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有 TableDefinitions 的列表，每行一个。
  • 指定时， sort 将返回按字母顺序排序的 TableDefinitions 列表。 此字段是可选字段。
  • 指定时， sort-by-time 按创建或更新时间对列表进行排序。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印表定义标识以及表定义的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建 TableDefinitions
以下语法在指定的项目中创建 TableDefinition :
cpdctl dsjob create-tabledef {--project PROJECT | --project-id PROJID} --name NAME [--description DESCRIPTION] [--file-name FILENAME] [--column type:name:columnattribute...]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的 TableDefinition 的名称。 该字段是必填字段。
  • description 是要创建的 TableDefinition 的详细描述。 此字段是可选字段。
  • file-name 是包含表定义的文件的名称。
  • column 用于在命令行上指定列，而不是使用 file-name 选项。
必须指定 file-name 或 column 之一。 下面显示的样本文件内容:

{
	"column_info": {},
	"data_asset": {
		"additionalProperties": {},
		"columns": [
			{
				"name": "CreditCardID",
				"type": {
					"length": 10,
					"nullable": false,
					"scale": 0,
					"signed": true,
					"type": "INTEGER"
				}
			},
			... more columns follow
		],
		"dataset": true,
		"mime_type":  "application/json"
	},
	"data_definition": {},
	"ds_info": {}
}
使用 column 的样本命令行内容如下所示:
"--column", "Numeric:parm1:length=6", "--column", "Decimal:parm2:scale=2", "--column", "String:parm3:nullable=true,length=120", "--column", "Time:ptime", "--column", "Date:pdate", "--column", "Timestamp:pts:nullable=true""
格式为 type:name:value ，类型可以是 "日期" ， "十进制" ， "常规" ， "数字" ， "字符串" ， "时间" 和 "时间戳记" 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取 TableDefinitions
以下语法从指定的项目中按名称访存 TableDefinition :
cpdctl dsjob get-tabledef {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output file|json] [--file-name FILENAME] [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是 TableDefinition的名称。
  • id 是 TableDefinition的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除 TableDefinitions
以下语法按名称从指定项目中删除 TableDefinition :
cpdctl dsjob delete-tabledef {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是 TableDefinition的名称。
  • id 是 TableDefinition的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示 XML 库
以下语法显示指定项目中所有 XML 库的列表:
cpdctl dsjob list-libraries {--project PROJECT | --project-id PROJID} [--sort|--sort-by-time] [--with-id]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有 XML 库的列表，每行一个。
  • 指定时， sort 将返回按字母顺序排序的 XML 库列表。 此字段是可选字段。
  • 指定时， sort-by-time 按创建或更新时间对列表进行排序。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印 XML 库标识以及 XML 库的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建 XML 库
以下语法在指定的项目中创建 XML 库:
cpdctl dsjob create-library {--project PROJECT | --project-id PROJID} --name NAME [--description DESCRIPTION] [--folder FOLDER]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的 XML 库的名称。 该字段是必填字段。
  • description 是要创建的 XML 库的详细描述。 此字段是可选字段。
  • folder 是要创建的 XML 库的文件夹的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

获取 XML 库
以下语法从指定的项目中按名称访存 XML 库:
cpdctl dsjob get-library {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是 XML 库的名称。
  • id 是 XML 库的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除 XML 库
以下语法按名称从指定项目中删除库:
cpdctl dsjob delete-library {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}... [--folder FOLDER]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是 XML 库的名称。
  • id 是 XML 库的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

  • folder 是已删除的 XML 库的文件夹的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

上载 XML 库文件
以下语法按名称将 .zip 文件上载到指定项目中的现有 DataStage XML 模式库:
cpdctl dsjob upload-library-file {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} --file-name FILENAME
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是 XML 库的名称。
  • id 是 XML 库的标识。 必须指定 name 或 id 之一。
  • file-name 是包含模式定义的 .zip 文件的名称。 该字段是必填字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

下载 XML 库文件
以下语法按名称下载指定项目中现有 DataStage XML 模式库的 .zip 文件:
cpdctl dsjob download-library-file {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}  --file-name FILENAME
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是 XML 库的名称。
  • id 是 XML 库的标识。 必须指定 name 或 id 之一。
  • file-name 是 XML 库的模式定义所写入的输出文件的名称。 该字段是必填字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除 XML 库文件
以下语法按指定项目中的名称从现有 DataStage XML 模式库中删除一组文件:
cpdctl dsjob delete-library-file {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} --file-name FILENAME
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是 XML 库的名称。
  • id 是 XML 库的标识。 必须指定 name 或 id 之一。
  • file-name 是要从 XML 库中删除的文件的名称。 该字段是必填字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示环境变量
以下语法列出了在指定项目环境中定义的所有环境变量:
cpdctl dsjob list-env-vars {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--type TYPE]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是环境的名称。
  • id 是环境的标识。 必须指定 name 或 id 之一。
  • type 是环境的类型。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

更新环境变量
以下语法更新在指定项目环境中定义的环境变量:
cpdctl dsjob update-env-vars {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--type TYPE] [--env k=v...] [--file-name FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是环境的名称。
  • id 是环境的标识。 必须指定 name 或 id 之一。
  • type 是环境的类型。
  • env 是要更新或创建的环境变量及其值的列表。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除环境变量
以下语法将删除在指定项目环境中定义的环境变量:
cpdctl dsjob delete-env-vars {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--type TYPE] [--env ENV...] [--file-name FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是环境的名称。
  • id 是环境的标识。 必须指定 name 或 id 之一。
  • type 是环境的类型。
  • env 是要删除的环境变量的名称。 列出要删除的所有变量: 重复该字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

获取数据集模式定义
以下语法提供给定项目中数据集模式定义的描述。
cpdctl dsjob describe-dataset {--project PROJECT | --project-id PROJID} --pxname NAME --name <DATASET>
 cpdctl dsjob describe-fileset {--project PROJECT | --project-id PROJID} --pxname NAME --name <FILESET>
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • pxname 是此数据集或文件集所属的运行时的名称。
  • name 是数据集或文件集的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

查看数据集元数据
以下语法提供给定项目中数据集的元数据。
cpdctl dsjob view-dataset {--project PROJECT | --project-id PROJID} --pxname NAME --name <DATASET> 
cpdctl dsjob view-fileset {--project PROJECT | --project-id PROJID} --pxname NAME --name <FILESET>
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • pxname 是此数据集或文件集所属的运行时的名称。
  • name 是数据集或文件集的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

查看数据集数据
以下语法获取给定项目中数据集的数据。
cpdctl dsjob get-dataset {--project PROJECT | --project-id PROJID} --pxname NAME --name <DATASET> 
cpdctl dsjob get-fileset {--project PROJECT | --project-id PROJID} --pxname NAME --name <FILESET>
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • pxname 是此数据集或文件集所属的运行时的名称。
  • name 是数据集或文件集的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示数据集和文件集
以下语法列出了给定项目中的所有数据集或文件集。
cpdctl dsjob list-datasets {--project PROJECT | --project-id PROJID} [--sort | --sort-by-time | --sort-by-size] --all 
cpdctl dsjob list-filesets {--project PROJECT | --project-id PROJID} [--sort | --sort-by-time | --sort-by-size] [--all]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • 指定时， sort 将返回按字母顺序排序的数据集或文件集的列表。 此字段是可选字段。
  • 指定时， sort-by-time 将返回按时间顺序排序的数据集或文件集的列表。 此字段是可选字段。
  • 指定时， sort-by-time 将返回按大小排序的数据集或文件集的列表。 此字段是可选字段。 只能指定 sort， sort-by-time 或 sort-by-size 中的一个。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除数据集和文件集
以下语法将删除数据集或文件集。
cpdctl dsjob delete-dataset {--project PROJECT | --project-id PROJID} --pxname NAME --name <DATASET|FILESET>
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • pxname 是此数据集或文件集所属的运行时的名称。
  • name 是数据集或文件集的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示远程引擎
以下语法列出了在给定 DataStage 实例中注册的远程引擎。
cpdctl dsjob list-remote-engines
状态码将打印到输出中。 状态码 0 指示命令成功完成。
除去远程引擎
以下语法从给定的 DataStage 实例注销远程引擎。
cpdctl dsjob remove-remote-engine [--name name | --id ID]
  • name 是远程引擎的名称。
  • id 是远程引擎的标识。 必须指定 name 或 id 之一。
状态码将打印到输出中。 状态码 0 指示命令成功完成。
打印版本
以下命令将打印集群中安装的所有版本的 DataStage 组件。
cpdctl dsjob version
列示构建阶段
以下语法显示指定项目中所有构建阶段的列表:
cpdctl dsjob list-build-stages {--project PROJECT | --project-id PROJID} [--sort | --sort-by-time] [--with-id]
  • project 是包含要列示的构建阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有构建阶段的列表，每行一个构建阶段。
  • 指定时， sort 将返回按字母顺序排序的构建阶段列表。 此字段是可选字段。
  • sort-by-time 指定时，将按创建时间对构建阶段列表进行排序，最晚在列表顶部。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印构建阶段标识以及构建阶段的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建构建阶段
以下语法在指定的项目中创建构建阶段:
cpdctl dsjob create-build-stage {--project PROJECT | --project-id PROJID} --name NAME [--description DESCRIPTION] [--file-name ENTITYFILE]
  • project 是为其创建构建阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的构建阶段的名称。
  • description 是要创建的构建阶段的描述。
  • file-name 是包含构建阶段 JSON 的文件的名称。 JSON 包含名称，描述和所有其他阶段详细信息。 必须指定此字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取构建阶段
以下语法按名称从指定的项目访存构建阶段:
cpdctl dsjob get-build-stage {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是包含构建阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是构建阶段的名称。
  • id 是构建阶段的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除构建阶段
以下语法按名称从指定的项目中删除构建阶段:
cpdctl dsjob delete-build-stage {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是包含构建阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要删除的构建阶段的名称。
  • id 是构建阶段的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

生成构建阶段
以下语法生成并编译构建阶段的代码:
cpdctl dsjob generate-build-stage {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}
  • project 是包含构建阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要生成的构建阶段的名称。
  • id 是构建阶段的标识。 必须指定 name 或 id 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示定制阶段
以下语法显示指定项目中所有定制阶段的列表:
cpdctl dsjob list-custom-stages {--project PROJECT | --project-id PROJID} [--sort | --sort-by-time] [--with-id]
  • project 是包含要列示的定制阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有定制阶段的列表，每行一个定制阶段。
  • 指定时， sort 将返回按字母顺序排序的定制阶段列表。 此字段是可选字段。
  • sort-by-time 指定时，将按创建时间对定制阶段列表进行排序，最晚在列表顶部。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印定制阶段标识以及定制阶段的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建定制阶段
以下语法在指定的项目中创建定制阶段:
cpdctl dsjob create-custom-stage {--project PROJECT | --project-id PROJID} --name NAME [--description DESCRIPTION] [--file-name ENTITYFILE]
  • project 是为其创建定制阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的定制阶段的名称。
  • description 是要创建的定制阶段的描述。
  • file-name 是包含定制阶段 JSON 的文件的名称。 JSON 包含名称，描述和所有其他阶段详细信息。 必须指定此字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

获取定制阶段
以下语法从指定的项目中按名称访存定制阶段:
cpdctl dsjob get-custom-stage {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是包含定制阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是定制阶段的名称。
  • id 是定制阶段的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除定制阶段
以下语法按名称从指定的项目中删除定制阶段:
cpdctl dsjob delete-custom-stage {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是包含定制阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要删除的定制阶段的名称。
  • id 是定制阶段的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出已打包的阶段
以下语法显示指定项目中所有打包阶段的列表:
cpdctl dsjob list-wrapped-stages {--project PROJECT | --project-id PROJID} [--sort | --sort-by-time] [--with-id]
  • project 是包含要列示的打包阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有打包阶段的列表，每行一个。
  • 指定时， sort 将返回按字母顺序排序的打包阶段列表。 此字段是可选字段。
  • sort-by-time 指定时，包装阶段的列表将按创建时间排序，最晚在列表顶部。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印包装的阶段标识以及包装的阶段的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

创建打包阶段
以下语法在指定的项目中创建打包阶段:
cpdctl dsjob create-wrapped-stage {--project PROJECT | --project-id PROJID} --name NAME [--description DESCRIPTION] [--file-name ENTITYFILE]
  • project 是要为其创建打包阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要创建的定制阶段的名称。
  • description 是要创建的定制阶段的描述。
  • file-name 是包含打包阶段 JSON 的文件的名称。 JSON 包含名称，描述和所有其他阶段详细信息。 必须指定此字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取包装阶段
以下语法从指定的项目中按名称访存打包阶段:
cpdctl dsjob get-wrapped-stage {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是包含打包阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是打包阶段的名称。
  • id 是打包阶段的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除包装的阶段
以下语法按名称从指定的项目中删除打包阶段:
cpdctl dsjob delete-wrapped-stage {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是包含打包阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要删除的包装阶段的名称。
  • id 是打包阶段的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在生成打包阶段
以下语法生成并编译构建阶段的代码:
cpdctl dsjob generate-wrapped-stage {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}
  • project 是包含打包阶段的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要生成的包装阶段的名称。
  • id 是打包阶段的标识。 必须指定 name 或 id 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出资产
以下语法显示指定项目中所有资产的列表:
cpdctl dsjob list-assets {--project PROJECT | --project-id PROJID} [-asset-type ASSETTYPE] [--sort | --sort-by-time] [--with-id]
  • project 是包含要列示的资产的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有资产的列表，每行一个资产。
  • asset-type 是要列示的资产的类型。 如果未指定，那么将列出所有资产。
  • 指定时， sort 将返回按字母顺序排序的资产列表。 此字段是可选字段。
  • sort-by-time 指定时，将按创建时间对资产列表进行排序，最晚在列表顶部。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印资产标识以及资产的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取附件
以下语法从指定的项目中按名称访存附件:
cpdctl dsjob get-attachment {--project PROJECT | --project-id PROJID} {--asset-name NAME | --asset-id ID}  {--name NAME | --id ID} [--file-name FILENAME]
  • project 是包含资产的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • asset-name 是资产的名称。 必须指定此字段。
  • asset-id 是资产的标识。 必须指定 asset-name 或 asset-id 之一。
  • name 是附件的名称。
  • id 是附件的标识。 必须指定 name 或 id 之一。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出匹配规范
以下语法显示指定项目中所有匹配规范的列表:
cpdctl dsjob list-match-specs {--project PROJECT | --project-id PROJID} [--sort | --sort-by-time] [--with-id]
  • project 是包含要列示的匹配规范的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。 将显示项目中所有匹配规范的列表，每行一个匹配规范。
  • 指定时， sort 将返回按字母顺序排序的匹配规范列表。 此字段是可选字段。
  • sort-by-time 指定时，将按创建时间对匹配规范列表进行排序，最晚在列表顶部。 可以指定 sort 或 sort-by-time 之一。
  • 指定时， with-id 将打印匹配规范标识以及匹配规范的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

正在获取匹配规范
以下语法从指定的项目中按名称访存匹配规范:
cpdctl dsjob get-match-spec {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--output json|file] [--file-name FILENAME] [--with-metadata]
  • project 是包含匹配规范的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是匹配规范的名称。
  • id 是匹配规范的标识。 必须指定 name 或 id 之一。
  • output 指定输出的格式。 此字段是可选字段。
  • file-name 指定将输出写入的文件的名称。 此字段是可选字段。
  • 指定时， with-metadata 会将元数据添加到输出。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除匹配规范
以下语法从指定的项目中按名称删除匹配规范:
cpdctl dsjob delete-match-spec {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}...
  • project 是包含匹配规范的项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是要删除的匹配规范的名称。
  • id 是匹配规范的标识。 必须指定 name 或 id 之一。 可以为 name 和 id 指定多个值以删除多个项，格式为 --name NAME1 --name NAME2...。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

导入匹配规范
以下语法将匹配规范导入到指定的项目中:
cpdctl dsjob import-match-spec {--project PROJECT | --project-id PROJID} [--file-name FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • file-name 是包含匹配规范的文件的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

导出匹配规范
以下语法将匹配规范从指定项目导出到文件:
cpdctl dsjob export-match-spec {--project PROJECT | --project-id PROJID} {--name NAME | --id ID} [--file-name FILENAME]
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是匹配规范的名称。
  • id 是匹配规范的标识。 必须指定 name 或 id 之一。
  • file-name 指定要将匹配规范写入的 .zip 文件的名称。 如果未指定，那么匹配规范的名称或标识是文件的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

复制匹配规范
以下语法将复制匹配规范。
cpdctl dsjob copy-match-spec {--project PROJECT | --project-id PROJID} {--name NAME | --id ID}
  • project 是项目的名称。
  • project-id 是项目的标识。 必须指定 project 或 project-id 之一。
  • name 是匹配规范的名称。
  • id 是匹配规范的标识。 必须指定 name 或 id 之一。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列出用户卷
以下语法列出集群中的用户卷:
cpdctl dsjob list-volumes [--sort | --sort-by-time | --sort-by-size]
  • sort 按卷的名称排序。
  • sort-by-time 按创建卷的时间排序。
  • sort-by-size 按卷大小排序。 只能指定一个排序标志。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

在用户卷上创建目录
以下语法在卷上创建目录:
cpdctl dsjob create-volume-dir --name VOLNAME --dir-name DIRNAME
  • name 是卷的名称。
  • dir-name 是要创建的目录的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

删除用户卷上的目录
以下语法用于删除卷上的目录:
cpdctl dsjob delete-volume-dir --name VOLNAME --dir-name DIRNAME
  • name 是卷的名称。
  • dir-name 是要删除的目录的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

列示用户卷上的文件
以下语法列出卷上的文件:
cpdctl dsjob list-volume-files --name [--path]
  • name 是卷的名称。
  • path 是卷上的路径。 此字段是可选字段。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

将文件上载到用户卷
以下语法将文件上载到卷:
cpdctl dsjob upload-volume-files --name --path --file-name [--extract]
  • name 是卷的名称。
  • path 是卷上的路径。 此字段是可选字段。
  • file-name 是要上载的文件的名称。
  • extract 指定 file-name 是需要解压缩的 .zip 文件。

状态码将打印到输出中。 状态码 0 指示命令成功完成。

从用户卷下载文件
以下语法从卷下载文件:
cpdctl dsjob download-volume-files [name] [path] [--file-name <FILETODOWNLOAD>] [--output-file <OUTPUTFILE>]
  • name 是卷的名称。
  • path 是卷上的路径。 此字段是可选字段。
  • file-name 是要下载的文件的名称。
  • output-file 是将输出写入的文件的名称。

状态码将打印到输出中。 状态码 0 指示命令成功完成。