UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

uip tm 性能场景负载组

“uip tmperf-scenario load-groups”的语法和选项,将测试用例绑定到性能场景并调整其负载配置文件。

uip tm perf-scenario load-groups 管理绑定到性能场景的负载组。负载组是绑定到具有负载配置文件(虚拟用户、加速/峰值/减速时间、SLO 阈值和机器人类型)的场景的一个测试用例。

此页面属于uip tm perf-scenario命令组 — 请参阅该页面,了解场景生命周期动词( create 、 get 、 list 、 execute 、 stop 、 list-dry-run-reports )和共享概念。

大纲​

uip tm perf-scenario load-groups add --scenario-key <key> [--project-key <key>] (--test-case-key <key> | --test-case-id <uuid>) --folder-key <uuid> --package-name <name> [--package-version <version>] [--virtual-users <n>] [--ramp-up-minutes <n>] [--peak-minutes <n>] [--ramp-down-minutes <n>] [--delay-minutes <n>] [--max-response-time-ms <ms>] [--max-error-rate <rate>] [--robot-type <type>]
uip tm perf-scenario load-groups update --load-group-id <uuid> --project-key <key> [--virtual-users <n>] [--ramp-up-minutes <n>] [--peak-minutes <n>] [--ramp-down-minutes <n>] [--delay-minutes <n>] [--max-response-time-ms <ms>] [--max-error-rate <rate>] [--multiplexing-factor <n>] [--robot-type <type>] [--enabled <bool>]
uip tm perf-scenario load-groups remove --load-group-id <uuid> --project-key <key>
uip tm perf-scenario load-groups list --project-key <key> --execution-id <uuid> [--query <expr>]
uip tm perf-scenario load-groups add --scenario-key <key> [--project-key <key>] (--test-case-key <key> | --test-case-id <uuid>) --folder-key <uuid> --package-name <name> [--package-version <version>] [--virtual-users <n>] [--ramp-up-minutes <n>] [--peak-minutes <n>] [--ramp-down-minutes <n>] [--delay-minutes <n>] [--max-response-time-ms <ms>] [--max-error-rate <rate>] [--robot-type <type>]
uip tm perf-scenario load-groups update --load-group-id <uuid> --project-key <key> [--virtual-users <n>] [--ramp-up-minutes <n>] [--peak-minutes <n>] [--ramp-down-minutes <n>] [--delay-minutes <n>] [--max-response-time-ms <ms>] [--max-error-rate <rate>] [--multiplexing-factor <n>] [--robot-type <type>] [--enabled <bool>]
uip tm perf-scenario load-groups remove --load-group-id <uuid> --project-key <key>
uip tm perf-scenario load-groups list --project-key <key> --execution-id <uuid> [--query <expr>]

所有动词都遵循全局选项和标准退出代码。每个动词接受 --log-level <level>(默认值 Information)。

备注:

--project-key在add 上是可选的(当省略时,从--scenario-key 前缀派生),但在.requiredOption() update、remove 和list 上, 是必需的 ,因为这些活动通过包含以下内容的裸 UUID 来标识其目标无可派生的项目前缀。

uip tm 性能场景负载组添加​

将测试用例作为新负载组绑定到场景。为加载配置文件设置空运行默认值 — 稍后在空运行结束后使用 update 调用它们。

选项​

标记描述
--scenario-key <key>必需。场景对象键(例如 SP1:7)。
--project-key <key>拥有的项目。可选 — 若省略 --scenario-key 前缀,则派生自该前缀。
--test-case-key <key>要绑定的测试用例对象键(例如 SP1:602)。通过 API 解析为其 UUID。提供此字段或 --test-case-id。
--test-case-id <uuid>测试用例 UUID 以直接绑定,以跳过密钥查找。提供此项或 --test-case-key。
--folder-key <uuid>必需。Orchestrator 文件夹密钥(必须是 GUID)。
--package-name <name>必需。包含自动化的 Orchestrator 包名称。
--package-version <version>Orchestrator 包版本。省略此参数(通过 Orchestrator 查找解析)时,默认为包的最新发布版本。
--virtual-users <n>虚拟用户数。默认为 1。
--ramp-up-minutes <n>加速持续时间(以分钟为单位)。默认为 0。
--peak-minutes <n>峰值持续时间(分钟)。默认为 1。
--ramp-down-minutes <n>减速持续时间(分钟)。默认为 0。
--delay-minutes <n>开始前延迟,以分钟为单位。默认为 0。
--max-response-time-ms <ms>最长响应时间 SLO (以毫秒为单位);服务器至少需要 100。默认为 100。
--max-error-rate <rate>最大错误率 SLO(分数,例如 1% 为 0.01);服务器至少需要 0.0001。默认为 0.0001。
--robot-type <type>机器人类型:standard、template、elasticRobotPool、cloudRobotVm、serverless。默认为 standard。

