uip gov aops 策略
“uip gov aops-policy”的策略 CRUD、产品目录、许可证类型目录和 Form.io 模板命令的语法和选项。
uip gov aops-policy 管理 UiPath AOps 监管策略(例如,限制允许哪些项目设置的 StudioX 策略),编写为已填写的 Form.io 表单,并在租户/用户/组之间分配。本页介绍创作端:策略记录本身 (list / / /),以及只读引用目录(get createupdatedeleteproduct、license-type )和 命令,用于生成构建策略template data有效负载所基于的可填写表单数据蓝图。有关将策略分配给主题并解决在运行时实际应用的策略,请参阅aops-policy deployment和deployed-policy 。有关父级工具概述和访问策略,请参阅uip gov 。
典型流程: template get <product> → 编辑发出的 form-data.json → policy create --product-name <product> --name <name> --input form-data.json → deployment tenant configure (或用户/组)以将其推出。
大纲
uip gov aops-policy list [--product-name <name>] [--product-label <label>] [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip gov aops-policy get <policyIdentifier>
uip gov aops-policy create --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy update --identifier <id> --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy delete <policyIdentifier>
uip gov aops-policy product list
uip gov aops-policy product get <productIdentifier>
uip gov aops-policy license-type list
uip gov aops-policy template get <productIdentifier> [--output-form-data <path>] [--output-template-locale-resource <path>]
uip gov aops-policy template list --output-dir <path>
uip gov aops-policy list [--product-name <name>] [--product-label <label>] [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip gov aops-policy get <policyIdentifier>
uip gov aops-policy create --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy update --identifier <id> --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy delete <policyIdentifier>
uip gov aops-policy product list
uip gov aops-policy product get <productIdentifier>
uip gov aops-policy license-type list
uip gov aops-policy template get <productIdentifier> [--output-form-data <path>] [--output-template-locale-resource <path>]
uip gov aops-policy template list --output-dir <path>
每个动词还接受 --login-validity <minutes>,以覆盖该调用的交互式登录令牌生存期(很少需要)。
uip gov aops 策略列表
列出监管策略,具有可选的筛选和分页功能。返回策略元数据(标识符、名称、产品、优先级、可用性),而不是策略 data Blob。
选项
| 长 | 值 | 描述 |
|---|---|---|
--product-name <product-name> | 字符串 | 限制为一种产品(例如StudioX)。匹配 product.name — 请参阅 product list。 |
--product-label <productLabel> | 字符串 | 按显示标签限制为一个产品(例如'Studio X')。对于脚本编写,优先使用 --product-name。 |
--search <searchTerm> | 字符串 | 不区分大小写的子字符串与策略名称/说明进行匹配。 |
--sort-by <field> | 字符串 | 要排序的字段(例如name、createdOn、priority)。已传递至监管 API。 |
--sort-order <direction> | asc | desc | --sort-by 的排序方向。不区分大小写;任何其他值都会在客户端失败。 |
--limit <n> | 整数 | 页面大小。默认 20。 |
--offset <n> | 整数 | 从零开始的页面索引。 |
示例
uip gov aops-policy list --product-name StudioX --limit 2
uip gov aops-policy list --product-name StudioX --limit 2
数据形状(--输出 json)
{
"Code": "AopsPolicyList",
"Data": [
{ "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX", "priority": 10, "availability": 1 }
]
}
{
"Code": "AopsPolicyList",
"Data": [
{ "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX", "priority": 10, "availability": 1 }
]
}
uip gov aops 策略获取
按标识符获取一个策略,包括其完整的 data 有效负载(已填写的表单数据蓝图)。用于检查提交的值,或为后续 update 设定种子。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<policyIdentifier> | 是 | 策略 GUID,来自 list。 |
示例
uip gov aops-policy get a1b2c3d4-0000-0000-0000-000000000001
uip gov aops-policy get a1b2c3d4-0000-0000-0000-000000000001
数据形状(--输出 json)
{
"Code": "AopsPolicyGet",
"Data": {
"identifier": "a1b2c3d4-0000-0000-0000-000000000001",
"name": "Baseline StudioX Policy",
"productName": "StudioX",
"priority": 10,
"availability": 1,
"data": { "allowAnalytics": true, "maxProjects": 5 }
}
}
{
"Code": "AopsPolicyGet",
"Data": {
"identifier": "a1b2c3d4-0000-0000-0000-000000000001",
"name": "Baseline StudioX Policy",
"productName": "StudioX",
"priority": 10,
"availability": 1,
"data": { "allowAnalytics": true, "maxProjects": 5 }
}
}
data 的密钥与 Form.io 表单中显示的完全相同(驼峰式命名法/短横线命名法),而非帕斯卡式命名法——此有效负载旨在不经修改地往返于 update --input。
uip gov aops 策略创建
为产品创建新的监管策略。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--name <name> | 字符串 | 是 | 人类可读的策略名称(在产品内唯一)。 |
--product-name <product-name> | 字符串 | 是 | 目标产品(例如StudioX、AITrustLayer)— 必须与 product list 中的名称匹配。 |
--description <description> | 字符串 | 否 | 监管用户界面中显示了自由文本描述。 |
--priority <n> | 整数 | 否 | 当多个策略应用于同一主题时,数字越大越好。 |
--availability <n> | 整数 | 否 | 可用性标志(特定于产品的枚举)— 查看监管用户界面或服务文档中的有效值。 |
--input <path> | 路径 | 否 | (来自 template get --output-form-data)包含已填写的“表单数据”对象的 JSON 文件。对于没有数据有效负载的策略,请省略此参数。 |
示例
uip gov aops-policy create --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json
uip gov aops-policy create --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json
数据形状(--输出 json)
{
"Code": "AopsPolicyCreate",
"Data": { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX" }
}
{
"Code": "AopsPolicyCreate",
"Data": { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX" }
}
响应会回显原始(双重换行)数据 Blob,而非 get 返回的展平形状 — 使用 get 为后续 update --input 生成表单数据。
uip gov aops 策略更新
替换现有策略的字段。完整更新,而非补丁— 您要保留的每个字段必须再次传递;省略--description / --priority / --availability / --input会清除服务器上的该字段。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--identifier <identifier> | GUID | 是 | 要更新的策略。从 list/get 开始。 |
--name <name> | 字符串 | 是 | 策略名称。传递现有名称可保留该名称。 |
--product-name <product-name> | 字符串 | 是 | 必须匹配策略的现有产品 — 不支持在更新时更改产品。 |
--description <description> | 字符串 | 否 | 完全替换:重新传递 get 中的现有值以保留该值。 |
--priority <n> | 整数 | 否 | 完全替换:重新传递现有值以保留值。 |
--availability <n> | 整数 | 否 | 完全替换:重新传递现有值以保留值。 |
--input <path> | 路径 | 否 | 完全替换:重新传递现有的 data(在 get 中保存)以将其保留。 |
失败,并显示“正在进行模板升级”如果迁移基础 Form.io 模板,则出错 — 完成后重试。
示例
uip gov aops-policy update --identifier a1b2c3d4-0000-0000-0000-000000000001 --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json
uip gov aops-policy update --identifier a1b2c3d4-0000-0000-0000-000000000001 --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json
数据形状(--输出 json)
与 create 形状相同,但带有 Code: "AopsPolicyUpdate"。
uip gov aops 策略删除
永久删除监管策略。
如果策略仍分配给任何租户/用户/组,则失败。先在每个主题上运行deployment tenant\|user\|group remove ,然后重试。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<policyIdentifier> | 是 | 策略 GUID,来自 list。 |
示例
uip gov aops-policy delete a1b2c3d4-0000-0000-0000-000000000001
uip gov aops-policy delete a1b2c3d4-0000-0000-0000-000000000001
数据形状(--输出 json)
{ "Code": "AopsPolicyDelete", "Data": { "Status": "Deleted", "identifier": "a1b2c3d4-0000-0000-0000-000000000001" } }
{ "Code": "AopsPolicyDelete", "Data": { "Status": "Deleted", "identifier": "a1b2c3d4-0000-0000-0000-000000000001" } }
uip gov aops 策略产品
发布监管模板的产品只读目录。用于发现有效的 --product-name 值。
uip gov aops 策略产品列表
示例
uip gov aops-policy product list
uip gov aops-policy product list
数据形状(--输出 json)
{
"Code": "AopsProductList",
"Data": [
{ "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" }
]
}
{
"Code": "AopsProductList",
"Data": [
{ "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" }
]
}
name 是 policy create --product-name、template get <productIdentifier> 和 deployment ... configure 条目所需的; label 是显示名称。
uip gov aops 策略产品获取
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<productIdentifier> | 是 | 产品名称(例如StudioX)或 GUID — 可以是 name 或来自 identifier 的 product list。 |
示例
uip gov aops-policy product get StudioX
uip gov aops-policy product get StudioX
数据形状(--输出 json)
{ "Code": "AopsProductGet", "Data": { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" } }
{ "Code": "AopsProductGet", "Data": { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" } }
uip gov aops 策略许可证类型
许可证类型的只读目录(例如Attended、Unattended)— 用于限定 deployment tenant configure 条目的范围,并作为 deployed-policy get/<license-type> 的 list 参数。
uip gov aops 策略许可证类型列表
示例
uip gov aops-policy license-type list
uip gov aops-policy license-type list
数据形状(--输出 json)
{
"Code": "AopsLicenseTypeList",
"Data": [
{ "identifier": "a1b2c3d4-0000-0000-0000-0000000000A1", "name": "Attended" },
{ "identifier": "a1b2c3d4-0000-0000-0000-0000000000A2", "name": "Unattended" }
]
}
{
"Code": "AopsLicenseTypeList",
"Data": [
{ "identifier": "a1b2c3d4-0000-0000-0000-0000000000A1", "name": "Attended" },
{ "identifier": "a1b2c3d4-0000-0000-0000-0000000000A2", "name": "Unattended" }
]
}
identifier 订阅源 deployment tenant configure 条目;显示的 name 为 deployed-policy get/list 接受的 <license-type>。
uip gov aops 策略模板
根据产品的 Form.io 策略模板(策略的 data 有效负载的来源)生成可填写的表单数据蓝图(和人类可读的参考)。
uip gov aops 策略模板获取
获取一个产品的活动 Form.io 模板,并发出策略工件。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<productIdentifier> | 是 | 产品名称或标识符(例如StudioX)。 |
选项
| 长 | 值 | 描述 |
|---|---|---|
--output-form-data <path> | 路径 | 编写可填写的表单数据蓝图 JSON — 您在 create/update 编辑并重新提交的对象。会跳过仅显示组件(隐藏、按钮、提交、HTML、内容);缺失的叶节点获取与类型相应的默认值(复选框为 false,编辑网格为 [],选择框为 {},文本/选择为 null)。 |
--output-template-locale-resource <path> | 路径 | 编写人类可读的区域设置解析引用:每个产品范围内的区域设置键都被替换为其英语字符串(同级 <prop>-key 保留原始字符串),并且 defaultData.data 变为平面标注映射 ({ value, type, label, description?, tooltip? })。跨产品前缀(例如AutomationOps.submit)的问题未解决。 |
如果两个 --output-* 标志均未传递,则模板和表单数据将在标准输出 Data 有效负载中同时返回。
示例
uip gov aops-policy template get StudioX --output-form-data form-data.json --output-template-locale-resource reference.json
uip gov aops-policy template get StudioX --output-form-data form-data.json --output-template-locale-resource reference.json
数据形状(--输出 json)
{
"Code": "AopsPolicyTemplateGet",
"Data": {
"formDataFile": "/Users/alice/aops/form-data.json",
"templateLocaleResourceFile": "/Users/alice/aops/reference.json"
}
}
{
"Code": "AopsPolicyTemplateGet",
"Data": {
"formDataFile": "/Users/alice/aops/form-data.json",
"templateLocaleResourceFile": "/Users/alice/aops/reference.json"
}
}
如果未传递 --output-* 标志,则 Data 会直接包含 template(原始 Form.io DTO)和 formData(蓝图) — 两者都保留其原生 Form.io 按键大小写,而不是采用帕斯卡命名法,因此formData 次往返,create/update --input 个原义。
UnsupportedTemplateComponentError(产品模板使用 CLI 无法转换的组件类型)会失败,并显示 ErrorCode: "configuration_error" 和 Retry: "RetryWillNotFix" — 在这种情况下,请手动创建策略 data。
uip gov aops 策略模板列表
获取每个产品的模板并转储每个产品的完整工件集 — 使用 template get,而不是循环。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--output-dir <path> | 路径 | 是 | <ProductName>/每个产品(包含form-template.json 、form-data.json 、form-template-locale-resource.json )在其下创建一个 文件夹的目录。 |
系统会收集每个产品的故障信息,并且不会中止运行 — 仅当每个产品都发生故障时,命令才会以非零值退出。
示例
uip gov aops-policy template list --output-dir ./aops-templates
uip gov aops-policy template list --output-dir ./aops-templates
数据形状(--输出 json)
{
"Code": "AopsPolicyTemplateList",
"Data": {
"outputDir": "/Users/alice/aops-templates",
"results": [
{
"productName": "StudioX",
"status": "Success",
"templateFile": "/Users/alice/aops-templates/StudioX/form-template.json",
"formDataFile": "/Users/alice/aops-templates/StudioX/form-data.json",
"templateLocaleResourceFile": "/Users/alice/aops-templates/StudioX/form-template-locale-resource.json"
}
]
}
}
{
"Code": "AopsPolicyTemplateList",
"Data": {
"outputDir": "/Users/alice/aops-templates",
"results": [
{
"productName": "StudioX",
"status": "Success",
"templateFile": "/Users/alice/aops-templates/StudioX/form-template.json",
"formDataFile": "/Users/alice/aops-templates/StudioX/form-data.json",
"templateLocaleResourceFile": "/Users/alice/aops-templates/StudioX/form-template-locale-resource.json"
}
]
}
}
失败产品的条目具有 status: "Failure" 和一个 message 字段,而不是三个文件路径。
相关内容
uip gov— 工具概述和访问策略。aops-policy deployment和deployed-policy— 向租户/用户/组分配策略,解析有效策略。compliance-packs— 将策略捆绑到命名框架中。
另请参阅
- 大纲
- uip gov aops 策略列表
- 选项
- 示例
- 数据形状(--输出 json)
- uip gov aops 策略获取
- 参数
- 示例
- 数据形状(--输出 json)
- uip gov aops 策略创建
- 选项
- 示例
- 数据形状(--输出 json)
- uip gov aops 策略更新
- 选项
- 示例
- 数据形状(--输出 json)
- uip gov aops 策略删除
- 参数
- 示例
- 数据形状(--输出 json)
- uip gov aops 策略产品
- uip gov aops 策略产品列表
- uip gov aops 策略产品获取
- uip gov aops 策略许可证类型
- uip gov aops 策略许可证类型列表
- uip gov aops 策略模板
- uip gov aops 策略模板获取
- uip gov aops 策略模板列表
- 相关内容
- 另请参阅