@thinkingai/ae-cli 6.1.9 → 6.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -3
- package/README.zh.md +25 -3
- package/dist/{auth-56Z45UVR.js → auth-GDV3H5I4.js} +18 -8
- package/dist/{auth-ENM3FE6L.js → auth-NN55553T.js} +3 -3
- package/dist/{capability-2H6PAOA3.js → capability-TPORIKRQ.js} +19 -15
- package/dist/{capability-YPOQX6PL.js → capability-VQNC5CF7.js} +19 -15
- package/dist/chunk-4NN5IWVN.js +26 -0
- package/dist/{chunk-DB4Q3ANU.js → chunk-6A2FUCIS.js} +3 -3
- package/dist/{chunk-PVBYJWC2.js → chunk-7KQWSBSL.js} +4 -4
- package/dist/{chunk-24BAVOX3.js → chunk-AXDXJTPC.js} +3 -1
- package/dist/{chunk-CPVTECJ3.js → chunk-DT6Y3TD7.js} +5 -5
- package/dist/{chunk-EGEIXA2Z.js → chunk-DWO43OIB.js} +0 -248
- package/dist/{chunk-V6FR6WTW.js → chunk-GJJA4CQZ.js} +34 -2
- package/dist/{chunk-RGXCNC4N.js → chunk-GS2P7LFD.js} +50 -17
- package/dist/{chunk-LYVNONC4.js → chunk-JHENBQ5B.js} +35 -0
- package/dist/{chunk-3P3562ZX.js → chunk-MVDZ7DBQ.js} +5 -5
- package/dist/{chunk-LCXU3AAT.js → chunk-NBPKWKRA.js} +2 -2
- package/dist/{chunk-HQ2A7ITL.js → chunk-RBNKI5ZW.js} +50 -17
- package/dist/{chunk-LHVM35J4.js → chunk-TS6BUGUY.js} +4 -4
- package/dist/chunk-TUKQZTMI.js +250 -0
- package/dist/{chunk-J7MZHDHQ.js → chunk-VKD5WQKN.js} +5 -5
- package/dist/{chunk-3KI3RRXX.js → chunk-VTXHDCBW.js} +3 -3
- package/dist/{chunk-KTYR3U6D.js → chunk-YTG6Q75E.js} +10 -6
- package/dist/{chunk-IR4ZLVPW.js → chunk-YV52FB5G.js} +25 -3
- package/dist/{chunk-E7UXXHO3.js → chunk-Z3OXWCIA.js} +3 -3
- package/dist/{cli-token-4SBMXAUK.js → cli-token-GL5MS5FK.js} +4 -4
- package/dist/{client-PP5FETMW.js → client-DAIPF7XN.js} +4 -4
- package/dist/{community-report-client-KK2QBANO.js → community-report-client-M2RW4MXD.js} +2 -2
- package/dist/config-4VZNLBKF.js +489 -0
- package/dist/index.js +94 -35
- package/dist/memory-RWJW4XFO.js +892 -0
- package/dist/memory-VO2ZJCRT.js +892 -0
- package/dist/{metadata-JIQ77HFY.js → metadata-YGTHR2XJ.js} +8 -8
- package/dist/{metadata-AN3YFZEV.js → metadata-ZRN2GHPN.js} +8 -8
- package/dist/{model-JASQVOFD.js → model-CLUIK3K5.js} +7 -5
- package/dist/{raw-XJCAT3HX.js → raw-52B4UKO4.js} +8 -7
- package/dist/sync-3REDHGY6.js +10259 -0
- package/dist/{te-agent-JHUG6DVV.js → te-agent-XNPELAKX.js} +580 -84
- package/dist/{te-analysis-IWQZO423.js → te-analysis-GJI5FZUL.js} +1611 -25
- package/dist/{te-analysis-X222IRYR.js → te-analysis-N2BRDJZ5.js} +1611 -25
- package/dist/{te-community-QOYIYEJI.js → te-community-SQXKE5OO.js} +7 -7
- package/dist/{te-community-UFKI6ONP.js → te-community-TYSNU3NQ.js} +7 -7
- package/dist/{te-dataops-PZQ5NQLY.js → te-dataops-5TM7WZDI.js} +370 -189
- package/dist/{te-dataops-XTWVTJCA.js → te-dataops-OWIADNSM.js} +370 -189
- package/dist/{te-engage-NLZUPSBK.js → te-engage-F7V55KVW.js} +333 -105
- package/dist/{te-engage-E7F4HTXU.js → te-engage-FMYAYCNV.js} +333 -105
- package/dist/{te-experiment-N63WF7XA.js → te-experiment-JWXOYJ3W.js} +83 -10
- package/dist/{te-experiment-D32TB6ZB.js → te-experiment-UPDMHCAJ.js} +83 -10
- package/dist/{te-kb-E7NSCBRB.js → te-kb-VRMEY3D4.js} +6 -6
- package/dist/{te-meta-GBDTMPEL.js → te-meta-53BVXPFI.js} +7 -7
- package/dist/{te-meta-ZTLTSHXC.js → te-meta-TOCBPBXI.js} +7 -7
- package/dist/{te-system-AH7DMCAQ.js → te-system-XGS5EQIQ.js} +4 -4
- package/dist/{te-team-BQ3SKSZV.js → te-team-BZRDV2CM.js} +7 -7
- package/dist/{update-DKG6UXEM.js → update-HEDXGOJH.js} +8 -6
- package/package.json +5 -2
- package/skills/ae-agent/SKILL.md +178 -16
- package/skills/ae-agent/references/add-skill.md +22 -10
- package/skills/ae-agent/references/edit-skill.md +24 -14
- package/skills/ae-agent/references/find-archived-conversations.md +82 -0
- package/skills/ae-agent/references/restore-conversation.md +54 -0
- package/skills/ae-agent/references/upload-skill.md +24 -14
- package/skills/ae-analysis/SKILL.md +1 -1
- package/skills/ae-analysis/references/command_index.md +109 -42
- package/skills/ae-analysis/references/debug_data_list.md +28 -0
- package/skills/ae-analysis/references/debug_device_add.md +23 -0
- package/skills/ae-analysis/references/debug_device_list.md +19 -0
- package/skills/ae-analysis/references/debug_device_select.md +22 -0
- package/skills/ae-analysis/references/entity_id_import_options.md +1 -1
- package/skills/ae-analysis/references/plan_sync_display_names.md +28 -0
- package/skills/ae-analysis/references/project_access_detail_get.md +3 -3
- package/skills/ae-analysis/references/project_data_power_delete.md +3 -3
- package/skills/ae-analysis/references/project_data_power_get.md +3 -3
- package/skills/ae-analysis/references/project_data_power_list.md +3 -3
- package/skills/ae-analysis/references/project_data_power_upsert.md +3 -3
- package/skills/ae-analysis/references/project_entity_create.md +3 -3
- package/skills/ae-analysis/references/project_entity_delete.md +3 -3
- package/skills/ae-analysis/references/project_entity_event_list.md +3 -3
- package/skills/ae-analysis/references/project_entity_get.md +3 -3
- package/skills/ae-analysis/references/project_entity_list.md +3 -3
- package/skills/ae-analysis/references/project_entity_update.md +3 -3
- package/skills/ae-analysis/references/project_function_list.md +3 -3
- package/skills/ae-analysis/references/project_info_create.md +25 -0
- package/skills/ae-analysis/references/project_info_delete.md +24 -0
- package/skills/ae-analysis/references/project_info_get.md +3 -3
- package/skills/ae-analysis/references/project_info_list.md +3 -3
- package/skills/ae-analysis/references/project_info_update.md +3 -3
- package/skills/ae-analysis/references/project_mark_time_create.md +3 -3
- package/skills/ae-analysis/references/project_mark_time_delete.md +3 -3
- package/skills/ae-analysis/references/project_mark_time_list.md +3 -3
- package/skills/ae-analysis/references/project_mark_time_update.md +3 -3
- package/skills/ae-analysis/references/project_member_add.md +3 -3
- package/skills/ae-analysis/references/project_member_batch_update.md +3 -3
- package/skills/ae-analysis/references/project_member_candidate_list.md +3 -3
- package/skills/ae-analysis/references/project_member_handover_export.md +3 -3
- package/skills/ae-analysis/references/project_member_handover_run.md +3 -3
- package/skills/ae-analysis/references/project_member_import.md +3 -3
- package/skills/ae-analysis/references/project_member_list.md +3 -3
- package/skills/ae-analysis/references/project_member_receiver_list.md +3 -3
- package/skills/ae-analysis/references/project_member_remove.md +3 -3
- package/skills/ae-analysis/references/project_member_update.md +3 -3
- package/skills/ae-analysis/references/project_owner_update.md +3 -3
- package/skills/ae-analysis/references/project_permission_binding_list.md +3 -3
- package/skills/ae-analysis/references/project_receive_status_update.md +3 -3
- package/skills/ae-analysis/references/project_role_delete.md +3 -3
- package/skills/ae-analysis/references/project_role_function_list.md +3 -3
- package/skills/ae-analysis/references/project_role_get.md +3 -3
- package/skills/ae-analysis/references/project_role_list.md +3 -3
- package/skills/ae-analysis/references/project_role_upsert.md +3 -3
- package/skills/ae-analysis/references/project_role_user_list.md +3 -3
- package/skills/ae-analysis/references/project_space_list.md +1 -1
- package/skills/ae-analysis/references/project_timezone_get.md +3 -3
- package/skills/ae-analysis/references/project_timezone_overview.md +3 -3
- package/skills/ae-analysis/references/project_timezone_update.md +3 -3
- package/skills/ae-analysis/references/project_user_id_items_update.md +3 -3
- package/skills/ae-analysis/references/system_admin_function_list.md +22 -0
- package/skills/ae-analysis/references/system_admin_function_update.md +26 -0
- package/skills/ae-analysis/references/system_admin_list.md +21 -0
- package/skills/ae-analysis/references/system_admin_remove.md +25 -0
- package/skills/ae-analysis/references/system_admin_upsert.md +25 -0
- package/skills/ae-analysis/references/system_function_list.md +21 -0
- package/skills/ae-analysis/references/system_member_add.md +25 -0
- package/skills/ae-analysis/references/system_member_candidate_list.md +22 -0
- package/skills/ae-analysis/references/system_member_delete.md +25 -0
- package/skills/ae-analysis/references/system_member_list.md +24 -0
- package/skills/ae-analysis/references/system_member_mfa_unbind.md +25 -0
- package/skills/ae-analysis/references/system_member_password_reset.md +32 -0
- package/skills/ae-analysis/references/system_member_project_batch_update.md +27 -0
- package/skills/ae-analysis/references/system_member_status_update.md +26 -0
- package/skills/ae-analysis/references/system_member_update.md +23 -0
- package/skills/ae-analysis/references/system_mfa_get.md +21 -0
- package/skills/ae-analysis/references/system_mfa_update.md +25 -0
- package/skills/ae-analysis/references/system_node_monitor_list.md +24 -0
- package/skills/ae-analysis/references/system_oauth2_update.md +22 -0
- package/skills/ae-analysis/references/system_ops_alert_contact_delete.md +25 -0
- package/skills/ae-analysis/references/system_ops_alert_contact_list.md +23 -0
- package/skills/ae-analysis/references/system_ops_alert_contact_test.md +29 -0
- package/skills/ae-analysis/references/system_ops_alert_contact_upsert.md +39 -0
- package/skills/ae-analysis/references/system_preference_get.md +21 -0
- package/skills/ae-analysis/references/system_preference_update.md +22 -0
- package/skills/ae-analysis/references/system_project_usage_list.md +28 -0
- package/skills/ae-analysis/references/system_query_alert_rule_list.md +21 -0
- package/skills/ae-analysis/references/system_query_alert_rule_update.md +26 -0
- package/skills/ae-analysis/references/system_query_monitor_overview.md +26 -0
- package/skills/ae-analysis/references/system_query_task_cancel.md +25 -0
- package/skills/ae-analysis/references/system_query_task_export.md +49 -0
- package/skills/ae-analysis/references/system_query_task_get.md +23 -0
- package/skills/ae-analysis/references/system_query_task_list.md +35 -0
- package/skills/ae-analysis/references/system_query_task_options.md +27 -0
- package/skills/ae-analysis/references/system_receiver_address_delete.md +26 -0
- package/skills/ae-analysis/references/system_receiver_address_overview.md +21 -0
- package/skills/ae-analysis/references/system_receiver_address_project_list.md +21 -0
- package/skills/ae-analysis/references/system_receiver_address_promote.md +24 -0
- package/skills/ae-analysis/references/system_receiver_address_upsert.md +27 -0
- package/skills/ae-analysis/references/system_receiver_detection_get.md +22 -0
- package/skills/ae-analysis/references/system_receiver_detection_run.md +22 -0
- package/skills/ae-analysis/references/system_receiver_detection_update.md +25 -0
- package/skills/ae-analysis/references/system_role_delete.md +26 -0
- package/skills/ae-analysis/references/system_role_function_list.md +22 -0
- package/skills/ae-analysis/references/system_role_get.md +22 -0
- package/skills/ae-analysis/references/system_role_list.md +24 -0
- package/skills/ae-analysis/references/system_role_upsert.md +27 -0
- package/skills/ae-analysis/references/system_role_user_list.md +22 -0
- package/skills/ae-analysis/references/system_seat_list.md +25 -0
- package/skills/ae-analysis/references/system_seat_update.md +26 -0
- package/skills/ae-analysis/references/system_smtp_delete.md +24 -0
- package/skills/ae-analysis/references/system_smtp_get.md +21 -0
- package/skills/ae-analysis/references/system_smtp_test.md +22 -0
- package/skills/ae-analysis/references/system_smtp_upsert.md +31 -0
- package/skills/ae-analysis/references/system_third_party_login_disable.md +25 -0
- package/skills/ae-analysis/references/system_third_party_login_list.md +21 -0
- package/skills/ae-analysis/references/system_third_party_login_upsert.md +33 -0
- package/skills/ae-analysis/references/system_usage_overview.md +21 -0
- package/skills/ae-analysis/references/system_usage_trend_export.md +44 -0
- package/skills/ae-analysis/references/system_usage_trend_query.md +28 -0
- package/skills/ae-dataops/SKILL.md +1 -1
- package/skills/ae-dataops/references/dataops-flow-create.md +51 -16
- package/skills/ae-engage/SKILL.md +56 -26
- package/skills/ae-engage/references/activity-activity.md +3 -0
- package/skills/ae-engage/references/activity-approval.md +12 -4
- package/skills/ae-engage/references/activity-task.md +21 -6
- package/skills/ae-engage/references/activity-topic.md +31 -13
- package/skills/ae-engage/references/add-channel.md +170 -41
- package/skills/ae-engage/references/build-task-save-guide.md +40 -27
- package/skills/ae-engage/references/channel-update-config.md +3 -2
- package/skills/ae-engage/references/common-metric.md +48 -120
- package/skills/ae-engage/references/flow-detail.md +13 -0
- package/skills/ae-engage/references/preset-event.md +12 -32
- package/skills/ae-engage/references/save-flow.md +127 -64
- package/skills/ae-engage/references/save-task.md +197 -59
- package/skills/ae-engage/references/scene-config-metric.md +3 -0
- package/skills/ae-engage/references/scene-preset-metric.md +8 -37
- package/skills/ae-engage/references/scene-strategy-audience.md +51 -643
- package/skills/ae-engage/references/scene-strategy.md +6 -6
- package/skills/ae-engage/references/task-detail.md +10 -0
- package/skills/ae-engage/references/task-submit-approval.md +45 -0
- package/skills/ae-engage/references/validate-flow-node-config.md +1 -1
- package/skills/ae-experiment/SKILL.md +21 -1
- package/skills/ae-experiment/references/check_experiment_ready.md +2 -0
- package/skills/ae-experiment/references/query_experiment_detail.md +6 -0
- package/skills/ae-experiment/references/query_experiment_list.md +4 -0
- package/skills/ae-experiment/references/query_experiment_list_archived.md +3 -0
- package/skills/ae-experiment/references/query_metric_detail.md +5 -0
- package/skills/ae-experiment/references/query_metric_list.md +3 -0
- package/skills/ae-experiment/references/save_experiment.md +46 -3
- package/skills/ae-experiment/references/save_metric.md +62 -0
- package/skills/ae-experiment/references/save_submit_experiment.md +3 -0
- package/skills/ae-experiment-design/SKILL.md +149 -0
- package/skills/ae-experiment-design/agents/openai.yaml +4 -0
- package/skills/ae-experiment-design/references/client-experiment-sdk.md +147 -0
- package/skills/ae-experiment-design/references/experiment-creation.md +108 -0
- package/skills/ae-experiment-design/references/experiment-sdk-contract.md +100 -0
- package/skills/ae-experiment-design/references/exposure-contract.md +91 -0
- package/skills/ae-experiment-design/references/hybrid-experiment-sdk.md +74 -0
- package/skills/ae-experiment-design/references/metric-readiness.md +143 -0
- package/skills/ae-experiment-design/references/platform-operations.md +99 -0
- package/skills/ae-experiment-design/references/sdk-index.md +76 -0
- package/skills/ae-experiment-design/references/sdk-integration.md +114 -0
- package/skills/ae-experiment-design/references/sdk-troubleshooting.md +139 -0
- package/skills/ae-experiment-design/references/server-experiment-sdk.md +78 -0
- package/skills/ae-experiment-design/scripts/calculate_experiment_plan.py +450 -0
- package/skills/ae-experiment-insight/SKILL.md +149 -0
- package/skills/ae-experiment-insight/agents/openai.yaml +4 -0
- package/skills/ae-experiment-insight/references/decision-framework.md +69 -0
- package/skills/ae-experiment-insight/references/diagnostic-playbook.md +225 -0
- package/skills/ae-experiment-insight/references/platform-operations.md +76 -0
- package/skills/ae-experiment-insight/scripts/analyze_experiment.py +478 -0
- package/skills/ae-generate-tracking-code/SKILL.md +24 -8
- package/skills/ae-generate-tracking-code/references/debug-script.md +46 -37
- package/skills/ae-generate-tracking-plan/SKILL.md +26 -1
- package/skills/ae-metadata/SKILL.md +1 -1
- package/dist/config-BSSALXEN.js +0 -128
- package/dist/sync-QFP4XFN3.js +0 -485
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# system ops-alert-contact upsert
|
|
2
|
+
|
|
3
|
+
Use when the user needs to create or update an operations-alert contact without exposing webhooks on argv.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system ops-alert-contact operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system ops-alert-contact upsert --company-id <company_id> --name <name> --mail-address <mail_address> --on-status 1
|
|
11
|
+
ae-cli system ops-alert-contact upsert --company-id <company_id> --contact-id <contact_id> --feishu-webhook-file <chmod_600_file>
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `system.ops_alert_contact.upsert`.
|
|
15
|
+
|
|
16
|
+
Sensitive values are accepted only through a permission-protected file or stdin. Never put a secret value in argv, examples, logs, validation output, dry-run output, or the response.
|
|
17
|
+
|
|
18
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Required | Description |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| `--company-id` | Yes | Company ID. |
|
|
25
|
+
| `--contact-id` | No | Existing contact ID; omit to create. |
|
|
26
|
+
| `--name` | No | Contact name. |
|
|
27
|
+
| `--mail-address` | No | Email delivery target. |
|
|
28
|
+
| `--mobile` | No | Mobile delivery target. |
|
|
29
|
+
| `--on-status` | No | Enable state: 0 or 1; required on create. |
|
|
30
|
+
| `--dingding-webhook-file` | No | DingTalk webhook. Read from a local permission-protected file; the value is never accepted directly on argv. |
|
|
31
|
+
| `--dingding-webhook-stdin` | No | DingTalk webhook. Read from stdin; do not combine with --dingding-webhook-file. |
|
|
32
|
+
| `--wechat-webhook-file` | No | WeCom webhook. Read from a local permission-protected file; the value is never accepted directly on argv. |
|
|
33
|
+
| `--wechat-webhook-stdin` | No | WeCom webhook. Read from stdin; do not combine with --wechat-webhook-file. |
|
|
34
|
+
| `--feishu-webhook-file` | No | Feishu webhook. Read from a local permission-protected file; the value is never accepted directly on argv. |
|
|
35
|
+
| `--feishu-webhook-stdin` | No | Feishu webhook. Read from stdin; do not combine with --feishu-webhook-file. |
|
|
36
|
+
| `--slack-webhook-file` | No | Slack webhook. Read from a local permission-protected file; the value is never accepted directly on argv. |
|
|
37
|
+
| `--slack-webhook-stdin` | No | Slack webhook. Read from stdin; do not combine with --slack-webhook-file. |
|
|
38
|
+
| `--kim-webhook-file` | No | KIM webhook. Read from a local permission-protected file; the value is never accepted directly on argv. |
|
|
39
|
+
| `--kim-webhook-stdin` | No | KIM webhook. Read from stdin; do not combine with --kim-webhook-file. |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# system preference get
|
|
2
|
+
|
|
3
|
+
Use when the user needs to get typed company preferences exposed to CLI.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system preference operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system preference get --company-id <company-id>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.preference.get`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# system preference update
|
|
2
|
+
|
|
3
|
+
Use when the user needs to update typed company navigation preference.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system preference operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system preference update --company-id <company-id> --navigation-permission-hide <true_or_false>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.preference.update`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--navigation-permission-hide` | Yes | Hide navigation entries without permission. |
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# system project-usage list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list project storage and usage statistics in a bounded time range.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system project-usage operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system project-usage list --company-id <company-id> --start-time <start-time> --end-time <end-time>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.project_usage.list`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--start-time` | Yes | Inclusive ISO date/time lower bound. |
|
|
23
|
+
| `--end-time` | Yes | Inclusive ISO date/time upper bound. |
|
|
24
|
+
| `--fields` | No | Optional snake_case result field projection JSON array. |
|
|
25
|
+
| `--limit` | No | Page size. Default and maximum depend on the capability schema. |
|
|
26
|
+
| `--offset` | No | Zero-based result offset. |
|
|
27
|
+
| `--sort-by` | No | Sort field. |
|
|
28
|
+
| `--sort-order` | No | Sort direction. |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# system query-alert-rule list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list query-monitor alert rules and metric definitions.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system query-alert-rule operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system query-alert-rule list --company-id <company-id>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.query_alert_rule.list`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# system query-alert-rule update
|
|
2
|
+
|
|
3
|
+
Use when the user needs to batch upsert and delete query-monitor alert rules.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system query-alert-rule operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system query-alert-rule update --dry-run --company-id <company-id>
|
|
11
|
+
ae-cli system query-alert-rule update --company-id <company-id> --yes
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `system.query_alert_rule.update`.
|
|
15
|
+
|
|
16
|
+
Run `--dry-run` first, summarize the affected target and impact, then wait for explicit user confirmation before rerunning the unchanged command with global `--yes`.
|
|
17
|
+
|
|
18
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Required | Description |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| `--company-id` | Yes | Company ID. |
|
|
25
|
+
| `--upserts` | No | Rule upsert JSON array. |
|
|
26
|
+
| `--delete-ids` | No | Positive rule-ID JSON array to delete. |
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# system query-monitor overview
|
|
2
|
+
|
|
3
|
+
Use when the user needs to get bounded query queue and resource-monitor charts.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system query-monitor operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system query-monitor overview --company-id <company-id> --cluster-names <cluster-names_json>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.query_monitor.overview`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--duration-minutes` | No | Monitoring duration in minutes. Default: 60. |
|
|
23
|
+
| `--project-ids` | No | Project ID JSON array. |
|
|
24
|
+
| `--space-codes` | No | Project space-code JSON array. |
|
|
25
|
+
| `--cluster-names` | Yes | Query cluster-name JSON array. |
|
|
26
|
+
| `--point-interval-seconds` | No | Chart sample interval seconds. Default: 5. |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# system query-task cancel
|
|
2
|
+
|
|
3
|
+
Use when the user needs to cancel one running query-monitor task by task_id.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system query-task operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system query-task cancel --dry-run --company-id <company-id> --task-id <task-id>
|
|
11
|
+
ae-cli system query-task cancel --company-id <company-id> --task-id <task-id> --yes
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `system.query_task.cancel`.
|
|
15
|
+
|
|
16
|
+
Run `--dry-run` first, summarize the affected target and impact, then wait for explicit user confirmation before rerunning the unchanged command with global `--yes`.
|
|
17
|
+
|
|
18
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Required | Description |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| `--company-id` | Yes | Company ID. |
|
|
25
|
+
| `--task-id` | Yes | Query-monitor task ID, not a CLI run_id. |
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# system query-task export
|
|
2
|
+
|
|
3
|
+
Use when the user needs the complete bounded query-monitor task result as a cancellable CSV artifact.
|
|
4
|
+
|
|
5
|
+
Do not use it for an inline page; use `ae-cli system query-task list` instead.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system query-task options --company-id <company_id>
|
|
11
|
+
ae-cli system query-task export --company-id <company_id> --start-time '2026-07-24 00:00:00' --end-time '2026-07-24 23:59:59' --status-codes '[4]' --content-codes '[101]' --task-type-codes '[6]' --project-ids '[123]'
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `system.query_task.export`.
|
|
15
|
+
|
|
16
|
+
Always run `query-task options` first and select codes from its returned mappings. Do not guess numeric filter codes or cluster names.
|
|
17
|
+
|
|
18
|
+
Preserve the `run_id` from this exact submit response and poll:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
ae-cli analysis run inspect --run-id <run_id>
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
After success, preserve the same run's `artifact_id` and download:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
ae-cli analysis artifact download --run-id <run_id> --artifact-id <artifact_id> --output <output_path>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The artifact is CSV and this command intentionally has no `--artifact-format`. Cancel an unfinished export with `ae-cli analysis query cancel --run-id <run_id>`.
|
|
31
|
+
|
|
32
|
+
The response uses `ok`, `data`, and `meta`. Empty task data is a successful export when `ok=true`; preserve `request_id` and `invocation_id`.
|
|
33
|
+
|
|
34
|
+
## Parameters
|
|
35
|
+
|
|
36
|
+
| Parameter | Required | Description |
|
|
37
|
+
|---|---|---|
|
|
38
|
+
| `--company-id` | Yes | Company ID. |
|
|
39
|
+
| `--start-time` | Yes | Inclusive range start in `yyyy-MM-dd HH:mm:ss`. |
|
|
40
|
+
| `--end-time` | Yes | Inclusive range end in `yyyy-MM-dd HH:mm:ss`. |
|
|
41
|
+
| `--status-codes` | Yes | Non-empty task status-code JSON array. |
|
|
42
|
+
| `--content-codes` | Yes | Non-empty query content-code JSON array. |
|
|
43
|
+
| `--task-type-codes` | Yes | Non-empty query task-type-code JSON array. |
|
|
44
|
+
| `--project-ids` | Conditional | Non-empty project IDs or space codes are required. |
|
|
45
|
+
| `--space-codes` | Conditional | Non-empty space codes or project IDs are required. |
|
|
46
|
+
| `--cluster-names` | No | Optional cluster-name JSON array. |
|
|
47
|
+
| `--download-columns` | No | Optional allowlisted CSV column JSON array. |
|
|
48
|
+
| `--request-id` | No | Caller-supplied `cli_<32 lowercase hex>` lifecycle ID; generated when omitted. |
|
|
49
|
+
| `--timeout-seconds` | No | Maximum runtime, `1..21600`; default `21600`. |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# system query-task get
|
|
2
|
+
|
|
3
|
+
Use when the user needs to get a sanitized query-monitor task detail.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system query-task operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system query-task get --company-id <company-id> --task-id <task-id>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.query_task.get`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--task-id` | Yes | Query-monitor task ID. |
|
|
23
|
+
| `--sql-max-chars` | No | Maximum returned SQL characters. |
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# system query-task list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list query-monitor tasks within a mandatory bounded time range.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system query-task operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system query-task options --company-id <company_id>
|
|
11
|
+
ae-cli system query-task list --company-id <company_id> --start-time '2026-07-24 00:00:00' --end-time '2026-07-24 23:59:59' --status-codes '[4]' --content-codes '[101]' --task-type-codes '[6]' --project-ids '[123]'
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `system.query_task.list`.
|
|
15
|
+
|
|
16
|
+
Always run `query-task options` first and select codes from its returned status, content type, task type, project/workspace, and cluster mappings. Do not guess numeric codes.
|
|
17
|
+
|
|
18
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Required | Description |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| `--company-id` | Yes | Company ID. |
|
|
25
|
+
| `--start-time` | Yes | Inclusive ISO date/time lower bound. |
|
|
26
|
+
| `--end-time` | Yes | Inclusive ISO date/time upper bound. |
|
|
27
|
+
| `--project-ids` | No | Project ID JSON array. |
|
|
28
|
+
| `--space-codes` | No | Project space-code JSON array. |
|
|
29
|
+
| `--status-codes` | Yes | Task status-code JSON array. |
|
|
30
|
+
| `--content-codes` | Yes | Query content-code JSON array. |
|
|
31
|
+
| `--task-type-codes` | Yes | Query task-type-code JSON array. |
|
|
32
|
+
| `--cluster-names` | No | Optional cluster-name JSON array. |
|
|
33
|
+
| `--limit` | No | Maximum returned tasks. Default: 100, max: 1000. |
|
|
34
|
+
| `--offset` | No | Zero-based result offset. |
|
|
35
|
+
| `--fields` | No | Optional snake_case result field projection JSON array. |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# system query-task options
|
|
2
|
+
|
|
3
|
+
Use before query-task list or export to discover every valid filter value exposed by the current environment.
|
|
4
|
+
|
|
5
|
+
Command:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
ae-cli system query-task options --company-id <company_id>
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Capability id: `system.query_task.options`.
|
|
12
|
+
|
|
13
|
+
The response maps:
|
|
14
|
+
|
|
15
|
+
- `statuses[].code` to the localized task status name.
|
|
16
|
+
- `content_types[].code` to the localized content type name.
|
|
17
|
+
- `task_types[].code` to the localized task type name.
|
|
18
|
+
- `projects[].project_id` and `workspaces[].space_code` to display names.
|
|
19
|
+
- `clusters[].cluster_name` to its query engine metadata.
|
|
20
|
+
|
|
21
|
+
Use the returned codes and names unchanged in `query-task list` or `query-task export`. Do not infer codes from UI labels or examples.
|
|
22
|
+
|
|
23
|
+
## Parameters
|
|
24
|
+
|
|
25
|
+
| Parameter | Required | Description |
|
|
26
|
+
|---|---|---|
|
|
27
|
+
| `--company-id` | Yes | Company ID. |
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# system receiver-address delete
|
|
2
|
+
|
|
3
|
+
Use when the user needs to delete a receiver address.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system receiver-address operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system receiver-address delete --dry-run --company-id <company-id> --address-url <address-url> --address-type <address-type>
|
|
11
|
+
ae-cli system receiver-address delete --company-id <company-id> --address-url <address-url> --address-type <address-type> --yes
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `system.receiver_address.delete`.
|
|
15
|
+
|
|
16
|
+
Run `--dry-run` first, summarize the affected target and impact, then wait for explicit user confirmation before rerunning the unchanged command with global `--yes`.
|
|
17
|
+
|
|
18
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Required | Description |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| `--company-id` | Yes | Company ID. |
|
|
25
|
+
| `--address-url` | Yes | Receiver address URL. |
|
|
26
|
+
| `--address-type` | Yes | Receiver address type. |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# system receiver-address overview
|
|
2
|
+
|
|
3
|
+
Use when the user needs to get company receiver-address overview.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system receiver-address operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system receiver-address overview --company-id <company-id>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.receiver_address.overview`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# system receiver-address project-list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list project receiver-address overrides.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system receiver-address operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system receiver-address project-list --company-id <company-id>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.receiver_address.project_list`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# system receiver-address promote
|
|
2
|
+
|
|
3
|
+
Use when the user needs to promote a receiver address to company scope.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system receiver-address operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system receiver-address promote --company-id <company-id> --address-url <address-url> --address-type <address-type>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.receiver_address.promote`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--address-url` | Yes | Receiver address URL. |
|
|
23
|
+
| `--address-type` | Yes | Receiver address type. |
|
|
24
|
+
| `--remove-project-custom` | No | Remove matching project overrides after promotion. |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# system receiver-address upsert
|
|
2
|
+
|
|
3
|
+
Use when the user needs to create or update a typed receiver address.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system receiver-address operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system receiver-address upsert --company-id <company-id> --scope <scope> --address-url <address-url> --address-type <address-type>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.receiver_address.upsert`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--scope` | Yes | Receiver scope. |
|
|
23
|
+
| `--address-url` | Yes | Receiver address URL. |
|
|
24
|
+
| `--address-type` | Yes | Receiver address type. |
|
|
25
|
+
| `--project-ids` | No | Project ID JSON array; required for project scope. |
|
|
26
|
+
| `--original-address-url` | No | Original URL when changing an existing address. |
|
|
27
|
+
| `--original-address-type` | No | Original address type. |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# system receiver-detection get
|
|
2
|
+
|
|
3
|
+
Use when the user needs to get receiver-address detection configuration.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system receiver-detection operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system receiver-detection get --company-id <company-id> --address-url <address-url>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.receiver_detection.get`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--address-url` | Yes | Receiver address URL. |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# system receiver-detection run
|
|
2
|
+
|
|
3
|
+
Use when the user needs to run receiver-address detection now.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system receiver-detection operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system receiver-detection run --company-id <company-id> --address-url <address-url>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.receiver_detection.run`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--address-url` | Yes | Receiver address URL. |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# system receiver-detection update
|
|
2
|
+
|
|
3
|
+
Use when the user needs to update typed receiver-address detection configuration.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system receiver-detection operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system receiver-detection update --company-id <company-id> --address-url <address-url> --execute-type <execute-type> --schedule-type <schedule-type> --allow-notification <true_or_false>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.receiver_detection.update`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--address-url` | Yes | Receiver address URL. |
|
|
23
|
+
| `--execute-type` | Yes | Detection execution scope. |
|
|
24
|
+
| `--schedule-type` | Yes | Detection schedule. |
|
|
25
|
+
| `--allow-notification` | Yes | Allow detection notifications. |
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# system role delete
|
|
2
|
+
|
|
3
|
+
Use when the user needs to delete a company role and optionally migrate its users.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system role operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system role delete --dry-run --company-id <company-id> --role-name <role-name>
|
|
11
|
+
ae-cli system role delete --company-id <company-id> --role-name <role-name> --yes
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `system.role.delete`.
|
|
15
|
+
|
|
16
|
+
Run `--dry-run` first, summarize the affected target and impact, then wait for explicit user confirmation before rerunning the unchanged command with global `--yes`.
|
|
17
|
+
|
|
18
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Required | Description |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| `--company-id` | Yes | Company ID. |
|
|
25
|
+
| `--role-name` | Yes | Role name. |
|
|
26
|
+
| `--new-role-name` | No | Replacement role for affected users. |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# system role-function list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list functions assigned to a company role.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system role-function operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system role-function list --company-id <company-id> --role-name <role-name>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.role_function.list`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--role-name` | Yes | Role name. |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# system role get
|
|
2
|
+
|
|
3
|
+
Use when the user needs to get one company role.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system role operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system role get --company-id <company-id> --role-name <role-name>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.role.get`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--role-name` | Yes | Role name. |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# system role list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list company roles.
|
|
4
|
+
|
|
5
|
+
Do not use it outside the system role operation or with fields absent from the inspected capability schema.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli system role list --company-id <company-id>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `system.role.list`.
|
|
14
|
+
|
|
15
|
+
The response uses `ok`, `data`, and `meta`. Treat empty `data` as success when `ok=true`; preserve `request_id` and `invocation_id` when present.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--company-id` | Yes | Company ID. |
|
|
22
|
+
| `--query` | No | Optional keyword filter. |
|
|
23
|
+
| `--limit` | No | Page size. Default and maximum depend on the capability schema. |
|
|
24
|
+
| `--offset` | No | Zero-based result offset. |
|