示例​

# bind by test case key
uip tm perf-scenario load-groups add \
  --scenario-key SP1:7 \
  --test-case-key SP1:602 \
  --folder-key 94821c49-ab85-49cb-94e1-f82c6d8973be \
  --package-name Checkout_Tests \
  --robot-type serverless
# bind by test case key
uip tm perf-scenario load-groups add \
  --scenario-key SP1:7 \
  --test-case-key SP1:602 \
  --folder-key 94821c49-ab85-49cb-94e1-f82c6d8973be \
  --package-name Checkout_Tests \
  --robot-type serverless
# bind by test case id directly (skips the key lookup)
uip tm perf-scenario load-groups add \
  --scenario-key SP1:7 \
  --test-case-id f0b7f77f-482b-0400-a9c4-0b49497eb136 \
  --folder-key 94821c49-ab85-49cb-94e1-f82c6d8973be \
  --package-name Checkout_Tests \
  --package-version 1.0.2
# bind by test case id directly (skips the key lookup)
uip tm perf-scenario load-groups add \
  --scenario-key SP1:7 \
  --test-case-id f0b7f77f-482b-0400-a9c4-0b49497eb136 \
  --folder-key 94821c49-ab85-49cb-94e1-f82c6d8973be \
  --package-name Checkout_Tests \
  --package-version 1.0.2

数据形状​

{
  "Code": "LoadGroupAdd",
  "Data": {
    "ScenarioKey": "SP1:7",
    "TestCaseKey": "SP1:602",
    "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
    "PackageName": "Checkout_Tests",
    "PackageVersion": "1.0.2",
    "VirtualUsers": 1,
    "Result": "Added"
  }
}
{
  "Code": "LoadGroupAdd",
  "Data": {
    "ScenarioKey": "SP1:7",
    "TestCaseKey": "SP1:602",
    "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
    "PackageName": "Checkout_Tests",
    "PackageVersion": "1.0.2",
    "VirtualUsers": 1,
    "Result": "Added"
  }
}

uip tm 性能场景负载组更新​

就地更新一个负载组的负载配置文件(虚拟用户、加速/峰值/减速分钟数、SLO 阈值、机器人类型、启用状态)。只有您传递的标志会发生变化,其他所有内容都将保留。在通过空运行和完整的 performanceTesting 运行之间使用此方法,以调入实际负载配置文件。

选项​

标记描述
--load-group-id <uuid>必需。场景的负载组 UUID(上述perf-scenario get 、 execute或add中的LoadGroupId字段,而非下方list中的每次执行 ID)。
--project-key <key>必需。拥有的项目。
--virtual-users <n>新虚拟用户数量。
--ramp-up-minutes <n>新的启动持续时间(分钟)。
--peak-minutes <n>新峰值持续时间(分钟)。
--ramp-down-minutes <n>新的减速持续时间(分钟)。
--delay-minutes <n>新开始前的延迟时间 (以分钟为单位)。
--max-response-time-ms <ms>新的最大响应时间 SLO,以毫秒为单位(服务器至少需要 100)。
--max-error-rate <rate>新的最大错误率 SLO(服务器至少需要 0.0001)。
--multiplexing-factor <n>复用因子 — 在空运行结束时发出建议值 (list-dry-run-reports → RecommendedMultiplexingFactor)。
--robot-type <type>新的机器人类型:standard、template、elasticRobotPool、cloudRobotVm、serverless。
--enabled <bool>启用 (true) 或禁用 (false) 此负载组。

示例​

uip tm perf-scenario load-groups update \
  --load-group-id 8e322581-0a25-0000-738b-0b49fd936ca1 \
  --project-key SP1 \
  --virtual-users 50 \
  --ramp-up-minutes 2 \
  --peak-minutes 10
uip tm perf-scenario load-groups update \
  --load-group-id 8e322581-0a25-0000-738b-0b49fd936ca1 \
  --project-key SP1 \
  --virtual-users 50 \
  --ramp-up-minutes 2 \
  --peak-minutes 10

数据形状​

{
  "Code": "LoadGroupUpdate",
  "Data": {
    "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
    "VirtualUsers": 50,
    "RampUpMinutes": 2,
    "PeakMinutes": 10,
    "RampDownMinutes": 0,
    "DelayMinutes": 0,
    "MaxResponseTimeMs": 100,
    "MaxErrorRate": 0.0001,
    "MultiplexingFactor": null,
    "Enabled": true,
    "RobotType": "standard",
    "Result": "Updated"
  }
}
{
  "Code": "LoadGroupUpdate",
  "Data": {
    "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
    "VirtualUsers": 50,
    "RampUpMinutes": 2,
    "PeakMinutes": 10,
    "RampDownMinutes": 0,
    "DelayMinutes": 0,
    "MaxResponseTimeMs": 100,
    "MaxErrorRate": 0.0001,
    "MultiplexingFactor": null,
    "Enabled": true,
    "RobotType": "standard",
    "Result": "Updated"
  }
}

您未传递的字段将使用其当前(未更改)值进行回显,而非省略 — 响应将反映完整的合并负载组,而不仅仅是其中的增量。

uip tm 性能场景负载组删除​

从场景中删除负载组。分离测试用例及其负载配置文件;测试用例本身和任何过去的执行数据都保持不变。

选项​

标记描述
--load-group-id <uuid>必需。场景的负载组 UUID(上述LoadGroupId perf-scenario get或add 中的 字段)。
--project-key <key>必需。拥有的项目。

示例​

uip tm perf-scenario load-groups remove \
  --load-group-id 8e322581-0a25-0000-738b-0b49fd936ca1 \
  --project-key SP1
uip tm perf-scenario load-groups remove \
  --load-group-id 8e322581-0a25-0000-738b-0b49fd936ca1 \
  --project-key SP1

数据形状​

{
  "Code": "LoadGroupRemove",
  "Data": {
    "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
    "Result": "Removed"
  }
}
{
  "Code": "LoadGroupRemove",
  "Data": {
    "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
    "Result": "Removed"
  }
}

这是一个硬删除,没有确认标志 — CLI 不会将其门控在 -y/--yes 之后。

uip tm 性能场景负载组列表​

列出一次执行的负载组(测试用例、SUT、虚拟用户、阈值、状态)。这与场景自己的负载组列表不同:使用perf-scenario get查看场景本身中配置的负载组。

选项​

标记描述
--project-key <key>必需。拥有的项目。
--execution-id <uuid>必需。场景执行 ID(ExecutionId 中的 perf-scenario execute)。
--query <expr>应用于输出数据的 jq 样式筛选器。

示例​

uip tm perf-scenario load-groups list \
  --project-key DEMO \
  --execution-id 80694766-5a44-0000-0985-0b49fd93832d
uip tm perf-scenario load-groups list \
  --project-key DEMO \
  --execution-id 80694766-5a44-0000-0985-0b49fd93832d

数据形状​

{
  "Code": "PerfLoadGroupsList",
  "Data": {
    "Data": [
      {
        "Id": "082486b0-8d51-0000-b54a-0b4a1388f850",
        "Status": "Finished"
      }
    ]
  }
}
{
  "Code": "PerfLoadGroupsList",
  "Data": {
    "Data": [
      {
        "Id": "082486b0-8d51-0000-b54a-0b4a1388f850",
        "Status": "Finished"
      }
    ]
  }
}

此响应是基础 SDK 有效负载的精简帕斯卡拼写法传递,而非专门构建的行形状,因此确切的字段集可能比此处显示的更丰富(测试用例、SUT、虚拟用户、阈值)——查看真实响应或使用 --query 对其进行调整。此处的Id字段是执行数据的http-errors list和automation-errors list预期为--load-group-id每次执行的负载组 ID。

  • uip tmperf-scenario — 场景生命周期和共享概念。
  • 执行数据— 检查已完成或正在进行的执行。
  • 报告— 呈现创作报告,以供执行或比较。
  • 测试用例— link-automation为测试用例提供automationId和add所依赖的perf-scenario list-dry-run-reports 。
  • UIP 或文件夹列表— add使用的--folder-key的来源。

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新