# DaoCloud Enterprise

This recipe generates the `dc` CLI and agent Skill for DaoCloud Enterprise APIs.

The recipe is extracted from the generated
[`DaoCloud/daocloud-skills`](https://github.com/DaoCloud/daocloud-skills)
project and keeps only the reproducible Lathe inputs.

## Modules

- `global-management`: users, groups, workspaces, roles, and audit APIs.
- `container-management`: clusters, namespaces, workloads, and storage APIs.
- `insight`: observability APIs.

## Auth

The generated CLI requires a reachable DCE instance.

Use the generated auth command before executing API operations:

```sh
dc auth login --hostname https://<dce-host>
```

Agents should inspect auth state before executing commands whose catalog detail
has `auth.required=true`:

```sh
dc auth status --hostname https://<dce-host>
```

## Agent workflow

```sh
dc commands schema --json
dc commands --json
dc search "list clusters" --json
dc commands show container-management cluster list-clusters --json
```

Search results are discovery only. Inspect command details before execution.

## Source inputs

The recipe pins DaoCloud OpenAPI specs from:

```text
https://github.com/DaoCloud/daocloud-api-docs.git
```

Recipe overlays live under `overlays/` and are codegen-time polish only.

cli:
  name: dc
  short: "Command-line tool for DaoCloud Enterprise (DCE)"

skill:
  bundle: true

auth:
  validate:
    method: GET
    path: /apis/ghippo.io/v1alpha1/current-user
    display:
      username_field: username
      fallback_field: email

name: daocloud-dce
display_name: DaoCloud Enterprise
cli_name: dc
category: cloud-platform
homepage: https://github.com/DaoCloud/daocloud-skills
description: Generated dc CLI and agent Skill for DaoCloud Enterprise APIs.
maintainers:
  - github: samzong
auth:
  type: bearer
  notes: Requires a reachable DCE instance and token-based login.
smoke:
  intent: list clusters
  # operationId, not the leaf name: insight defines a list-clusters too
  expect: Cluster_ListClusters

commands:
  # ── 平台内部 API，不对外暴露 ──────────────────────────────────────────
  # BatchAudits
  batch-insert-audits:   { ignore: true }

  # FeatureGate
  get-feature-gate:      { ignore: true }

  # GProducts / GProductLicenses
  list-g-products:             { ignore: true }
  get-g-product:               { ignore: true }
  list-g-product-licenses:     { ignore: true }
  get-g-product-license:       { ignore: true }
  create-g-product-license:    { ignore: true }
  delete-g-product-license:    { ignore: true }
  update-g-product-license:    { ignore: true }

  # KeycloakEvent
  list-keycloak-events:  { ignore: true }

  # LoginPage
  get-login-page:        { ignore: true }
  update-login-page:     { ignore: true }

  # Openapi
  get-open-api:          { ignore: true }

  # ProductNavigator / TopNavigator
  list-product-navigators: { ignore: true }
  get-product-navigator:   { ignore: true }
  update-product-navigator: { ignore: true }
  list-top-navigators:     { ignore: true }
  get-top-navigator:       { ignore: true }
  update-top-navigator:    { ignore: true }

  # Publish
  publish:               { ignore: true }

  # Sms / SmtpSetting
  get-sms-config:        { ignore: true }
  update-sms-config:     { ignore: true }
  send-sms:              { ignore: true }
  get-smtp-setting:      { ignore: true }
  update-smtp-setting:   { ignore: true }
  test-smtp-setting:     { ignore: true }

  # Theme
  list-themes:           { ignore: true }
  get-theme:             { ignore: true }
  update-theme:          { ignore: true }
  create-theme:          { ignore: true }
  delete-theme:          { ignore: true }

  # ── 用户管理 (Users) ──────────────────────────────────────────────────
  list-users:
    short: "List platform users"
    aliases: [ls-users]
    example: |
      dc global-management users list-users
      dc global-management users list-users --page-size 50 -o json
    params:
      keyword:
        help: "Filter by username or email"
      page:
        default: "1"
      pageSize:
        help: "Number of results per page"
        default: "20"

  create-user:
    short: "Create a new platform user"
    example: |
      dc global-management users create-user \
        --set name=alice \
        --set password=changeme \
        --set description="Alice from dev team" \
        --set temporary=false

  get-user:
    short: "Get user details by ID"
    aliases: [describe-user]

  delete-user:
    short: "Delete a user by ID"

  update-user:
    short: "Update user profile"
    example: |
      dc global-management users update-user --id <id> \
        --set email=newemail@example.com \
        --set firstname=Alice \
        --set lastname=Smith \
        --set description="updated" \
        --set enabled=true

  set-user-password:
    short: "Set or reset a user's password"
    example: |
      dc global-management users set-user-password --id <id> \
        --set password=NewP@ssw0rd

  reset-user-m-f-a:
    short: "Reset MFA for a user"

  list-user-roles:
    short: "List roles assigned to a user"
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  update-user-roles:
    short: "Assign or update roles for a user"
    example: |
      # Add roles
      echo '{"addRoles":["Admin"],"removeRoles":[]}' | \
        dc global-management users update-user-roles --id <id> --file -
      # Remove roles
      echo '{"addRoles":[],"removeRoles":["Editor"]}' | \
        dc global-management users update-user-roles --id <id> --file -

  list-user-groups:
    short: "List groups a user belongs to"
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  create-user-access-token:
    short: "Create an access token for a user"
    example: |
      dc global-management users create-user-access-token --id <id> \
        --set name=my-token \
        --set expiredAt=2026-12-31T00:00:00Z

  list-user-access-tokens:
    short: "List access tokens for a user"

  delete-user-access-token:
    short: "Delete an access token"

  # ── 用户组 (Group) ────────────────────────────────────────────────────
  list-groups:
    short: "List user groups"
    aliases: [ls-groups]
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  create-group:
    short: "Create a user group"
    example: |
      dc global-management group create-group \
        --set name=dev-team \
        --set description="Development team"

  get-group:
    short: "Get group details"
    aliases: [describe-group]

  delete-group:
    short: "Delete a user group"

  update-group:
    short: "Update a user group"
    example: |
      dc global-management group update-group --id <id> \
        --set name=dev-team-renamed \
        --set description="Renamed team"

  # ── 工作空间 (Workspace) ──────────────────────────────────────────────
  list-workspaces:
    short: "List workspaces"
    aliases: [ls-ws, ls-workspaces]
    example: |
      dc global-management workspace list-workspaces
      dc global-management workspace list-workspaces -o json
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  create-workspace:
    short: "Create a workspace"
    example: |
      # alias is the display name; parentFolderId=0 places it under root
      dc global-management workspace create-workspace \
        --set alias=my-workspace \
        --set parentFolderId=0

  get-workspace:
    short: "Get workspace details"
    aliases: [describe-workspace]

  delete-workspace:
    short: "Delete a workspace"

  update-workspace:
    short: "Update a workspace"

  list-folders:
    short: "List folders (namespaces within workspaces)"
    aliases: [ls-folders]
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  create-folder:
    short: "Create a folder"
    example: |
      # alias is the display name; parentFolderId=0 places it under root
      dc global-management workspace create-folder \
        --set alias=my-folder \
        --set parentFolderId=0

  get-folder:
    short: "Get folder details"

  delete-folder:
    short: "Delete a folder"

  update-folder:
    short: "Update a folder"
    example: |
      dc global-management workspace update-folder --folder-id <id> \
        --set alias=new-folder-name

  authorize:
    short: "Grant a role to a user or group within a folder"
    example: |
      dc global-management workspace authorize --folder-id <folderId> \
        --set memberId=<userId> \
        --set memberType=user \
        --set memberName=alice \
        --set-str 'roleNames[0]=Workspace Admin'

  # ── 角色 (Role) ───────────────────────────────────────────────────────
  list-roles:
    short: "List platform roles"
    aliases: [ls-roles]
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  create-role:
    short: "Create a custom role"
    example: |
      # scope: platform | folder | workspace
      echo '{
        "name": "my-role",
        "description": "Custom role",
        "scope": "platform",
        "perms": [
          {"gproduct": "ghippo", "resourceType": "User", "action": "get"}
        ]
      }' | dc global-management role create-role --file -

  get-role:
    short: "Get role details"

  delete-role:
    short: "Delete a custom role"

  update-role:
    short: "Update a custom role"
    example: |
      echo '{
        "description": "Updated description",
        "perms": [
          {"gproduct": "ghippo", "resourceType": "User", "action": "get"}
        ]
      }' | dc global-management role update-role --name <name> --file -

  list-all-permissions:
    short: "List all available permissions"
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  # ── 身份提供商 (IDP / LDAP) ───────────────────────────────────────────
  list-i-d-ps:
    short: "List configured identity providers"
    aliases: [ls-idp]

  create-i-d-p:
    short: "Configure a new identity provider"

  get-i-d-p:
    short: "Get identity provider details"

  delete-i-d-p:
    short: "Remove an identity provider"

  update-i-d-p:
    short: "Update an identity provider"

  list-ldap-config:
    short: "List LDAP configurations"

  # ── 审计 (Audit) ──────────────────────────────────────────────────────
  list-audits:
    short: "List audit log entries"
    aliases: [ls-audit]
    example: |
      dc global-management audit list-audits --page-size 100 -o json
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  # ── 消息 (Message) ────────────────────────────────────────────────────
  list-messages:
    short: "List platform messages/notifications"
    params:
      page:
        default: "1"
      pageSize:
        default: "20"

  # ── 安全策略 (SecurityPolicy) ─────────────────────────────────────────
  get-security-policy:
    short: "Get current security policy settings"

  update-security-policy:
    short: "Update security policy settings"

  # ── 分页默认值 (其余分页命令) ─────────────────────────────────────────────
  list-open-sources:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-csp-audits:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-kube-audits:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  group-members:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-group-roles:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-group-subjects:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-folder-role-names:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-members-by-platform-role:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-members-folders-by-folder-role:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-members-workspaces-by-workspace-role:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-workspace-role-names:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-user-subjects:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-webhook-endpoint-events:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-webhook-endpoints:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-webhook-records-by-client-id:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-webhooks-by-client-id:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  folder-list-groups:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  folder-list-users:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-available-exclusive-resources-by-workspace:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-available-shared-resources-by-workspace:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-exclusive-resources-by-workspace:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-members-roles-by-folder:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-members-roles-by-workspace:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-shared-resources-by-workspace:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  move-workspace-folder-list:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

commands:
  # ── 告警平台内部 API ──────────────────────────────────────────────────
  # Alertmanager 回调入口，不对外暴露
  alert-hook:            { ignore: true }

  # 用不到
  get-net-flow:          { ignore: true }
  get-service-apdex:     { ignore: true }

  # ── 告警 - 告警实例 (Alerts) ──────────────────────────────────────────
  # 通用约定：
  #   - list-* 命令返回 { items: [...], pagination }
  #   - matches / sourceMatchers / targetMatchers 的 type 是枚举字符串：
  #     EQUAL | NOT_EQUAL | REGEXP | MATCH_TYPE_UNSPECIFIED（不是 "=" / "=~"）
  #   - rules[].source 必填，枚举：METRIC_TPL | PROMQL | LOG_TPL | EVENT_TPL
  list-alerts:
    short: "List alerts (active or historical)"
    aliases: [ls-alerts]
    example: |
      # Active alerts in a cluster
      dc insight alert list-alerts --cluster-name prod-1 --severity CRITICAL
      # Alert history (resolved=true)
      dc insight alert list-alerts --resolved=true --page 1 --page-size 50 -o json
      # Filter by group / rule
      dc insight alert list-alerts --group-id <gid> --rule-name "HighCPU"
    params:
      page:      { default: "1" }
      pageSize:  { default: "20" }
      severity:
        help:    "SEVERITY_UNSPECIFIED | CRITICAL | WARNING | INFO"
      targetType:
        help:    "TARGET_TYPE_UNSPECIFIED | GLOBAL | CLUSTER | NAMESPACE | NODE | DEPLOYMENT | STATEFULSET | DAEMONSET | POD"

  get-alert:
    short: "Get a single alert by ID"
    aliases: [describe-alert]
    example: |
      dc insight alert get-alert --id <alertId>
      dc insight alert get-alert --id <alertId> --resolved=true

  count-alert:
    short: "Count alerts grouped by time/severity/target"
    example: |
      # ⚠️ --start 与 --end（unix 秒）必填，缺失返回 HTTP 400 "value must be greater than 0"
      # --step 单位为分钟，0 表示返回时间范围内的总数（不分桶）
      END=$(date +%s); START=$((END - 86400))
      dc insight alert count-alert \
        --cluster-name kpanda-global-cluster \
        --severity CRITICAL \
        --start $START --end $END --step 60 \
        --group-by-type=true -o json

  clean-alert-history:
    short: "Trigger cleanup of alert history (respects retention config)"
    example: |
      dc insight alert clean-alert-history

  # ── 告警 - 告警组 (Group) ─────────────────────────────────────────────
  list-groups:
    short: "List alert groups"
    aliases: [ls-groups]
    example: |
      # All alert groups
      dc insight alert list-groups
      # Filter by name (fuzzy) within a cluster + namespace
      dc insight alert list-groups --name node --cluster-name prod-1 --namespace insight-system
      # Only built-in groups, page through results
      dc insight alert list-groups --builtin=true --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  get-group:
    short: "Get an alert group by ID"
    aliases: [describe-group]
    example: |
      dc insight alert get-group --id <gid>
      dc insight alert get-group --id <gid> -o json

  create-group:
    short: "Create an alert group (with rules / receivers)"
    example: |
      # ⚠️ 关键字段：
      #   clusterName  必填
      #   rules[].source 必填，枚举：METRIC_TPL | PROMQL | LOG_TPL | EVENT_TPL
      #     - METRIC_TPL  从指标模板派生（rules[].metricTpl 等）
      #     - PROMQL      自定义 PromQL 表达式（最常用，rules[].expr）
      #     - LOG_TPL     日志告警（额外字段：rules[].logTpl 等）
      #     - EVENT_TPL   事件告警
      #   缺少 source 会创建失败（典型表现：rule source unknown）
      echo '{
        "name": "node-health",
        "clusterName": "kpanda-global-cluster",
        "namespace": "insight-system",
        "description": "Node health alerts",
        "targetType": "NODE",
        "targets": ["*"],
        "receivers": [
          {"type": "email", "names": ["ops-mail"]}
        ],
        "notifyRepeatConfig": [
          {"severity": "CRITICAL", "interval": 300}
        ],
        "rules": [
          {
            "name": "NodeDown",
            "source": "PROMQL",
            "description": "node unreachable for 5m",
            "severity": "CRITICAL",
            "duration": "5m",
            "expr": "up{job=\"node-exporter\"} == 0",
            "labels": {"team": "ops"},
            "annotations": {"summary": "Node {{ $labels.instance }} down"}
          }
        ]
      }' | dc insight alert create-group --file -

  update-group:
    short: "Update an alert group (description / receivers / notify only)"
    example: |
      echo '{
        "description": "updated",
        "notificationTemplate": "default",
        "receivers": [{"type":"email","names":["ops-mail"]}],
        "notifyRepeatConfig": [{"severity":"WARNING","interval":600}]
      }' | dc insight alert update-group --id <gid> --file -

  delete-group:
    short: "Delete an alert group"
    example: |
      dc insight alert delete-group --id <gid>

  validate-group:
    short: "Validate a group definition (PrometheusRule YAML)"
    example: |
      echo '{
        "clusterName": "prod-1",
        "namespace": "insight-system",
        "yamlString": "groups:\n- name: my\n  rules:\n  - alert: A\n    expr: vector(1)\n"
      }' | dc insight alert validate-group --file -

  # ── 告警 - 告警规则 (GroupRule) ───────────────────────────────────────
  list-group-rules:
    short: "List rules under an alert group"
    aliases: [ls-group-rules]
    example: |
      # All rules in a group
      dc insight alert list-group-rules --id <gid>
      # Filter by name + severity
      dc insight alert list-group-rules --id <gid> --name HighCPU --severity CRITICAL
      # Only firing rules, paged
      dc insight alert list-group-rules --id <gid> --status FIRING --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      severity: { help: "SEVERITY_UNSPECIFIED | CRITICAL | WARNING | INFO" }
      status:   { help: "UNSPECIFIED | FIRING | ENABLED" }

  get-group-rule:
    short: "Get a single rule by group id + rule name"
    example: |
      dc insight alert get-group-rule --id <gid> --name HighCPU

  add-group-rule:
    short: "Add a rule to an existing group"
    example: |
      # rule.source 必填（METRIC_TPL | PROMQL | LOG_TPL | EVENT_TPL），见 create-group 说明
      echo '{
        "rule": {
          "name": "HighMem",
          "source": "PROMQL",
          "severity": "WARNING",
          "duration": "5m",
          "expr": "node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes < 0.1",
          "description": "memory low",
          "labels": {"team":"ops"},
          "annotations": {"summary":"low memory on {{ $labels.instance }}"}
        }
      }' | dc insight alert add-group-rule --id <gid> --file -

  update-group-rule:
    short: "Update a rule in a group"
    example: |
      echo '{
        "source":   "PROMQL",
        "severity": "CRITICAL",
        "duration": "10m",
        "expr": "rate(http_requests_total{code=~\"5..\"}[5m]) > 1",
        "description": "5xx rate too high"
      }' | dc insight alert update-group-rule --id <gid> --name HighErr --file -

  delete-group-rule:
    short: "Delete a rule from a group"
    example: |
      dc insight alert delete-group-rule --id <gid> --name HighCPU

  preview-rule:
    short: "Preview a rule's evaluation (matrix output) before saving"
    example: |
      # rule.source 必填（同 create-group / add-group-rule）；params 时间为 unix 秒字符串
      END=$(date +%s); START=$((END - 3600))
      echo '{
        "group": {"clusterName":"kpanda-global-cluster","targetType":"CLUSTER","targets":["*"]},
        "rule":  {"source":"PROMQL","expr":"vector(1)","duration":"1m","severity":"WARNING"},
        "params":{"start":"'"$START"'","end":"'"$END"'","step":60}
      }' | dc insight alert preview-rule --file -

  # ── 告警 - 通知接收人 (Receiver) ──────────────────────────────────────
  list-receivers:
    short: "List notification receivers"
    aliases: [ls-receivers]
    example: |
      # All receivers
      dc insight alert list-receivers
      # Only email receivers, exact name match
      dc insight alert list-receivers --type email --name ops-mail --exact-search=true
      # Paged JSON output
      dc insight alert list-receivers --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      type:     { help: "RECEIVER_TYPE_UNSPECIFIED | webhook | email | dingtalk | wecom | sms | message | lark" }

  get-receiver:
    short: "Get a receiver by name + type"
    aliases: [describe-receiver]
    example: |
      # ⚠️ --type 必填（proto enum.defined_only），缺失返回 HTTP 400 "type cannot be empty"
      # type 取值：webhook | email | dingtalk | wecom | sms | message | lark
      dc insight alert get-receiver --name ops-mail --type email -o json
      dc insight alert get-receiver --name my-bot   --type lark  -o json
    params:
      type: { help: "Required. webhook | email | dingtalk | wecom | sms | message | lark" }

  create-receiver:
    short: "Create a notification receiver (email/dingtalk/wecom/webhook/lark/sms/message)"
    example: |
      # Email receiver
      echo '{
        "name": "ops-mail",
        "type": "email",
        "description": "ops mailing list",
        "email": {"to": ["ops@example.com"]}
      }' | dc insight alert create-receiver --file -

      # Webhook receiver with bearer token
      echo '{
        "name": "my-webhook",
        "type": "webhook",
        "webhook": {
          "url": "https://hooks.example.com/insight",
          "httpConfig": {
            "bearerToken": "xxx",
            "tlsConfig": {"insecureSkipVerify": false}
          }
        }
      }' | dc insight alert create-receiver --file -

  update-receiver:
    short: "Update a notification receiver"
    example: |
      echo '{
        "name": "ops-mail",
        "type": "email",
        "description": "updated mailing list",
        "email": {"to": ["ops@example.com", "oncall@example.com"]}
      }' | dc insight alert update-receiver --name ops-mail --file -

  delete-receiver:
    short: "Delete a notification receiver"
    example: |
      dc insight alert delete-receiver --name ops-mail

  test-receiver:
    short: "Send a test message to a receiver definition"
    example: |
      echo '{
        "name": "ops-mail",
        "type": "email",
        "email": {"to": ["ops@example.com"]}
      }' | dc insight alert test-receiver --file -

  get-smtp-status:
    short: "Check whether SMTP is configured (required for email receivers)"
    example: |
      dc insight alert get-smtp-status
      dc insight alert get-smtp-status -o json

  # ── 告警 - SMS Provider ───────────────────────────────────────────────
  list-providers:
    short: "List SMS providers (Aliyun / Tencent / custom)"
    example: |
      dc insight alert list-providers
      dc insight alert list-providers --name aliyun --exact-search=true
      dc insight alert list-providers --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  get-provider:
    short: "Get an SMS provider by name"
    example: |
      dc insight alert get-provider --name aliyun-sms
      dc insight alert get-provider --name aliyun-sms -o json

  create-provider:
    short: "Create an SMS provider"
    example: |
      echo '{
        "name": "aliyun-sms",
        "type": "aliyun",
        "template": "default",
        "aliyun": {
          "accessKeyId": "AKID...",
          "accessKeySecret": "SECRET...",
          "signName": "MyCompany",
          "templateCode": "SMS_123"
        }
      }' | dc insight alert create-provider --file -

  update-provider:
    short: "Update an SMS provider"
    example: |
      echo '{
        "type": "aliyun",
        "template": "default",
        "aliyun": {
          "accessKeyId": "AKID...",
          "accessKeySecret": "NEW_SECRET",
          "signName": "MyCompany",
          "templateCode": "SMS_456"
        }
      }' | dc insight alert update-provider --name aliyun-sms --file -

  delete-provider:
    short: "Delete an SMS provider"
    example: |
      dc insight alert delete-provider --name aliyun-sms

  # ── 告警 - 通知模板 (Template) ────────────────────────────────────────
  list-templates:
    short: "List notification templates"
    aliases: [ls-templates]
    example: |
      dc insight alert list-templates
      dc insight alert list-templates --name crit --exact-search=false
      dc insight alert list-templates --builtin=true --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  list-template-summary:
    short: "List notification template summaries (lightweight)"
    example: |
      dc insight alert list-template-summary
      dc insight alert list-template-summary --builtin=true -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  get-template:
    short: "Get a notification template by name"
    example: |
      dc insight alert get-template --name crit-email
      dc insight alert get-template --name crit-email -o json

  create-template:
    short: "Create a notification template (body per channel)"
    example: |
      echo '{
        "name": "crit-email",
        "description": "critical alert template",
        "body": {
          "email": {
            "subject": "[CRITICAL] {{ .CommonLabels.alertname }}",
            "body": "{{ range .Alerts }}{{ .Annotations.summary }}\n{{ end }}"
          },
          "dingtalk": "**[CRITICAL]** {{ .CommonLabels.alertname }}",
          "wecom": "[CRITICAL] {{ .CommonLabels.alertname }}"
        }
      }' | dc insight alert create-template --file -

  update-template:
    short: "Update a notification template"
    example: |
      echo '{
        "description": "updated critical template",
        "body": {
          "email": {
            "subject": "[CRITICAL] {{ .CommonLabels.alertname }}",
            "body":    "{{ range .Alerts }}{{ .Annotations.summary }}\n{{ end }}"
          }
        }
      }' | dc insight alert update-template --name crit-email --file -

  delete-template:
    short: "Delete a notification template"
    example: |
      dc insight alert delete-template --name crit-email

  preview-template:
    short: "Render a notification template against sample alert data"
    example: |
      # ⚠️ data 字段使用 commonLabels（驼峰），不是 labels；alerts[] 必填
      # 模板里 {{ .CommonLabels.X }} 对应 body 输入的 data.commonLabels.X
      echo '{
        "body": {"email":{"subject":"[T] {{ .CommonLabels.alertname }}","body":"x"}},
        "data": {
          "status": "firing",
          "commonLabels": {"alertname":"HighCPU"},
          "alerts": [{"status":"firing","labels":{"instance":"node1"},"annotations":{"summary":"cpu hot"}}]
        }
      }' | dc insight alert preview-template --file -

  # ── 告警 - 规则模板 (RuleTemplate) ────────────────────────────────────
  list-rule-templates:
    short: "List alert rule templates (reusable rule bundles)"
    example: |
      dc insight alert list-rule-templates
      dc insight alert list-rule-templates --target-type NODE --builtin=false
      dc insight alert list-rule-templates --name node --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      targetType:
        help: "TARGET_TYPE_UNSPECIFIED | GLOBAL | CLUSTER | NAMESPACE | NODE | DEPLOYMENT | STATEFULSET | DAEMONSET | POD"

  list-rule-template-summary:
    short: "List rule template summaries (id/name/targetType only)"
    example: |
      dc insight alert list-rule-template-summary
      dc insight alert list-rule-template-summary --target-type CLUSTER -o json

  get-rule-template:
    short: "Get a rule template by ID"
    example: |
      dc insight alert get-rule-template --id <rtid>
      dc insight alert get-rule-template --id <rtid> -o json

  create-rule-template:
    short: "Create a rule template (bundle of rules)"
    example: |
      echo '{
        "name": "node-basics",
        "description": "basic node alerts",
        "targetType": "NODE",
        "rules": [
          {"name":"NodeDown","severity":"CRITICAL","duration":"5m","expr":"up == 0"},
          {"name":"NodeHighLoad","severity":"WARNING","duration":"10m","expr":"node_load5 > 8"}
        ]
      }' | dc insight alert create-rule-template --file -

  update-rule-template:
    short: "Update a rule template"
    example: |
      echo '{
        "description": "updated node basics",
        "rules": [
          {"name":"NodeDown","severity":"CRITICAL","duration":"10m","expr":"up == 0"},
          {"name":"NodeHighLoad","severity":"WARNING","duration":"15m","expr":"node_load5 > 10"}
        ]
      }' | dc insight alert update-rule-template --id <rtid> --file -

  delete-rule-template:
    short: "Delete a rule template"
    example: |
      dc insight alert delete-rule-template --id <rtid>

  # ── 告警 - 静默 (Silence) ─────────────────────────────────────────────
  list-silences:
    short: "List alert silences"
    aliases: [ls-silences]
    example: |
      # All silences (active and expired)
      dc insight alert list-silences
      # Only currently-active silences
      dc insight alert list-silences --expired=false
      # Filter by cluster + namespace
      dc insight alert list-silences --cluster-name prod-1 --namespace insight-system -o json

  get-silence:
    short: "Get a silence by ID"
    example: |
      dc insight alert get-silence --id <sid>
      dc insight alert get-silence --id <sid> -o json

  create-silence:
    short: "Create an alert silence (label matchers + optional schedule)"
    example: |
      # ⚠️ matches[].type 是枚举字符串，不是 "=" / "=~"。可选：
      #   EQUAL | NOT_EQUAL | REGEXP | MATCH_TYPE_UNSPECIFIED
      echo '{
        "name": "maint-window",
        "clusterName": "kpanda-global-cluster",
        "namespace": "insight-system",
        "description": "weekly maintenance",
        "matches": [
          {"type": "EQUAL",  "key": "alertname", "value": "HighCPU"},
          {"type": "REGEXP", "key": "instance",  "value": "node-.*"}
        ],
        "activeTimeInterval": {
          "weekdayRange": [0],
          "timeRanges": [{"start":"02:00","end":"04:00"}]
        }
      }' | dc insight alert create-silence --file -

  update-silence:
    short: "Update an alert silence"
    example: |
      echo '{
        "description": "extended maintenance window",
        "matches": [
          {"type": "EQUAL",  "key": "alertname", "value": "HighCPU"},
          {"type": "REGEXP", "key": "instance",  "value": "node-.*"}
        ],
        "activeTimeInterval": {
          "weekdayRange": [0, 6],
          "timeRanges": [{"start":"01:00","end":"05:00"}]
        }
      }' | dc insight alert update-silence --id <sid> --file -

  delete-silence:
    short: "Delete an alert silence"
    example: |
      dc insight alert delete-silence --id <sid>

  preview-silence:
    short: "Preview which alerts a silence definition would match"
    example: |
      # matches[].type 同 create-silence：EQUAL / NOT_EQUAL / REGEXP
      echo '{
        "clusterName": "kpanda-global-cluster",
        "namespace": "insight-system",
        "size": "20",
        "matches": [{"type":"EQUAL","key":"alertname","value":"HighCPU"}]
      }' | dc insight alert preview-silence --file -

  # ── 告警 - 抑制 (Inhibition) ──────────────────────────────────────────
  list-inhibitions:
    short: "List inhibition rules"
    aliases: [ls-inhibitions]
    example: |
      dc insight alert list-inhibitions
      dc insight alert list-inhibitions --cluster-name prod-1 --namespace insight-system
      dc insight alert list-inhibitions --name cluster-down --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  get-inhibition:
    short: "Get an inhibition by ID"
    example: |
      dc insight alert get-inhibition --id <iid>
      dc insight alert get-inhibition --id <iid> -o json

  create-inhibition:
    short: "Create an inhibition rule (source matchers suppress target matchers)"
    example: |
      echo '{
        "name": "cluster-down-suppresses-node",
        "clusterName": "prod-1",
        "namespace": "insight-system",
        "description": "if cluster is down, suppress node-level alerts",
        "equal": ["clusterName"],
        "sourceMatchers": [{"type":"EQUAL","key":"alertname","value":"ClusterDown"}],
        "targetMatchers": [{"type":"EQUAL","key":"severity","value":"WARNING"}]
      }' | dc insight alert create-inhibition --file -

      # matches/sourceMatchers/targetMatchers 的 type 同 silence：EQUAL / NOT_EQUAL / REGEXP

  update-inhibition:
    short: "Update an inhibition rule"
    example: |
      echo '{
        "description": "updated suppression",
        "equal": ["clusterName", "namespace"],
        "sourceMatchers": [{"type":"EQUAL", "key":"alertname","value":"ClusterDown"}],
        "targetMatchers": [{"type":"REGEXP","key":"severity","value":"WARNING|INFO"}]
      }' | dc insight alert update-inhibition --id <iid> --file -

  delete-inhibition:
    short: "Delete an inhibition rule"
    example: |
      dc insight alert delete-inhibition --id <iid>

  # ── 日志 (Log) ────────────────────────────────────────────────────────
  # 日志分两类（event 已废弃）：
  #   - resource: 容器 / 工作负载日志（kubernetes 标签）
  #   - system:   节点系统日志（syslog / /var/log/*）
  #
  # 时间字段（startTime / endTime / nanotimestamp）一律使用 RFC3339Nano，
  # 例：2026-05-21T00:00:00.000000000Z
  #
  # clusterFilter 接受 **集群 UUID (kube-system 命名空间的 UID)**，不是集群名。
  # 每次查询只能传一个 UUID；namespaceFilter 必须配合 clusterFilter 使用。
  # 取 UUID：
  #   dc insight resource get-cluster --name kpanda-global-cluster -o json \
  #     | jq -r .kubeSystemId
  # 下文示例统一使用占位 <KUBESYSTEMID>，请替换为该命令返回值。
  query-log:
    short: "Query container or system logs with filters and pagination"
    example: |
      # 1) 先拿到集群 UUID
      KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)

      # 2) 容器日志：在 kpanda-global-cluster / insight-system 中检索包含 "error" 的日志
      # 字段说明（resource filter）：
      #   clusterFilter    集群 UUID 列表，必填且只能 1 个
      #   namespaceFilter  命名空间精确匹配（需配合 clusterFilter）
      #   workloadFilter   工作负载精确匹配；workloadSearch 为模糊
      #   podFilter        Pod 精确匹配；podSearch 为模糊
      #   containerFilter  容器精确匹配；containerSearch 为模糊
      #   logSearch        日志正文关键字（多值 AND）
      #   traceIdSearch    精确匹配 trace_id
      #   luceneFilter     Lucene DSL，可选键：
      #                    kubernetes.namespace_name.keyword / kubernetes.pod_name.keyword /
      #                    kubernetes.container_name.keyword / trace_id.keyword / log
      # 顶层字段：
      #   startTime/endTime  RFC3339Nano，可空表示无界
      #   page/pageSize      分页（默认 1/10，pageSize 软上限 100）
      #   sorts              仅支持 time 字段；格式 "time,desc" 或 "time,asc"，默认 "time,desc"
      echo '{
        "startTime": "2026-05-21T00:00:00.000000000Z",
        "endTime":   "2026-05-21T01:00:00.000000000Z",
        "page": 1,
        "pageSize": 100,
        "sorts": ["time,desc"],
        "resource": {
          "clusterFilter":   ["'"$KUBESYSTEMID"'"],
          "namespaceFilter": ["insight-system"],
          "workloadFilter":  ["insight-server"],
          "podSearch":       ["insight-server"],
          "logSearch":       ["error"],
          "luceneFilter":    "kubernetes.container_name.keyword:insight-server AND log:error"
        }
      }' | dc insight log query-log --file -

      # 3) 系统日志（节点 syslog）
      # system filter 支持键：nodeFilter / fileFilter / logSearch / luceneFilter
      # luceneFilter 可用键：syslog.host.keyword / syslog.file.keyword / syslog.ident.keyword / log
      echo '{
        "startTime": "2026-05-21T00:00:00.000000000Z",
        "endTime":   "2026-05-21T01:00:00.000000000Z",
        "system": {
          "clusterFilter": ["'"$KUBESYSTEMID"'"],
          "nodeFilter":    ["node-1"],
          "fileFilter":    ["/var/log/messages"],
          "logSearch":     ["oom"]
        }
      }' | dc insight log query-log --file -

      # 返回结构（items 数组每条）：
      #   timestamp                 RFC3339Nano，可直接作为 query-log-context 的 nanotimestamp
      #   log                       日志正文
      #   labels.cluster            集群 UUID
      #   labels.namespace          命名空间（resource filter 时）
      #   labels.pod                Pod 名称
      #   labels.container          容器名称
      #   labels.node / labels.file 节点 / 文件（system filter 时）

  query-log-context:
    short: "Fetch lines before/after a specific log entry (context view)"
    example: |
      KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)

      # 容器日志上下文
      # 字段说明：
      #   before/after    锚点前/后行数，范围 [0,10000]，至少一个 > 0
      #   nanotimestamp   锚点行的 RFC3339Nano 时间戳（必填）
      #   startTime/endTime  搜索窗口（可选）
      #   resource filter (全部必填)：cluster=集群 UUID, namespace, pod, container
      #
      # 推荐流程：先用 query-log 取锚点，再用 jq 提取 timestamp 与 labels.* 作为参数
      LOG_RESULT=$(echo '{
        "startTime": "2026-05-21T00:00:00.000000000Z",
        "endTime":   "2026-05-21T01:00:00.000000000Z",
        "page": 1, "pageSize": 1,
        "resource": {
          "clusterFilter": ["'"$KUBESYSTEMID"'"],
          "logSearch": ["error"]
        }
      }' | dc insight log query-log --file - -o json)

      TS=$(echo "$LOG_RESULT" | jq -r '.items[0].timestamp')
      NS=$(echo "$LOG_RESULT" | jq -r '.items[0].labels.namespace')
      POD=$(echo "$LOG_RESULT" | jq -r '.items[0].labels.pod')
      CT=$(echo "$LOG_RESULT" | jq -r '.items[0].labels.container')

      echo '{
        "before": 50,
        "after":  50,
        "startTime":     "2026-05-21T00:00:00.000000000Z",
        "endTime":       "2026-05-21T01:00:00.000000000Z",
        "nanotimestamp": "'"$TS"'",
        "resource": {
          "cluster":   "'"$KUBESYSTEMID"'",
          "namespace": "'"$NS"'",
          "pod":       "'"$POD"'",
          "container": "'"$CT"'"
        }
      }' | dc insight log query-log-context --file -

      # 系统日志上下文（system filter 三字段全部必填：cluster / node / file）
      echo '{
        "before": 30,
        "after":  30,
        "startTime":     "2026-05-21T00:00:00.000000000Z",
        "endTime":       "2026-05-21T01:00:00.000000000Z",
        "nanotimestamp": "2026-05-21T00:30:12.123456789Z",
        "system": {
          "cluster": "'"$KUBESYSTEMID"'",
          "node":    "node-1",
          "file":    "/var/log/messages"
        }
      }' | dc insight log query-log-context --file -

  query-log-histogram:
    short: "Bucket log counts over time (histogram)"
    example: |
      KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)

      # 字段说明：
      #   startTime/endTime  RFC3339Nano（必填）
      #   interval           ES date_histogram 间隔，如 "1m"/"5m"/"1h"（必填）
      #   resource/system    与 query-log 相同的 filter 二选一
      echo '{
        "startTime": "2026-05-21T00:00:00.000000000Z",
        "endTime":   "2026-05-21T01:00:00.000000000Z",
        "interval":  "1m",
        "resource": {
          "clusterFilter":   ["'"$KUBESYSTEMID"'"],
          "namespaceFilter": ["insight-system"],
          "logSearch":       ["error"]
        }
      }' | dc insight log query-log-histogram --file -

  search-log:
    short: "Raw Elasticsearch DSL passthrough (advanced)"
    example: |
      # --index 传 ILM 索引后缀（服务端会补前缀），常用 "insight-logs-*"
      # --query 必须是合法的 ES DSL JSON 字符串
      dc insight log search-log \
        --index 'insight-logs-*' \
        --query '{"query":{"match":{"log":"timeout"}}}'

      # 在 insight-system 命名空间内查最近 1h 含 "error" 的日志
      dc insight log search-log \
        --index 'insight-logs-*' \
        --query '{
          "size": 100,
          "sort": [{"@timestamp":"desc"}],
          "query": {
            "bool": {
              "must":   [{"match": {"log": "error"}}],
              "filter": [
                {"term":  {"kubernetes.namespace_name.keyword": "insight-system"}},
                {"range": {"@timestamp": {"gte": "now-1h", "lte": "now"}}}
              ]
            }
          }
        }' -o json

  list-log-file-paths:
    short: "List system log file paths discovered on a node"
    aliases: [ls-log-file-paths]
    example: |
      # 用集群名（服务端解析为 UUID）
      dc insight log list-log-file-paths --cluster-name kpanda-global-cluster --node node-1
      # 或直接传 UUID
      KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)
      dc insight log list-log-file-paths --cluster "$KUBESYSTEMID" --node node-1 -o json

  download-log:
    short: "Export logs (or a context window) to a downloadable file"
    example: |
      KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)

      # 字段说明：
      #   type            导出格式枚举：TEXT(默认) / CSV / JSON
      #   maxLines        导出上限 [0,10000]，0 视为 2000
      #   fields          列枚举（TEXT/CSV 生效；JSON 输出完整记录），可选值：
      #                   Timestamp | Cluster | Namespace | Pod | Container | Node | File
      #   sorts           仅支持 "time,desc"（默认）或 "time,asc"
      #   timeZone        导出时间戳的 IANA 时区，如 "Asia/Shanghai"
      #   queryLog        或 queryLogContext，二选一（结构同 query-log / query-log-context）
      echo '{
        "type": "CSV",
        "maxLines": 5000,
        "fields": ["Timestamp", "Cluster", "Namespace", "Pod", "Container"],
        "sorts": ["time,asc"],
        "timeZone": "Asia/Shanghai",
        "queryLog": {
          "startTime": "2026-05-21T00:00:00.000000000Z",
          "endTime":   "2026-05-21T01:00:00.000000000Z",
          "sorts":     ["time,asc"],
          "resource": {
            "clusterFilter":   ["'"$KUBESYSTEMID"'"],
            "namespaceFilter": ["insight-system"],
            "workloadFilter":  ["insight-server"]
          }
        }
      }' | dc insight log download-log --file -

      # 导出某条日志的上下文窗口
      echo '{
        "type": "TEXT",
        "maxLines": 200,
        "fields": ["Timestamp", "Pod", "Container"],
        "queryLogContext": {
          "before": 100,
          "after":  100,
          "startTime":     "2026-05-21T00:00:00.000000000Z",
          "endTime":       "2026-05-21T01:00:00.000000000Z",
          "nanotimestamp": "2026-05-21T00:30:12.123456789Z",
          "resource": {
            "cluster":   "'"$KUBESYSTEMID"'",
            "namespace": "insight-system",
            "pod":       "insight-server-0",
            "container": "insight-server"
          }
        }
      }' | dc insight log download-log --file -

  # ── 指标 (Metric) ─────────────────────────────────────────────────────
  # 透传 Prometheus 查询 API；time / start / end 单位为 unix 秒 (int64)，step 为秒 (double)。
  # 集群参数：--cluster-name 传集群名；--cluster 传集群 UUID（kubeSystemId），二选一。
  query-metric:
    short: "Run a PromQL instant query (Prometheus /api/v1/query)"
    example: |
      # 用集群名 - 当前所有 targets 的 up 状态
      dc insight metric query-metric \
        --cluster-name kpanda-global-cluster \
        --query 'up' -o json

      # 用集群 UUID（与 --cluster-name 二选一）
      KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)
      dc insight metric query-metric --cluster "$KUBESYSTEMID" --query 'up' -o json

      # 指定命名空间 + 时间戳（unix 秒）的瞬时 CPU 查询
      dc insight metric query-metric \
        --cluster-name kpanda-global-cluster \
        --namespace insight-system \
        --query 'sum(rate(container_cpu_usage_seconds_total{namespace="insight-system"}[5m])) by (pod)' \
        --time 1747850400 -o json

      # 返回结构：vector 数组，每项 { metric: {labels}, values: { timestamp, value } }

  query-range-metric:
    short: "Run a PromQL range query (Prometheus /api/v1/query_range)"
    example: |
      # 最近 1 小时 up 指标，30s 采样
      END=$(date +%s); START=$((END - 3600))
      dc insight metric query-range-metric \
        --cluster-name kpanda-global-cluster \
        --query 'up' \
        --start $START --end $END --step 30 -o json

      # insight-system 命名空间内 Pod CPU 使用率
      dc insight metric query-range-metric \
        --cluster-name kpanda-global-cluster \
        --namespace insight-system \
        --query 'sum(rate(container_cpu_usage_seconds_total[5m])) by (pod)' \
        --start $START --end $END --step 60 -o json

      # 字段说明：
      #   --start/--end  unix 秒 (int64)
      #   --step         采样间隔秒 (double)，可传小数
      # 返回结构：matrix 数组，每项 { metric: {labels}, values: [{timestamp,value}, ...] }

  batch-query-metric:
    short: "Run multiple PromQL instant queries in one call (shared label match)"
    example: |
      # matchLabel 字段说明：
      #   clusterName  集群名（与 cluster 二选一）
      #   cluster      集群 UUID（与 clusterName 二选一）
      #   namespace    可选
      #   extraLabel   附加 label 过滤（map<string,string>），会注入到每条 query
      # param.time     unix 秒
      # queryList      PromQL 数组，非空
      echo '{
        "matchLabel": {
          "clusterName": "kpanda-global-cluster",
          "namespace":   "insight-system"
        },
        "param": {"time": '"$(date +%s)"'},
        "queryList": [
          "up",
          "sum(rate(container_cpu_usage_seconds_total[5m]))"
        ]
      }' | dc insight metric batch-query-metric --file - -o json

      # 返回结构：
      #   data[].data.vector[]  与 query-metric 同结构
      #   data[].status         SUCCESS | FAIL
      #   data[].errorMessage   失败时的错误信息
      # data 数组按 queryList 顺序一一对应。

  batch-query-range-metric:
    short: "Run multiple PromQL range queries in one call (shared label match)"
    example: |
      # param.start/end 为 unix 秒，step 为秒 (double)
      END=$(date +%s); START=$((END - 3600))
      echo '{
        "matchLabel": {
          "clusterName": "kpanda-global-cluster",
          "namespace":   "insight-system"
        },
        "param": {"start": '"$START"', "end": '"$END"', "step": 60},
        "queryList": [
          "up",
          "sum(rate(container_cpu_usage_seconds_total[5m]))"
        ]
      }' | dc insight metric batch-query-range-metric --file - -o json

      # 返回结构：
      #   data[].data.matrix[]  与 query-range-metric 同结构
      #   data[].status         SUCCESS | FAIL
      #   data[].errorMessage
      # data 数组按 queryList 顺序一一对应。

  format-query:
    short: "Pretty-print / normalize a PromQL expression (server-side formatter)"
    example: |
      echo '{"query":"sum(rate(http_requests_total{code=~\"5..\"}[5m]))/sum(rate(http_requests_total[5m]))"}' \
        | dc insight metric format-query --file - -o json

      # 返回结构：{ "query": "<格式化后的 PromQL>" }（对象，非数组）

  # ── 资源 (Resource) ───────────────────────────────────────────────────
  # 通用约定：
  #   - list-* 命令返回 { items: [...], pagination }
  #   - get-* 命令返回单条资源详情
  #   - --cluster 同时接受集群名 (kpanda-global-cluster) 或集群 UUID (kubeSystemId)
  #   - get-server-component-summary 是唯一不需要 --cluster 的命令（查 Insight 服务端组件）
  #
  # 集群 (Cluster)
  list-clusters:
    short: "List all clusters known to Insight"
    aliases: [ls-clusters]
    example: |
      dc insight resource list-clusters
      # Include clusters that have not enabled monitoring
      dc insight resource list-clusters --show-all-cluster=true -o json

  list-cluster-summary:
    short: "List clusters with status/version/role summary"
    example: |
      dc insight resource list-cluster-summary
      dc insight resource list-cluster-summary --phase RUNNING --version v1.28 \
        --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      phase:    { help: "CLUSTER_PHASE_UNSPECIFIED | UNKNOWN | CREATING | RUNNING | UPDATING | DELETING | FAILED" }

  get-cluster:
    short: "Get cluster details by name"
    aliases: [describe-cluster]
    example: |
      dc insight resource get-cluster --name prod-1
      dc insight resource get-cluster --name prod-1 -o json

  get-agent-summary:
    short: "Get the insight-agent component summary for a cluster"
    example: |
      dc insight resource get-agent-summary --cluster prod-1
      dc insight resource get-agent-summary --cluster prod-1 -o json

  get-server-component-summary:
    short: "Get insight-server-side component status summary (cluster-agnostic)"
    example: |
      # 不需要 --cluster 参数；查询 Insight 服务端各组件健康状态。
      dc insight resource get-server-component-summary -o json

  # 命名空间 (Namespace)
  list-namespaces:
    short: "List namespaces in a cluster"
    aliases: [ls-namespaces]
    example: |
      # --cluster 必填（集群名或 UUID）
      dc insight resource list-namespaces --cluster kpanda-global-cluster -o json

      # 备注：返回的 items 仅包含被 Insight 监控覆盖的命名空间；
      # 如果为空，可能是该集群 insight-agent 未启用或采集尚未生效。

  get-namespace:
    short: "Get a namespace by cluster + name"
    example: |
      dc insight resource get-namespace --cluster prod-1 --name kube-system

  # 节点 (Node)
  list-nodes:
    short: "List nodes in a cluster"
    aliases: [ls-nodes]
    example: |
      dc insight resource list-nodes --cluster prod-1
      dc insight resource list-nodes --cluster prod-1 --phase NODE_PHASE_NOT_READY -o json
      dc insight resource list-nodes --cluster prod-1 --name node- --page 1 --page-size 50
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      phase:    { help: "NODE_PHASE_UNSPECIFIED | NODE_PHASE_READY | NODE_PHASE_NOT_READY | NODE_PHASE_UNKNOWN" }

  get-node:
    short: "Get node details by cluster + name"
    aliases: [describe-node]
    example: |
      dc insight resource get-node --cluster prod-1 --name node-1
      dc insight resource get-node --cluster prod-1 --name node-1 -o json

  get-node-gpu-dashboards:
    short: "Get GPU dashboard URLs for a node"
    example: |
      dc insight resource get-node-gpu-dashboards --cluster prod-1 --name node-1
      dc insight resource get-node-gpu-dashboards --cluster prod-1 --name node-1 -o json

  # Pod
  list-pods:
    short: "List pods in a cluster"
    aliases: [ls-pods]
    example: |
      dc insight resource list-pods --cluster prod-1
      dc insight resource list-pods --cluster prod-1 --namespace default --phase POD_PHASE_RUNNING
      dc insight resource list-pods --cluster prod-1 --name my-app --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      phase:    { help: "POD_PHASE_UNSPECIFIED | POD_PHASE_UNKNOWN | POD_PHASE_PENDING | POD_PHASE_RUNNING | POD_PHASE_SUCCEED | POD_PHASE_FAILED" }

  get-pod:
    short: "Get pod details by cluster + namespace + name"
    aliases: [describe-pod]
    example: |
      dc insight resource get-pod --cluster prod-1 --namespace default --name my-app-abc123
      dc insight resource get-pod --cluster prod-1 --namespace default --name my-app-abc123 -o json

  get-pod-metrics:
    short: "Get pod metrics over a time range (CPU / memory / network)"
    example: |
      # 时间格式：--start / --end 同时接受 unix 秒 (int) 或 RFC3339 字符串
      # --step 单位为秒
      END=$(date +%s); START=$((END - 3600))

      # 最近 1 小时，30s 步长
      dc insight resource get-pod-metrics \
        --cluster kpanda-global-cluster --namespace kube-system \
        --name coredns-6d4d6f8c7-x8zvw \
        --start $START --end $END --step 30 -o json

      # 指定 metric 子集（PromQL-like keys，服务端定义）
      dc insight resource get-pod-metrics \
        --cluster kpanda-global-cluster --namespace kube-system \
        --name coredns-6d4d6f8c7-x8zvw \
        --start $START --end $END --step 30 \
        --query-list cpuUsage --query-list memoryUsage -o json

      # 输出：.metrics 字段（按 metric key 分组的时序数据）

  get-pod-gpu-dashboards:
    short: "Get GPU dashboard URLs for a pod"
    example: |
      dc insight resource get-pod-gpu-dashboards \
        --cluster prod-1 --namespace default --name my-gpu-pod

  get-pod-jvm-dashboards:
    short: "Get JVM dashboard URLs for a pod (Java workloads)"
    example: |
      dc insight resource get-pod-jvm-dashboards \
        --cluster prod-1 --namespace default --name my-java-pod \
        --start 1700000000 --end 1700003600 --step 30

  list-pod-containers:
    short: "List containers within a pod"
    aliases: [ls-pod-containers]
    example: |
      dc insight resource list-pod-containers \
        --cluster prod-1 --namespace default --name my-app-abc123
      dc insight resource list-pod-containers \
        --cluster prod-1 --namespace default --name my-app-abc123 \
        --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  # 工作负载 - Deployment
  list-deployments:
    short: "List Deployments in a cluster"
    aliases: [ls-deployments]
    example: |
      dc insight resource list-deployments --cluster kpanda-global-cluster
      dc insight resource list-deployments --cluster kpanda-global-cluster --namespace kube-system \
        --phase WORKLOAD_STATE_NOT_READY -o json

      # 输出：.items[] 主要字段 name / namespace / tracingEnabled
      # （Deployment 详情通过 get-deployment 获取，含 conditions / metadata 等完整字段）
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      phase:    { help: "WORKLOAD_STATE_UNKNOWN | WORKLOAD_STATE_RUNNING | WORKLOAD_STATE_DELETING | WORKLOAD_STATE_NOT_READY | WORKLOAD_STATE_STOPPED | WORKLOAD_STATE_WAITING" }

  get-deployment:
    short: "Get a Deployment by cluster + namespace + name"
    aliases: [describe-deployment]
    example: |
      dc insight resource get-deployment --cluster prod-1 --namespace default --name my-app

  get-deployment-pods:
    short: "List pods belonging to a Deployment"
    example: |
      dc insight resource get-deployment-pods \
        --cluster prod-1 --namespace default --name my-app
      dc insight resource get-deployment-pods \
        --cluster prod-1 --namespace default --name my-app \
        --pod my-app-abc --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  # 工作负载 - StatefulSet
  list-statefulsets:
    short: "List StatefulSets in a cluster"
    aliases: [ls-statefulsets]
    example: |
      dc insight resource list-statefulsets --cluster prod-1
      dc insight resource list-statefulsets --cluster prod-1 --namespace default \
        --phase WORKLOAD_STATE_RUNNING -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      phase:    { help: "WORKLOAD_STATE_UNKNOWN | WORKLOAD_STATE_RUNNING | WORKLOAD_STATE_DELETING | WORKLOAD_STATE_NOT_READY | WORKLOAD_STATE_STOPPED | WORKLOAD_STATE_WAITING" }

  get-statefulset:
    short: "Get a StatefulSet by cluster + namespace + name"
    aliases: [describe-statefulset]
    example: |
      dc insight resource get-statefulset --cluster prod-1 --namespace default --name my-db

  get-statefulset-pods:
    short: "List pods belonging to a StatefulSet"
    example: |
      dc insight resource get-statefulset-pods \
        --cluster prod-1 --namespace default --name my-db \
        --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  # 工作负载 - DaemonSet
  list-daemonsets:
    short: "List DaemonSets in a cluster"
    aliases: [ls-daemonsets]
    example: |
      dc insight resource list-daemonsets --cluster prod-1
      dc insight resource list-daemonsets --cluster prod-1 --namespace kube-system \
        --phase WORKLOAD_STATE_NOT_READY -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      phase:    { help: "WORKLOAD_STATE_UNKNOWN | WORKLOAD_STATE_RUNNING | WORKLOAD_STATE_DELETING | WORKLOAD_STATE_NOT_READY | WORKLOAD_STATE_STOPPED | WORKLOAD_STATE_WAITING" }

  get-daemonset:
    short: "Get a DaemonSet by cluster + namespace + name"
    aliases: [describe-daemonset]
    example: |
      dc insight resource get-daemonset --cluster prod-1 --namespace kube-system --name fluent-bit

  get-daemonset-pods:
    short: "List pods belonging to a DaemonSet"
    example: |
      dc insight resource get-daemonset-pods \
        --cluster prod-1 --namespace kube-system --name fluent-bit \
        --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  # 工作负载 - Job / CronJob
  list-jobs:
    short: "List Jobs in a cluster"
    aliases: [ls-jobs]
    example: |
      dc insight resource list-jobs --cluster prod-1
      dc insight resource list-jobs --cluster prod-1 --namespace default \
        --phase JOB_STATE_FAILED -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      phase:    { help: "JOB_STATE_UNSPECIFIED | JOB_STATE_WAITING | JOB_STATE_RUNNING | JOB_STATE_COMPLETED | JOB_STATE_DELETING | JOB_STATE_FAILED" }

  get-job:
    short: "Get a Job by cluster + namespace + name"
    aliases: [describe-job]
    example: |
      dc insight resource get-job --cluster prod-1 --namespace default --name backup-20240101

  get-job-pods:
    short: "List pods belonging to a Job"
    example: |
      dc insight resource get-job-pods \
        --cluster prod-1 --namespace default --name backup-20240101 \
        --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  list-cronjobs:
    short: "List CronJobs in a cluster"
    aliases: [ls-cronjobs]
    example: |
      dc insight resource list-cronjobs --cluster prod-1
      dc insight resource list-cronjobs --cluster prod-1 --namespace default \
        --phase JOB_STATE_RUNNING -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      phase:    { help: "JOB_STATE_UNSPECIFIED | JOB_STATE_WAITING | JOB_STATE_RUNNING | JOB_STATE_COMPLETED | JOB_STATE_DELETING | JOB_STATE_FAILED" }

  get-cronjob:
    short: "Get a CronJob by cluster + namespace + name"
    aliases: [describe-cronjob]
    example: |
      dc insight resource get-cronjob --cluster prod-1 --namespace default --name nightly-backup

  get-cronjob-pods:
    short: "List pods spawned by a CronJob"
    example: |
      dc insight resource get-cronjob-pods \
        --cluster prod-1 --namespace default --name nightly-backup \
        --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  # Service
  list-services:
    short: "List Services in a cluster"
    aliases: [ls-services]
    example: |
      dc insight resource list-services --cluster kpanda-global-cluster
      dc insight resource list-services --cluster kpanda-global-cluster \
        --namespace kube-system --name coredns -o json

      # 输出：.items[] 主要字段 name / namespace / tracingEnabled
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  get-service:
    short: "Get a Service (with linked workloads) by cluster + namespace + name"
    aliases: [describe-service]
    example: |
      dc insight resource get-service --cluster prod-1 --namespace default --name my-app

  # ── 链路追踪 (Tracing) ────────────────────────────────────────────────
  # 时间格式按接口分三类：
  #   1) Jaeger / Tag / Operations / ServiceNames (CLI flag)：
  #        --start / --end 用 RFC3339 字符串，例 "2026-05-21T08:00:00Z"
  #   2) Span / SlowSQL POST body：
  #        startTime / endTime / start / end 用 RFC3339(Nano) 字符串
  #        ⚠️ 不要传 unix 毫秒数字串，否则 query-span-histogram 等分桶接口会异常
  #   3) APM 指标 (get-services / get-service-detail / get-service-pods /
  #               get-operation-detail)：
  #        --end-time / --lookback / --step / --rate-per 单位均为 **unix 毫秒** (int64)
  #        e.g. --end-time $(date +%s)000  --lookback 1800000  (=30m)

  # ── 链路 (Traces / Jaeger) ────────────────────────────────────────────
  find-jaeger-traces:
    short: "Search Jaeger traces by service / operation / duration window"
    aliases: [ls-traces]
    example: |
      dc insight tracing find-jaeger-traces \
        --cluster-name kpanda-global-cluster --namespace ghippo-system \
        --service-name ghippo-apiserver \
        --start 2026-05-21T07:00:00Z --end 2026-05-21T08:00:00Z \
        --limit 50 -o json
      # 上例：最近 1 小时某服务的全部 trace；--start/--end 为 RFC3339，替换为实际窗口即可
      # 慢 trace（>500ms）+ 指定 operation：
      dc insight tracing find-jaeger-traces \
        --cluster-name kpanda-global-cluster --namespace ghippo-system \
        --service-name ghippo-apiserver --operation-name 'GET /api/v1/orders' \
        --duration-min 500ms --duration-max 5s \
        --start 2026-05-21T07:00:00Z --end 2026-05-21T08:00:00Z -o json
      # 输出：.traces[] 含 duration / method / operationName / protocol / spanCount / startTime

  find-jaeger-trace:
    short: "Get a single Jaeger trace by trace ID"
    aliases: [describe-trace]
    example: |
      # 必填：--trace-id / --cluster-name / --namespace
      dc insight tracing find-jaeger-trace --trace-id <traceId> \
        --cluster-name kpanda-global-cluster --namespace insight-system -o json

      # 非法 trace id 时后端返回 "uninitialized TraceID is not allowed"

  query-spans:
    short: "Query spans with rich filters (tags, error-only, sort, pagination)"
    example: |
      # ⚠️ POST body 中 start / end 必须是 RFC3339(Nano) 字符串，不是 unix ms
      # sort 支持：startTime,desc | startTime,asc | duration,desc | duration,asc（默认 startTime,desc）
      echo '{
        "clusterName": "kpanda-global-cluster",
        "namespace":   "ghippo-system",
        "serviceName": ["ghippo-apiserver"],
        "operationName": ["GET /api/v1/orders"],
        "start": "2026-05-21T07:00:00.000Z",
        "end":   "2026-05-21T08:00:00.000Z",
        "durationMin":   "200ms",
        "onlyErrorSpans": true,
        "sort":     "duration,desc",
        "page":     1,
        "pageSize": 50,
        "tags": [
          {"key":"http.status_code","operation":"EQUAL","value":"500"}
        ]
      }' | dc insight tracing query-spans --file - -o json

      # 字段说明：
      #   clusterName / cluster        二选一
      #   namespace                    必填
      #   serviceName / operationName  字符串数组
      #   durationMin/durationMax      go duration: ns/us/ms/s/m/h
      #   tags[].operation             FilterOperator
      #                                CONTAIN/NOT_CONTAIN/EQUAL/NOT_EQUAL/REGEX_PATTERN/
      #                                LT/LE/GT/GE/EQ/NE
      #   onlyErrorSpans               仅返回错误 span
      #   spanKinds                    可选，默认 [SPAN_KIND_SERVER, SPAN_KIND_CLIENT]
      # 输出：.items[] 含 duration / method / operationName / protocol / serviceName / spanId

  query-span-histogram:
    short: "Bucket span counts over time (normal / error / total)"
    example: |
      # ⚠️ start/end 必须 RFC3339；传 unix ms 会导致分桶数异常（实测 60001 桶）
      echo '{
        "clusterName": "kpanda-global-cluster",
        "namespace":   "ghippo-system",
        "serviceName": ["ghippo-apiserver"],
        "start": "2026-05-21T07:00:00.000Z",
        "end":   "2026-05-21T08:00:00.000Z",
        "interval": "1m",
        "onlyErrorSpans": false
      }' | dc insight tracing query-span-histogram --file - -o json

      # 输出：
      #   .countItems[]     { timestamp(ms), normal, error, total }
      #   .durationItems[]  { timestamp(ms), p75Duration, p95Duration, p99Duration, avgDuration (ns) }

  query-operations:
    short: "List operations (endpoints) for a service in a cluster"
    example: |
      # 必填：--cluster-name --namespace --service-name
      dc insight tracing query-operations \
        --cluster-name kpanda-global-cluster --namespace ghippo-system \
        --service-name ghippo-apiserver --max-size 200 -o json

      # 输出：.operations[]

  list-service-names:
    short: "List service names known to the tracing backend"
    aliases: [ls-service-names]
    example: |
      # ⚠️ --namespace 必填，缺失返回 HTTP 400
      dc insight tracing list-service-names \
        --cluster-name kpanda-global-cluster --namespace insight-system -o json

      # 输出：.services[]

  get-tags:
    short: "List span tag keys discovered for a service / namespace"
    example: |
      # 必填：--cluster --namespace；--start / --end 默认 [now-15m, now]
      dc insight tracing get-tags \
        --cluster kpanda-global-cluster --namespace ghippo-system \
        --service-names ghippo-apiserver --limit 500 \
        --start 2026-05-21T07:00:00Z --end 2026-05-21T08:00:00Z -o json

      # 输出：.tags[]

  get-tag-values:
    short: "List values seen for a given tag key"
    example: |
      # 必填：--name (tag key) --cluster --namespace
      dc insight tracing get-tag-values --name http.status_code \
        --cluster kpanda-global-cluster --namespace ghippo-system \
        --service-names ghippo-apiserver --limit 100 -o json

      # 输出：.values[]

  # ── APM 指标 (Services / Operations) ──────────────────────────────────
  # ⚠️ 重要修正：end-time / lookback / step / rate-per 单位是 **毫秒 (ms, int64)**
  #    （非微秒）。常用值：
  #      --end-time   $(date +%s)000        当前时刻
  #      --lookback   1800000               30 分钟
  #      --step       60000                 60s
  #      --rate-per   60000                 每分钟速率
  get-services:
    short: "List APM services with rate / latency / error metrics"
    aliases: [ls-services-apm]
    example: |
      END=$(date +%s)000
      # 默认全 namespace；可加 --namespace 过滤
      dc insight tracing get-services \
        --cluster-name kpanda-global-cluster \
        --end-time $END --lookback 1800000 \
        --span-kinds SPAN_KIND_SERVER --sort 'reqRate,desc' \
        --page 1 --page-size 50 -o json

      # 输出：.items[] 含 namespace / serviceName / errorRate / repLatency / reqRate
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      end-time: { help: "结束时间 unix ms (int64)" }
      lookback: { help: "回退时长 ms (int64)" }

  get-service-detail:
    short: "Get per-service APM metrics (latency / errors / requests, optionally grouped by operation)"
    example: |
      END=$(date +%s)000
      # 必填：--cluster-name --namespace --service-names
      dc insight tracing get-service-detail \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --service-names insight-agent --group-by-operation=true \
        --end-time $END --lookback 1800000 \
        --step 60000 --rate-per 60000 \
        --span-kinds SPAN_KIND_SERVER -o json

      # 输出（皆为 SampleStream 时序数组）：
      #   .reqRateMetric        吞吐
      #   .errorsRateMetrics    错误率
      #   .p50Metrics / .p75Metrics / .p95Metrics  延迟分位

  get-service-pods:
    short: "List the pods backing a tracing service with per-pod request share"
    example: |
      END=$(date +%s)000
      # 必填：--name --cluster-name --namespace
      dc insight tracing get-service-pods --name ghippo-apiserver \
        --cluster-name kpanda-global-cluster --namespace ghippo-system \
        --end-time $END --lookback 1800000 \
        --sort 'reqPercentage,desc' --page 1 --page-size 50 -o json

      # 输出：.items[] 含 podName / namespace / clusterName / reqPercentage
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  get-operation-detail:
    short: "Get per-operation APM metrics for a service"
    example: |
      END=$(date +%s)000
      # 必填：--cluster-name --namespace --service-name
      dc insight tracing get-operation-detail \
        --cluster-name kpanda-global-cluster --namespace ghippo-system \
        --service-name ghippo-apiserver \
        --end-time $END --lookback 1800000 \
        --step 60000 --rate-per 60000 \
        --span-kinds SPAN_KIND_SERVER \
        --sort 'p99,desc' --page 1 --page-size 50 -o json

      # 输出：.metrics[]  per-operation 的速率 / 错误率 / 延迟分位
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  # ── 慢 SQL (Slow SQL) ─────────────────────────────────────────────────
  # ⚠️ 所有 POST body 中 startTime / endTime 用 **RFC3339(Nano)** 字符串，
  #    例：2026-05-21T07:00:00.000Z（不是 unix 毫秒）
  query-metadata:
    short: "List slow-SQL metadata (DB address / system / statement) for a cluster"
    example: |
      # --type 必填，枚举：DATABASE_ADDRESS | DATABASE_SYSTEM | SQL_STATEMENT
      echo '{
        "namespace": "ghippo-system",
        "startTime": "2026-05-21T07:00:00.000Z",
        "endTime":   "2026-05-21T08:00:00.000Z",
        "limit": 100,
        "clauses": [
          {"field":"db.system","operation":"EQUAL","stringValue":"mysql"}
        ]
      }' | dc insight tracing query-metadata \
            --cluster-name kpanda-global-cluster --type SQL_STATEMENT --file - -o json

      # 输出：.items[]

  statement-histogram:
    short: "Histogram of SQL statement durations (cluster scoped, slow-SQL)"
    example: |
      # sort 支持（proto canonical，逗号分隔，默认 request_count,desc）：
      #   request_count,desc | request_count,asc
      #   avg_duration,desc  | avg_duration,asc
      #   error_requests,desc| error_requests,asc
      #   error_rate,desc    | error_rate,asc
      #   @timestamp,desc    | @timestamp,asc
      echo '{
        "namespace": "ghippo-system",
        "startTime": "2026-05-21T07:00:00.000Z",
        "endTime":   "2026-05-21T08:00:00.000Z",
        "interval":  "1m",
        "topN":      10,
        "sort":      "avg_duration,desc",
        "clauses": [
          {"field":"db.system","operation":"EQUAL","stringValue":"mysql"}
        ]
      }' | dc insight tracing statement-histogram \
            --cluster-name kpanda-global-cluster --file - -o json

      # 输出（按时间桶的 BucketHistogram 数组）：
      #   .total       调用次数
      #   .duration    平均耗时（ns）
      #   .errors      错误次数
      #   .errorRate   错误率
      #   .sourcePods  调用容器组

  statement-top-k:
    short: "Top-K slowest SQL statements aggregated by source service"
    example: |
      echo '{
        "namespace": "ghippo-system",
        "startTime": "2026-05-21T07:00:00.000Z",
        "endTime":   "2026-05-21T08:00:00.000Z",
        "topN":      20,
        "sort":      "avg_duration,desc"
      }' | dc insight tracing statement-top-k \
            --cluster-name kpanda-global-cluster --file - -o json

      # 输出：.items[] 含 address / system / sourceCluster / sourceNamespace /
      #       sourceService / statement / totalCount / avgDuration(ns) / errorRate

  get-slow-sql-spans:
    short: "List individual slow-SQL spans (drill-down from statement-top-k)"
    example: |
      # sort 支持：startTimeMillis,desc | startTimeMillis,asc | duration,desc | duration,asc
      echo '{
        "namespace": "ghippo-system",
        "startTime": "2026-05-21T07:00:00.000Z",
        "endTime":   "2026-05-21T08:00:00.000Z",
        "sort":      "duration,desc",
        "page":      1,
        "pageSize":  50,
        "clauses": [
          {"field":"db.statement","operation":"CONTAIN","stringValue":"SELECT"},
          {"field":"duration","operation":"GT","floatValue":1000}
        ]
      }' | dc insight tracing get-slow-sql-spans \
            --cluster-name kpanda-global-cluster --file - -o json

      # 输出：.items[] 含 duration / sourcePod / spanId / startTime / status / traceId

  # ── 服务拓扑 (ServiceGraph) ───────────────────────────────────────────
  # 所有时间字段（start / end / endTime / lookback / step / ratePer）单位为 unix 毫秒 (int64)。
  get-graph:
    short: "Get service / workload / namespace topology graph"
    example: |
      END=$(date +%s)000; START=$(($(date +%s) - 3600))000
      echo '{
        "clusterNames": ["kpanda-global-cluster"],
        "start": "'"$START"'",
        "end":   "'"$END"'"
      }' | dc insight servicegraph get-graph --file - -o json
      # 上例：基础查询（必填 clusterNames + start + end），start/end 为 unix 毫秒字符串
      # 按命名空间过滤：
      echo '{
        "clusterNames": ["kpanda-global-cluster"],
        "namespaces":   ["insight-system"],
        "start": "'"$START"'",
        "end":   "'"$END"'"
      }' | dc insight servicegraph get-graph --file - -o json

      # 带 graphType / layer / 依赖深度过滤
      # 注意：graphType / layer 是大写枚举字符串（非 "service" / "L7"），传错值会返回 HTTP 400
      echo '{
        "clusterNames": ["kpanda-global-cluster"],
        "namespaces":   ["insight-system"],
        "services":     ["insight-server"],
        "workloads":    ["insight-server"],
        "start": "'"$START"'",
        "end":   "'"$END"'",
        "graphType": "SERVICE_SCOPE",
        "layer":     "KUBERNETES",
        "showUpDownRelatedNode": true,
        "filters": {
          "aggType": "INTERSECTION",
          "dependencyMaxDepth": 3,
          "clauses": [
            {"dataType":"NODE_DATA","field":"SERVICE_NAME","operation":"CONTAIN","stringValue":"insight"}
          ]
        }
      }' | dc insight servicegraph get-graph --file - -o json

      # 请求体字段（BaseGraphQuery）：
      #   clusterNames        集群名数组，必填
      #   clusters            集群 UUID 数组（与 clusterNames 二选一/并存）
      #   start / end         unix 毫秒字符串（必填）
      #   namespaces / services / workloads  作用域过滤（可选）
      #   extensionLabels     形如 "skoala_registry=ireg-1,instance_name=xxx"
      #   layer 枚举          KUBERNETES | MESH | OS_LINUX(=VM) | INFRA | GENERAL
      #   graphType 枚举      CLUSTER_SCOPE | NAMESPACE_SCOPE | SERVICE_SCOPE |
      #                       WORKLOAD_SCOPE | INSTANCE_SCOPE | MIXED
      #   showVirtualNode     默认 false
      #   showUpDownRelatedNode 默认 false；true 时展示上下游
      #   filters.aggType     INTERSECTION（UNION 暂未支持）
      #   filters.dependencyMaxDepth  依赖深度，默认 1
      #   filters.clauses[]   { dataType=NODE_DATA, field, operation, stringValue|floatValue }
      #     field=SERVICE_NAME      支持 CONTAIN/NOT_CONTAIN/EQUAL/NOT_EQUAL/REGEX_PATTERN
      #     field=STATUS_ERROR_RATE 支持 LE/GE，使用 floatValue
      #     field=STATUS_LATENCY    支持 LE/GE，使用 floatValue（单位秒）
      #
      # 返回结构（Graph）：
      #   nodes[]   { id, parent, type(NodeType), metadata, position, statuses[] }
      #   edges[]   { id, source, target, statuses[], properties }
      #   layer / graphType
      #   Status.name 约定：requestsPerMinute / errorRate(%) / avgLatency(秒) /
      #                     replicas / availableReplicas / healthyStatus(0~3) ...
      #
      # ──────────────────────────────────────────────────────────────────
      # 数据分析指南
      # ──────────────────────────────────────────────────────────────────
      # Edge.statuses 上的常见指标名：
      #   request_total          总请求数
      #   request_failed_total   失败请求数
      #   request_per_second     QPS
      #   request_avg_latency    平均延迟（秒）
      #
      # 第一步：Node 数据分析
      #   1.1 服务类型分布：按 nodes[].type 分组计数
      #       jq '.nodes | group_by(.type)
      #          | map({type: .[0].type, count: length})'
      #
      #   1.2 服务依赖数 TOP5（作为 edge.source 出现的次数）
      #       jq '.edges | group_by(.source)
      #          | map({source: .[0].source, count: length})
      #          | sort_by(.count) | reverse | .[:5]'
      #
      #   1.3 服务被依赖数 TOP5（作为 edge.target 出现的次数）
      #       jq '.edges | group_by(.target)
      #          | map({target: .[0].target, count: length})
      #          | sort_by(.count) | reverse | .[:5]'
      #
      # 第二步：Edge 指标 TOP5
      #   2.1 错误数 TOP5：按 statuses[name=request_failed_total].value 降序
      #       jq '.edges
      #          | map(select(.statuses[]?
      #              | .name == "request_failed_total" and .value > 0))
      #          | sort_by(.statuses[] | select(.name == "request_failed_total") | .value)
      #          | reverse | .[:5]
      #          | map({source, target,
      #                 failed: (.statuses[] | select(.name == "request_failed_total") | .value)})'
      #
      #   2.2 请求数 TOP5：按 statuses[name=request_total].value 降序
      #       jq '.edges
      #          | sort_by(.statuses[] | select(.name == "request_total") | .value)
      #          | reverse | .[:5]
      #          | map({source, target,
      #                 total: (.statuses[] | select(.name == "request_total") | .value)})'
      #
      #   2.3 平均延迟 TOP5：按 statuses[name=request_avg_latency].value 降序
      #       jq '.edges
      #          | sort_by(.statuses[] | select(.name == "request_avg_latency") | .value)
      #          | reverse | .[:5]
      #          | map({source, target,
      #                 latency: (.statuses[] | select(.name == "request_avg_latency") | .value)})'
      #       值单位为秒，展示时可换算为 ms 并标注单位。
      #
      # 第三步：汇总异常服务
      #   综合上述结果，按严重度排序输出 service / issue 列表：
      #     请求错误 > 请求延迟高 > 请求太多 > 其他
      #
      # 注意：node.id / edge.source / edge.target 中可能含集群 UUID。
      # 展示给用户时应替换为集群名：
      #   dc insight resource list-clusters -o json
      #     | jq -r '.items[] | .kubeSystemId + " " + .name'
      # 用上面映射把 UUID 替换回名字再输出表格。

  get-node-metrics:
    short: "Get aggregated metrics for a node (service/workload) on the topology graph"
    example: |
      END=$(date +%s)000

      # 单个服务节点 30 分钟指标（endTime/lookback/step/rate-per 单位都是 ms）
      dc insight servicegraph get-node-metrics \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --service insight-server \
        --end-time $END --lookback 1800000 \
        --step 60000 --rate-per 60000 \
        --span-kinds SPAN_KIND_SERVER -o json

      # 用 extension-filters 做 label 选择
      dc insight servicegraph get-node-metrics \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --service insight-server \
        --extension-filters 'skoala_registry=ire-111,instance=10.0.0.1' \
        --end-time $END --lookback 1800000 --step 60000 --rate-per 60000 -o json
    params:
      cluster:
        help: "集群 UUID（与 --cluster-name 二选一，至少传一个）"
      cluster-name:
        help: "集群名（与 --cluster 二选一）"
      end-time:    { help: "结束时间 unix ms（必填）" }
      lookback:    { help: "回退时长 ms（必填）" }
      step:        { help: "采样步长 ms（必填）" }
      rate-per:    { help: "变化率计算窗口 ms（必填）" }
      span-kinds:
        help: |
          可重复，逻辑 OR。默认 [SPAN_KIND_SERVER]。可选：
            SPAN_KIND_SERVER | SPAN_KIND_CLIENT |
            SPAN_KIND_PRODUCER | SPAN_KIND_CONSUMER | SPAN_KIND_INTERNAL
    # 返回结构 (NodeMetricResponse)：
    #   reqRateMetric[]      吞吐率时序 (SampleStream)
    #   errorsRateMetrics[]  错误率时序
    #   repLatencyMetric[]   平均请求延迟时序
    # 每条 SampleStream: { metric: {labels}, values: [{timestamp, value}, ...] }

  # ── 事件 (Event) ──────────────────────────────────────────────────────
  # 所有 startTime / endTime / timestamp 均为 RFC3339(Nano) 字符串
  #   （如 2026-05-21T18:00:00Z 或 2026-05-21T18:00:00.123456789Z）
  # 注意：事件对象字段命名是 involveObject（不是标准 K8s 的 involvedObject）。
  query-events:
    short: "Query K8s events of a cluster with filters and pagination"
    aliases: [ls-events]
    example: |
      # 最近 1 小时 insight-system 命名空间内的 Warning 事件
      dc insight event query-events \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --start-time 2026-05-21T17:00:00Z --end-time 2026-05-21T18:00:00Z \
        --filter.type Warning \
        --page 1 --page-size 50 -o json

      # 按 reason + involveObject + message 模糊过滤
      dc insight event query-events \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --filter.reason FailedScheduling \
        --filter.involve-object-kind Pod \
        --filter.involve-object-name insight-server \
        --filter.message 'insufficient memory' \
        --sort 'timestamp,desc'

      # 返回结构（items 数组每条）：
      #   timestamp                 唯一主键，RFC3339Nano，可作 query-event-context 的 --timestamp
      #   type                      Normal | Warning
      #   reason / message / action / count / firstTimestamp / lastTimestamp
      #   metadata.namespace        命名空间
      #   metadata.name / uid       事件资源元信息
      #   involveObject.kind        关联对象类型 (注意：不是 involvedObject)
      #   involveObject.name
      #   involveObject.namespace
      #   clusterName / clusterUuid
    params:
      page:        { default: "1" }
      pageSize:    { default: "20" }
      filter.type: { help: "TYPE_UNSPECIFIED | Normal | Warning" }
      sort:        { help: "timestamp,desc (默认) | timestamp,asc | type,desc | type,asc" }

  query-event-context:
    short: "Fetch surrounding events around a specific timestamp (context view)"
    example: |
      # 重要：filter.involve-object-kind 或 filter.involve-object-name 至少传一个，
      # 否则后端返回 HTTP 400。filter 在该接口只识别这两个字段。
      #
      # 推荐流程：先用 query-events 取锚点，再用 jq 提取 timestamp / involveObject 作参数
      EVENT=$(dc insight event query-events \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --start-time 2026-05-21T17:00:00Z --end-time 2026-05-21T18:00:00Z \
        --filter.type Warning --page 1 --page-size 1 -o json)

      TS=$(echo "$EVENT"   | jq -r '.items[0].timestamp')
      NS=$(echo "$EVENT"   | jq -r '.items[0].metadata.namespace')
      KIND=$(echo "$EVENT" | jq -r '.items[0].involveObject.kind')
      NAME=$(echo "$EVENT" | jq -r '.items[0].involveObject.name')

      dc insight event query-event-context \
        --cluster-name kpanda-global-cluster --namespace "$NS" \
        --timestamp "$TS" \
        --filter.involve-object-kind "$KIND" \
        --filter.involve-object-name "$NAME" \
        --before 20 --after 20 -o json
    params:
      before:      { default: "50" }
      after:       { default: "50" }
      filter.type: { help: "此接口忽略；仅 involve-object-kind/involve-object-name 生效" }

  query-event-count:
    short: "Aggregate event counts in a time range (POST body supports multiple filters)"
    example: |
      # filters 列表：每项对应一个聚合通道；响应 items 是与 filters 等长的 int64 计数数组。
      # 字段说明（每个 filter）：
      #   type               Normal | Warning（可省，省略表示不限）
      #   involveObjectKind  关联对象类型，如 Pod / Node / Deployment
      #   reason             事件原因（精确）
      #   involveObjectName  关联对象名（模糊）
      #   message            消息体（模糊）
      # 若 filters 省略，服务端使用默认 6 个通道：
      #   imagePullFail / healthyCheckFail / podFailed /
      #   podFailedScheduling / containerRestartingFailed / podFailedMount
      echo '{
        "namespace": "insight-system",
        "startTime": "2026-05-21T17:00:00Z",
        "endTime":   "2026-05-21T18:00:00Z",
        "filters": [
          {"type":"Warning","involveObjectKind":"Pod","reason":"FailedScheduling"},
          {"type":"Warning","involveObjectKind":"Node"}
        ]
      }' | dc insight event query-event-count --cluster-name kpanda-global-cluster --file -

      # 使用默认 filters（不传 filters 字段）
      echo '{
        "namespace": "insight-system",
        "startTime": "2026-05-21T17:00:00Z",
        "endTime":   "2026-05-21T18:00:00Z"
      }' | dc insight event query-event-count --cluster-name kpanda-global-cluster --file -

  query-event-histogram:
    short: "Bucket event counts over time (normal vs warning)"
    example: |
      dc insight event query-event-histogram \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --start-time 2026-05-21T17:00:00Z --end-time 2026-05-21T18:00:00Z \
        --interval 60s -o json

      # 返回结构：
      #   items[].timestamp     桶起点 (RFC3339)
      #   items[].normalCount   Normal 事件数
      #   items[].warningCount  Warning 事件数
      #   totalNormal           窗口内 Normal 总数
      #   totalWarning          窗口内 Warning 总数

  query-event-filter-options:
    short: "List available filter options (object kinds / reasons) for the event UI"
    example: |
      dc insight event query-event-filter-options \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --start-time 2026-05-21T17:00:00Z --end-time 2026-05-21T18:00:00Z -o json

      # 返回字段：
      #   involvedObjectKinds  当前窗口内出现过的对象类型（注意是 involvedObjectKinds，而事件对象本身用 involveObject）
      #   reasons              当前窗口内出现过的 reason 列表

  get-reasons:
    short: "Get the predefined event reason vocabulary grouped by object kind"
    example: |
      dc insight event get-reasons -o json

      # 返回字段（每项为字符串数组）：
      #   node / daemonSet / deployment / job / pod / statefulSet

  # ── 概览 (Overview) ───────────────────────────────────────────────────
  # time / start / end 单位为 unix 秒 (int64)，step 为秒 (double，默认 60)。
  # 所有接口返回 data[] 数组，每项为 metric.BatchQueryResult / BatchQueryRangeResult：
  #   data[].data         vector / matrix（即时 / 范围）；metric labels 含 __name__ 标识指标
  #   data[].status       SUCCESS | FAIL
  #   data[].errorMessage 失败时的错误描述
  get-resources-count:
    short: "Get global resource counts (clusters / nodes / pods / deployments / GPU / log / trace)"
    example: |
      # 默认返回 16 个资源类型
      dc insight overview get-resources-count -o json

      # 指定时间点（unix 秒）+ 仅查集群与节点
      dc insight overview get-resources-count \
        --time $(date +%s) \
        --filters CLUSTER_TOTAL --filters CLUSTER_NORMAL_TOTAL \
        --filters NODE_TOTAL --filters NODE_NORMAL_TOTAL -o json
    params:
      filters:
        help: |
          可重复传入。可选值：
            CLUSTER_TOTAL | CLUSTER_NORMAL_TOTAL
            NODE_TOTAL    | NODE_NORMAL_TOTAL
            DEPLOYMENT_TOTAL  | DEPLOYMENT_NORMAL_TOTAL
            STATEFULSET_TOTAL | STATEFULSET_NORMAL_TOTAL
            DAEMONSET_TOTAL   | DAEMONSET_NORMAL_TOTAL
            JOB_TOTAL         | JOB_NORMAL_TOTAL
            POD_TOTAL         | POD_NORMAL_TOTAL
            GPU_COUNT | GPU_ALLOCATED_COUNT
            LOG_TOTAL | TRACE_TOTAL
          省略时返回上述全部 16 项。

  get-resources-range:
    short: "Get resource counts over a time range (sparkline data)"
    example: |
      # 最近 1 小时，60s 采样
      END=$(date +%s); START=$((END - 3600))
      dc insight overview get-resources-range \
        --start $START --end $END --step 60 \
        --filters NODE_TOTAL --filters POD_NORMAL_TOTAL --filters POD_ABNORMAL_TOTAL -o json
    params:
      step:
        help: "采样间隔秒 (double)。默认 60。"
      filters:
        help: |
          可重复传入。可选值：
            NODE_TOTAL | POD_TOTAL | POD_NORMAL_TOTAL | POD_ABNORMAL_TOTAL
          省略时默认 [NODE_TOTAL, POD_NORMAL_TOTAL, POD_ABNORMAL_TOTAL]。

  get-resources-usage:
    short: "Get top-N resource usage time series (CPU / memory / disk) for clusters or nodes"
    example: |
      END=$(date +%s); START=$((END - 3600))
      # 节点 CPU 使用率 Top 5
      dc insight overview get-resources-usage \
        --start $START --end $END --step 60 \
        --filters NODE_CPU_USAGE --limit 5 -o json

      # 集群级 CPU 使用率
      dc insight overview get-resources-usage \
        --start $START --end $END --step 60 \
        --filters CLUSTER_CPU_USAGE --limit 10 -o json
    params:
      limit:
        help: "Top-N 上限（按值降序）。默认 5。"
      step:
        help: "采样间隔秒 (double)。默认 60。"
      filters:
        help: |
          可重复传入。可选值：
            CLUSTER_CPU_USAGE | CLUSTER_MEM_USAGE | CLUSTER_DISK_USAGE
            NODE_CPU_USAGE    | NODE_MEM_USAGE    | NODE_DISK_USAGE
          省略时默认 [CLUSTER_CPU_USAGE, NODE_CPU_USAGE]。

  get-services-monitor:
    short: "Get a snapshot of service-level APM signals (avg latency / error rate)"
    example: |
      # 默认 - 平均延迟 + 错误率，Top 5
      dc insight overview get-services-monitor -o json

      # 限制返回 10 条
      dc insight overview get-services-monitor --limit 10 -o json

      # 指定时间点 + 仅统计 SERVER span
      dc insight overview get-services-monitor \
        --time $(date +%s) --limit 5 \
        --span-kinds SPAN_KIND_SERVER -o json
    params:
      limit:
        help: "Top-N 上限（按值降序）。默认 5。"
      filters:
        help: |
          可重复传入。可选值：
            AVG_LATENCY  返回值单位 ms
            ERR_RATE     返回值为百分比
          省略时默认 [AVG_LATENCY, ERR_RATE]。
      span-kinds:
        help: |
          OTel span kind 过滤（逻辑 OR），可重复。常用值：
            SPAN_KIND_SERVER   入站服务端
            SPAN_KIND_CLIENT   出站客户端
            SPAN_KIND_PRODUCER | SPAN_KIND_CONSUMER | SPAN_KIND_INTERNAL
          省略时默认 [SPAN_KIND_SERVER, SPAN_KIND_CLIENT]。

  # ── 拨测 (Probe) ──────────────────────────────────────────────────────
  # 基于 prometheus-operator Probe CR + blackbox-exporter；
  # jobName 必须匹配 ^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$，长度 1~63。
  list-probers:
    short: "List blackbox-exporter probers available in a cluster"
    aliases: [ls-probers]
    example: |
      dc insight probe list-probers --cluster-name kpanda-global-cluster -o json

      # 返回结构：
      #   probers[].prober          ProberSpec { name, url, scheme, path, proxyUrl }
      #   probers[].modules         该 prober 支持的模块名数组，例如：
      #                             [http_2xx, HTTP_GET, HTTP_POST, TCP, POP3S, SSH]
      #   probers[].configmapMeta   { clusterName, namespace, name, data } 模块定义来源

  list-probes:
    short: "List probes in a cluster + namespace"
    aliases: [ls-probes]
    example: |
      dc insight probe list-probes \
        --cluster-name kpanda-global-cluster --namespace insight-system -o json

      # 模糊搜索 + 分页 + 排序
      dc insight probe list-probes \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --fuzzy-name http --sorts 'create_at,desc' \
        --page 1 --page-size 50 -o json

      # 返回 items[] 每条结构：
      #   kind / apiVersion / metadata
      #   spec { jobName, module, prober, targets, interval, scrapeTimeout, ... }
      #   status.phase  Pending | Running | Failed
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }
      sorts:
        help: |
          单一排序字段，格式 "<field>[,asc|desc]"，仅省略方向时默认 desc。
          支持：job_name,desc | job_name,asc | create_at,desc | create_at,asc
          默认：create_at,desc
      fuzzy-name:
        help: "在 jobName 等字段做模糊匹配"

  get-probe:
    short: "Get a probe by cluster + namespace + jobName"
    aliases: [describe-probe]
    example: |
      dc insight probe get-probe \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --job-name web-check -o json

      # 资源不存在时返回 HTTP 404。

  add-probe:
    short: "Create a probe (PrometheusOperator Probe / blackbox-exporter)"
    example: |
      # 1) 先查可用 prober + module
      dc insight probe list-probers --cluster-name kpanda-global-cluster -o json

      # 2) 用上一步返回的 prober.url / 选定 module 创建
      # 字段说明（probe / ProbeSpec）：
      #   jobName        必填，^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$，1~63
      #   module         必填，须在该 prober 的 modules 列表中
      #                  常见: http_2xx | HTTP_GET | HTTP_POST | TCP | POP3S | SSH
      #   interval       抓取间隔（go duration），如 "30s"
      #   scrapeTimeout  抓取超时
      #   prober         { name, url, scheme(http/https), path(/probe), proxyUrl }
      #   targets.staticConfig.static  目标地址列表
      #   targets.staticConfig.labels  附加 label（map<string,string>）
      #   可选：proxyUrl / enableHttp2 / followRedirects / sampleLimit /
      #        honorTimestamps / honorLabels / relabelings / metricRelabelings
      echo '{
        "probe": {
          "jobName":       "web-check",
          "module":        "http_2xx",
          "interval":      "30s",
          "scrapeTimeout": "10s",
          "prober": {
            "name":   "insight-agent-prometheus-blackbox-exporter",
            "url":    "insight-agent-prometheus-blackbox-exporter.insight-system:9115",
            "scheme": "http",
            "path":   "/probe"
          },
          "targets": {
            "staticConfig": {
              "static": [
                "https://example.com",
                "https://api.example.com/health"
              ],
              "labels": {"team": "ops"}
            }
          }
        }
      }' | dc insight probe add-probe \
            --cluster-name kpanda-global-cluster --namespace insight-system --file -

  update-probe:
    short: "Update a probe's interval / scrapeTimeout / module / targets"
    example: |
      # 只能更新这 4 个字段；其他 spec 字段（prober/relabelings/...) 需删了重建。
      echo '{
        "interval":      "60s",
        "scrapeTimeout": "15s",
        "module":        "http_2xx",
        "targets": {
          "staticConfig": {
            "static": ["https://example.com"],
            "labels": {"team": "ops", "tier": "edge"}
          }
        }
      }' | dc insight probe update-probe \
            --cluster-name kpanda-global-cluster --namespace insight-system \
            --job-name web-check --file -

  delete-probe:
    short: "Delete a probe by cluster + namespace + jobName"
    example: |
      dc insight probe delete-probe \
        --cluster-name kpanda-global-cluster --namespace insight-system \
        --job-name web-check

  # ── 用户 (User) ───────────────────────────────────────────────────────
  # 注意：此 list-users 与 ghippo 的 list-users 不同，命令前缀是 `dc insight user`
  list-users:
    short: "List Insight users (Insight-side user view, not ghippo)"
    aliases: [ls-users]
    example: |
      dc insight user list-users
      # Fuzzy search by name + paged JSON output
      dc insight user list-users --search alice --page 1 --page-size 50 -o json
    params:
      page:     { default: "1" }
      pageSize: { default: "20" }

  # ── 功能开关 (FeatureGate) ────────────────────────────────────────────
  get-feature-gates:
    short: "List all Insight feature gates and their enabled status"
    aliases: [ls-feature-gates]
    example: |
      dc insight featuregate get-feature-gates
      dc insight featuregate get-feature-gates -o json

  get-feature-gate-by-id:
    short: "Get a single feature gate by ID"
    example: |
      # id must be one of:
      #   METRICS | LOGGING | TRACING | GRAPH_VIRTUAL_NODE
      #   LOG_ALERT | NET_FLOW | EVENT | SLOW_SQL
      dc insight featuregate get-feature-gate-by-id --id METRICS
      dc insight featuregate get-feature-gate-by-id --id SLOW_SQL -o json

  # ── 全局配置 (GlobalConfig) ───────────────────────────────────────────
  get-version:
    short: "Get Insight server version info"
    example: |
      dc insight insight get-version
      dc insight insight get-version -o json

  get-global-config:
    short: "Get Insight global configuration (retention, thresholds)"
    example: |
      dc insight insight get-global-config
      dc insight insight get-global-config -o json

  get-userinfo:
    short: "Get current user's Insight permissions and accessible resource types"
    example: |
      dc insight insight get-userinfo
      dc insight insight get-userinfo -o json

  update-global-config:
    short: "Update Insight global configuration (retention, thresholds)"
    example: |
      # Update retention windows and APM thresholds
      dc insight insight update-global-config \
        --set logRetentionTime=7d \
        --set k8sEventLogRetentionTime=7d \
        --set skoalaLogRetentionTime=7d \
        --set traceDataRetentionTime=15d \
        --set vmStorageRetentionTime=30d \
        --set alertHistoryRetentionTime=90 \
        --set traceApdexThreshold=500ms \
        --set slowSqlThreshold=1000 \
        --set-str 'latencyThresholds[0]=500' \
        --set-str 'latencyThresholds[1]=1000' \
        --set-str 'errorRateThresholds[0]=0.01' \
        --set-str 'errorRateThresholds[1]=0.05'

      # Or pass the full body via stdin
      echo '{
        "logRetentionTime": "7d",
        "k8sEventLogRetentionTime": "7d",
        "skoalaLogRetentionTime": "7d",
        "traceDataRetentionTime": "15d",
        "vmStorageRetentionTime": "30d",
        "alertHistoryRetentionTime": 90,
        "traceApdexThreshold": "500ms",
        "slowSqlThreshold": 1000,
        "latencyThresholds": [500, 1000],
        "errorRateThresholds": [0.01, 0.05]
      }' | dc insight insight update-global-config --file -

  get-helm-install-config:
    short: "Generate Helm install parameters for the Insight agent chart"
    example: |
      # Get install params for insight-agent chart
      dc insight insight get-helm-install-config \
        --set chartName=insight-agent \
        --set version=0.30.0

      # With extra overrides
      echo '{
        "chartName": "insight-agent",
        "version": "0.30.0",
        "extra": {
          "global.exporters.logging.enabled": true,
          "global.exporters.metrics.enabled": true
        }
      }' | dc insight insight get-helm-install-config --file -

commands:
  # ── 平台内部 API，不对外暴露 ──────────────────────────────────────────
  # FeatureGate
  list-feature-gates:    { ignore: true }
  get-feature-gate:      { ignore: true }
  update-feature-gate:   { ignore: true }

  # SettingService
  get-setting:           { ignore: true }
  update-setting:        { ignore: true }

  # StreamService
  stream:                { ignore: true }

  # ── 集群 (Cluster) ────────────────────────────────────────────────────
  list-clusters:
    short: "List all managed clusters"
    aliases: [ls, ls-clusters]
    example: |
      dc container-management cluster list-clusters
      dc container-management cluster list-clusters -o json | jq '.items[].name'
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  create-cluster:
    short: "Register or create a cluster"
    example: |
      dc container-management cluster create-cluster --file cluster.json

  get-cluster:
    short: "Get cluster details"
    aliases: [describe, describe-cluster]
    example: |
      dc container-management cluster get-cluster --name prod-cluster
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  delete-cluster:
    short: "Remove a cluster from management"

  update-clusters:
    short: "Update cluster configuration"

  get-cluster-kube-config:
    short: "Download kubeconfig for a cluster"
    aliases: [kubeconfig]
    example: |
      dc container-management cluster get-cluster-kube-config --cluster prod-cluster -o raw > kubeconfig.yaml

  validate-kube-config:
    short: "Validate a kubeconfig before registration"

  list-cluster-summary:
    short: "List cluster summary (lightweight)"
    aliases: [summary]

  # ── 命名空间 (Core/Namespace) ─────────────────────────────────────────
  list-namespaces:
    short: "List namespaces in a cluster"
    aliases: [ls-ns]
    example: |
      dc container-management core list-namespaces --cluster prod-cluster
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-namespaces:
    short: "List all namespaces across a cluster"
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  # ── 工作负载 (Apps) ───────────────────────────────────────────────────
  list-deployments:
    short: "List Deployments in a namespace"
    aliases: [ls-deploy]
    example: |
      dc container-management apps list-deployments \
        --cluster prod-cluster \
        --namespace default
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-stateful-sets:
    short: "List StatefulSets in a namespace"
    aliases: [ls-sts]
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-daemon-sets:
    short: "List DaemonSets in a namespace"
    aliases: [ls-ds]
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-all-deployments:
    short: "List Deployments across all namespaces in a cluster"
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-all-stateful-sets:
    short: "List StatefulSets across all namespaces in a cluster"
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-all-daemon-sets:
    short: "List DaemonSets across all namespaces in a cluster"
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  # ── 权限 (RBAC) ───────────────────────────────────────────────────────
  list-cluster-roles:
    short: "List ClusterRoles"
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-role-bindings:
    short: "List ClusterRoleBindings"
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-role-bindings:
    short: "List RoleBindings in a namespace"
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  # ── 网络 (Networking) ─────────────────────────────────────────────────
  list-ingresses:
    short: "List Ingresses in a namespace"
    aliases: [ls-ing]
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  create-ingress:
    short: "Create an Ingress"

  get-ingress:
    short: "Get Ingress details"

  delete-ingress:
    short: "Delete an Ingress"

  # ── 存储 (Storage) ────────────────────────────────────────────────────
  list-persistent-volumes:
    short: "List PersistentVolumes in a cluster"
    aliases: [ls-pv]
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-persistent-volume-claims:
    short: "List PersistentVolumeClaims in a namespace"
    aliases: [ls-pvc]
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  # ── 批处理 (Batch) ────────────────────────────────────────────────────
  list-jobs:
    short: "List Jobs in a namespace"
    aliases: [ls-jobs]
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cron-jobs:
    short: "List CronJobs in a namespace"
    aliases: [ls-cj]
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  # ── 插件 (Addon) ──────────────────────────────────────────────────────
  list-addons:
    short: "List available cluster addons"
    aliases: [ls-addons]

  install-addon:
    short: "Install an addon to a cluster"

  uninstall-addon:
    short: "Uninstall an addon from a cluster"

  # ── 分页默认值 (其余分页命令) ─────────────────────────────────────────────
  list-clusterlcm-ops:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-helm-operations:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-helm-releases:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-helm-charts:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-helm-operations:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-helm-release-resources:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-helm-releases:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-helm-repos:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-custom-resources:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-custom-resource-definitions:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-custom-resources:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-daemon-sets:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-deployments:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-replica-sets:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-stateful-sets:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-controller-revisions:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-replica-sets:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cron-horizontal-pod-autoscalers:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-horizontal-pod-autoscalers:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-vertical-pod-autoscalers:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-all-cron-jobs:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-all-jobs:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-cron-jobs:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-jobs:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-jobs-by-cron-jobs-name:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-all-pods:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-config-maps:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-events:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-limit-ranges:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-persistent-volume-claims:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-pods:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-secrets:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-services:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-config-maps:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-containers-by-pod:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-events:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-limit-ranges:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-nodes:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-pods:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-pods-by-node:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-resource-quotas:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-secrets:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-service-accounts:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-services:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-etcd-backup-strategies:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-artifacts:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-projects:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-registries:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-repositories:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-ingresses:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-network-policies:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-metallb-ip-address-pools:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-network-policies:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-groups:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-roles:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-users:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-accessible-storage-classes:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-cluster-volume-snapshots:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-storage-classes:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  list-volume-snapshots:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

  get-pod-container-log:
    params:
      page: { default: "1" }
      pageSize: { default: "20" }

sources:
  ghippo:
    display_name: global-management
    repo_url: https://github.com/DaoCloud/daocloud-api-docs.git
    # pinned to main HEAD as of 2026-05-11; bump when upgrading ghippo version
    pinned_tag: 4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3
    backend: swagger
    swagger:
      files:
        - docs/openapi/ghippo/v0.45.1.json

  kpanda:
    display_name: container-management
    repo_url: https://github.com/DaoCloud/daocloud-api-docs.git
    # pinned to main HEAD as of 2026-05-11; bump when upgrading kpanda version
    pinned_tag: 4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3
    backend: swagger
    swagger:
      files:
        - docs/openapi/kpanda/v0.46.0.json

  insight:
    display_name: insight
    repo_url: https://github.com/DaoCloud/daocloud-api-docs.git
    # pinned to main HEAD as of 2026-05-11; bump when upgrading kpanda version
    pinned_tag: 4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3
    backend: swagger
    swagger:
      files:
        - docs/openapi/insight/v0.41.0.json

generated by lathe codegen; safe to remove and regenerate

---
name: dc
description: >
  Use when operating the dc generated CLI. Discover commands, inspect parameters,
  check auth state, and execute API operations safely.
---

# dc CLI

Use this skill when a user asks you to operate `dc`, inspect its API commands, or find the right generated command for an API task.

## Workflow

1. Search for candidates with `dc search "<intent>" --json`; use `--limit` when needed. Search is only candidate discovery.
2. Inspect the exact command with `dc commands show <path...> --json` before executing an unfamiliar command.
3. If the command detail has `auth.required=true`, run `dc auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$DC_HOST`.
4. Execute only after flags, body, auth, HTTP path, and output hints are clear from `commands show`.

## General Commands

- `dc commands --json`: full generated command catalog.
- `dc commands --include-hidden --json`: include hidden generated commands.
- `dc commands show <path...> --json`: source of truth for one command.
- `dc commands schema --json`: catalog schema version for parser compatibility.
- `dc search "<intent>" --json`: ranked candidate commands.

## Maintenance Commands

- `dc --version` or `dc -v`: print CLI build version.

## References

- Read `references/catalog.md` for the command discovery protocol and catalog field meanings.
- Read `references/modules/container-management.md` for the `container-management` module command index.
- Read `references/modules/global-management.md` for the `global-management` module command index.
- Read `references/modules/insight.md` for the `insight` module command index.

## Rules

- Do not guess flags or request body shape from command names.
- Do not execute directly from search results; confirm with `commands show` first.
- Prefer `-o json` for machine-readable command output unless the user asks for human-readable output.
- Use `--file`, `--set`, or `--set-str` for JSON request bodies according to `commands show` body requirements.
- For sensitive flags, prefer safe modes from `flags[].input_modes`: `--<flag>-env`, `--<flag>-file`, or `--<flag>-stdin`.

interface:
  display_name: "dc CLI"
  short_description: "Use the dc generated CLI"
  default_prompt: "Use $dc to find and run the right dc command."

# Catalog Protocol

Use the runtime catalog as the source of truth. Generated references are a fast index; command execution details come from the CLI itself.

## Search

Run `dc search "<intent>" --json` to find candidate commands. Use `--limit` to control result count. Treat search output as candidates only.

## Full Catalog

Run `dc commands --json` to inspect the generated command catalog. Use `--include-hidden` only when hidden commands are relevant.

Key fields:

- `path`: command path to pass to `commands show` or execute after the CLI name.
- `shortcuts`: root-level commands that execute the same operation with preset flag values.
- `http`: HTTP method and path template.
- `http.default_hostname`: optional source-level host selected after explicit `--hostname` and `$DC_HOST`; when present it is used before the single-host fallback from `hosts.yml`.
- `flags`: CLI flags, parameter location, type, required state, defaults, enum values, format, input modes, and help.
- `body`: request body requirement and media type.
- `auth`: whether auth is required and which scopes are declared.
- `examples`: runnable examples with optional body shape, output hints, and follow-up commands.
- `output`: list path, default columns, response media type, pagination, and streaming hints.
- `notes`, `prerequisites`, and `known_errors`: overlay-provided operation context that is not inferred from the API spec.

## Command Detail

Run `dc commands show <path...> --json` before executing an unfamiliar command. This is the source of truth for flags, body, auth, HTTP path, and output hints.

## Schema

Run `dc commands schema --json` to read the catalog schema version before parsing catalog JSON with durable tooling.

## Sensitive Flags

When a flag entry has `input_modes`, prefer safe modes over putting secrets directly in shell arguments.

- `flag`: pass the direct `--<flag>` value; keep this for compatibility or non-secret values.
- `env`: pass `--<flag>-env NAME` to read the value from an environment variable.
- `file`: pass `--<flag>-file path` to read the value from a file.
- `stdin`: pass `--<flag>-stdin` to read the value from stdin.
- Use only one input mode for the same flag.

## Request Bodies

- `--file path`: read a JSON body from a file.
- `--file -`: read a JSON body from stdin.
- `--set key.path=value`: build JSON with type inference for booleans, null, integers, and floats.
- `--set-str key.path=value`: build JSON while forcing the value to remain a string.

## Output

Use `-o json` for machine-readable command output. Other supported formats are `table`, `yaml`, and `raw`.

## Auth

If command detail returns `auth.required=true`, run `dc auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$DC_HOST`; if no matching host is logged in, stop and ask the user to authenticate.

# Module `container-management`

## Source

- Backend: `swagger`
- Repository: https://github.com/DaoCloud/daocloud-api-docs.git
- Pinned tag: `4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3`
- Files: `docs/openapi/kpanda/v0.46.0.json`
- Resolved SHA: `4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3`

## Addon

### `dc container-management addon create-helm-release`

- Summary: CreateHelmRelease creates a Release.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the chart belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the helm release belongs to.

### `dc container-management addon create-helm-repo`

- Summary: CreateHelmRepo create a repo in cluster.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.

### `dc container-management addon delete-helm-operation`

- Summary: DeleteHelmOperation delete a operation in cluster.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmoperations/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the daemonSet belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon delete-helm-release`

- Summary: DeleteHelmRelease delete a release.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the helmrelease belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the helmrelease belongs to.
  - `--name` (path, required): Name represents the name of helmrelease.

### `dc container-management addon delete-helm-repo`

- Summary: DeleteHelmRepo delete a repo in cluster.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon get-helm-chart`

- Summary: GetHelmChartVersion get a chart version info from repository.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{repo}/helmcharts/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the chart belongs to.
  - `--repo` (path, required): The repo represents for the charts belongs to.
  - `--name` (path, required): The name represents for the resource name.
  - `--version` (query): The version represents for the resource version.

### `dc container-management addon get-helm-chart-display`

- Summary: GetHelmChartDisplay get a chart display info from repository.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{repo}/helmcharts/{name}/display`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the chart belongs to.
  - `--repo` (path, required): The repo represents for the charts belongs to.
  - `--name` (path, required): The name represents for the resource name.
  - `--version` (query): The version represents for the resource version.

### `dc container-management addon get-helm-chart-files`

- Summary: GetHelmChartFiles get a chart files from repository.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{repo}/helmcharts/{name}/files`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the chart belongs to.
  - `--repo` (path, required): The repo represents for the charts belongs to.
  - `--name` (path, required): The name represents for the resource name.
  - `--version` (query): The version represents for the resource version.

### `dc container-management addon get-helm-chart-manifest`

- Summary: GetHelmChartManifest get a chart manifests info from repository.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{repo}/helmcharts/{name}/manifests`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the chart belongs to.
  - `--repo` (path, required): The repo represents for the charts belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon get-helm-chart-resources`

- Summary: GetHelmChartResources get the resources contained in charts.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{repo}/helmcharts/{name}/resources`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the chart belongs to.
  - `--repo` (path, required): The repo represents for the charts belongs to.
  - `--name` (path, required): The name represents for the resource name.
  - `--version` (query): The version represents for the resource version.
- Output: list path `resources`; columns `name`, `kind`, `image`

### `dc container-management addon get-helm-install-config`

- Summary: GetHelmInstallConfig create a Release.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{repo}/helmcharts/{name}:config`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the chart belongs to.
  - `--repo` (path, required): The repo represents for the charts belongs to.
  - `--name` (path, required): Name represents the name of helmrelease

### `dc container-management addon get-helm-operation`

- Summary: GetHelmOperation get a operation in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmoperations/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the daemonSet belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon get-helm-operation-json`

- Summary: GetHelmOperationJSON get a operation json in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmoperations/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the daemonSet belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon get-helm-release`

- Summary: GetHelmRelease gets a release in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the helmrelease belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the helmrelease belongs to.
  - `--name` (path, required): Name of the helmrelease.

### `dc container-management addon get-helm-release-json`

- Summary: GetHelmReleaseJSON gets a release in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the release belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the helmrelease belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon get-helm-repo`

- Summary: GetHelmRepo get a repo in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon get-helm-repo-json`

- Summary: GetHelmRepoJSON get a repo json in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon list-cluster-helm-operations`

- Summary: ListClusterHelmOperations list operation in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmoperations`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified operation belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the event list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): name is used for query.
  - `--release-name` (query): Filter helm_operation by release_name,
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `status.version`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management addon list-cluster-helm-releases`

- Summary: ListClusterHelmReleases list apps in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmreleases`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified operation belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the event list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): name is used for query.
  - `--helm-chart-name` (query): the helm releases's chart name
  - `--helm-chart-repo` (query): the helm releases's chart repo name
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `spec.version`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management addon list-cluster-installed-helm-chart`

- Summary: ListClusterInstalledHelmChart list the charts which installed belong to repo
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmcharts/installed`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the chart belongs to.
  - `--repo-name` (query): repo_name represents which helm repo's name use to list installed helm chart

### `dc container-management addon list-helm-charts`

- Summary: ListCharts list chart from repositories.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmcharts`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the chart belongs to.
  - `--name` (query): Helm chart name.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--category` (query, default `CATEGORY_UNSPECIFIED`, one of: CATEGORY_UNSPECIFIED|CATEGORY_OTHERS|CATEGORY_STORAGE|CATEGORY_NETWORKING|CATEGORY_MONITORING|CATEGORY_DATABASE|CATEGORY_DATASERVICE|CATEGORY_ECOAPP|CATEGORY_BIGDATA|CATEGORY_SECURITY|CATEGORY_IOTEDGE|CATEGORY_INFRA): Category is used for query.
  - `--repo` (query): The repo name which the charts belongs to.
  - `--required` (query): Required indicates whether to display the charts, which are required to install the cluster.
- Output: list path `data`; columns `metadata.name`, `created`, `removed`; pagination `offset`

### `dc container-management addon list-helm-operations`

- Summary: ListHelmOperations list operation in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmoperations`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ConfigMap.
  - `--name` (query): Name is the user-specified identifier.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the repository list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the repository list order.
  - `--release-name` (query): Filter helm_operation by release_name,
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `status.version`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management addon list-helm-release-resources`

- Summary: ListHelmReleaseResources lists resources related to the specified helm release.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases/{helmrelease}/resources`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the helmrelease belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the helmrelease belongs to.
  - `--helmrelease` (path, required): Name of the helmrelease.
  - `--name` (query): Name is used to fuzzy search resources which belongs to this helmrelease by resource name.
  - `--kind` (query): Kind is used to filter resources which belongs to this helmrelease by resource kind.
  - `--phase` (query, default `RESOURCE_PHASE_UNSPECIFIED`, one of: RESOURCE_PHASE_UNSPECIFIED|InProgress|Failed|Current|Terminating|Unknown): Phase is used to filter resources which belongs to this helmrelease by resource phase.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the resource list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): SortDir determines the list order.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `name`, `namespace`, `phase`, `kind`, `apiVersion`; pagination `offset`

### `dc container-management addon list-helm-release-revisions`

- Summary: ListHelmReleaseRevisions lists revisions of the specified helm release.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases/{helmrelease}/revisions`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the helmrelease belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the helmrelease belongs to.
  - `--helmrelease` (path, required): Name of the helmrelease.
- Output: list path `items`; columns `appVersion`, `chart`, `manifest`, `status`, `updated`, `version`

### `dc container-management addon list-helm-releases`

- Summary: ListHelmReleases lists apps in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the releases belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ConfigMap.
  - `--name` (query): Name is the user-specified identifier.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the release list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the release list order.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `spec.version`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management addon list-helm-repos`

- Summary: ListHelmRepos list repo in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--name` (query): Name is the user-specified identifier.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the repository list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the repository list order.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--built-in` (query): builtin indicates whether to display the repos required to install the cluster.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management addon refresh-helm-repo`

- Summary: RefreshHelmRepo updates a helm repo's index.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{name}:refresh`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the helmrepo belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon rollback-helm-release`

- Summary: RollbackHelmRelease rollbacks a release.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases/{name}:rollback`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the helmrelease belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the helmrelease belongs to.
  - `--name` (path, required): Name represents the name of helmrelease.

### `dc container-management addon update-helm-release`

- Summary: UpdateHelmRelease updates a release.
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/helmreleases/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the helmrelease belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the helmrelease belongs to.
  - `--name` (path, required): Name represents the name of helmrelease.

### `dc container-management addon update-helm-repo`

- Summary: UpdateHelmRepo update repo
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents which cluster the repository belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management addon validate-helm-repo`

- Summary: ValidateHelmRepo verifies if a repo is connectable.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/helmrepos/{name}/validate`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster of the repo
  - `--name` (path, required): Name of the repo

## Apiextensions

### `dc container-management apiextensions create-cluster-custom-resource`

- Summary: CreateClusterCustomResource creates a customResource of cluster scope to
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/{resource}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.

### `dc container-management apiextensions create-custom-resource`

- Summary: CreateCustomResource creates a customResource of namespaced scope to the
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/namespaces/{namespace}/{resource}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--namespace` (path, required): Namespace represents which namespace the CustomResource belongs to.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.

### `dc container-management apiextensions create-custom-resource-definition`

- Summary: CreateCustomResourceDefinition creates a customResourceDefinition to the
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/customresourcedefinitions`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified customResourceDefinition belongs to.

### `dc container-management apiextensions create-resource`

- Summary: CreateResource creates a list of resources of a given yaml
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/resources`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the resources belong to.
  - `--namespace` (path, required): Namespace represents which namespace the resources belong to.
- Output: list path `data`

### `dc container-management apiextensions delete-cluster-custom-resource`

- Summary: DeleteClusterCustomResource deletes a customResource of cluster scope from
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/{resource}/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.
  - `--deletion-propagation` (query, default `DELETION_PROPAGATION_UNSPECIFIED`, one of: DELETION_PROPAGATION_UNSPECIFIED|DELETION_PROPAGATION_ORPHAN|DELETION_PROPAGATION_BACKGROUND|DELETION_PROPAGATION_FOREGROUND): - DELETION_PROPAGATION_ORPHAN: Orphans the dependents.

### `dc container-management apiextensions delete-custom-resource`

- Summary: DeleteCustomResource deletes a customResource of namespaced scope from the
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/namespaces/{namespace}/{resource}/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--namespace` (path, required): Namespace represents which namespace the CustomResource belongs to.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.
  - `--deletion-propagation` (query, default `DELETION_PROPAGATION_UNSPECIFIED`, one of: DELETION_PROPAGATION_UNSPECIFIED|DELETION_PROPAGATION_ORPHAN|DELETION_PROPAGATION_BACKGROUND|DELETION_PROPAGATION_FOREGROUND): - DELETION_PROPAGATION_ORPHAN: Orphans the dependents.

### `dc container-management apiextensions delete-custom-resource-definition`

- Summary: DeleteCustomResourceDefinition deletes a customResourceDefinition from the
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/customresourcedefinitions/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified customResourceDefinition belongs to.
  - `--name` (path, required): Name is the metadata.name of the referenced customResourceDefinition.

### `dc container-management apiextensions get-cluster-custom-resource`

- Summary: GetClusterCustomResource gets a customResource of cluster scope
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/{resource}/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.
  - `--show-detail` (query): ShowDetail is the presentation details, including metadata, spec, and status

### `dc container-management apiextensions get-cluster-custom-resource-json`

- Summary: GetClusterCustomResourceJSON gets a customResource json of cluster scope
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/{resource}/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.

### `dc container-management apiextensions get-custom-resource`

- Summary: GetCustomResource gets a customResource of namespaced scope from
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/namespaces/{namespace}/{resource}/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--namespace` (path, required): Namespace represents which namespace the CustomResource belongs to.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.
  - `--show-detail` (query): ShowDetail is the presentation details, including metadata, spec, and status

### `dc container-management apiextensions get-custom-resource-definition`

- Summary: GetCustomResourceDefinition gets a customResourceDefinition from
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/customresourcedefinitions/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResourceDefinition belongs to.
  - `--name` (path, required): Name represents the name of CustomResourceDefinition.

### `dc container-management apiextensions get-custom-resource-definition-json`

- Summary: GetCustomResourceDefinitionJSON gets a customResourceDefinition json from
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/customresourcedefinitions/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResourceDefinition belongs to.
  - `--name` (path, required): Name represents the name of CustomResourceDefinition.

### `dc container-management apiextensions get-custom-resource-json`

- Summary: GetCustomResourceJSON gets a customResource of namespaced scope json from
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/namespaces/{namespace}/{resource}/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--namespace` (path, required): Namespace represents which namespace the CustomResource belongs to.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.

### `dc container-management apiextensions list-cluster-custom-resources`

- Summary: ListClusterCustomResources lists customResources of cluster scope
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/{resource}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResources belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResources.
  - `--version` (path, required): Version represents the resource version of CustomResources.
  - `--resource` (path, required): Resource represents the resource name of CustomResources, which is plural.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): name is used for query.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--show-detail` (query): ShowDetail is the presentation details, including metadata, spec, and status
- Output: list path `items`; columns `name`, `namespace`, `kind`, `creationTimestamp`, `apiVersion`, `data`; pagination `offset`

### `dc container-management apiextensions list-custom-resource-definition-groups`

- Summary: ListCustomResourceDefinitionGroups lists all groups of customResourceDefinitions in the specified cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/crd-groups`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster to request
- Output: list path `items`

### `dc container-management apiextensions list-custom-resource-definitions`

- Summary: ListCustomResourceDefinitions lists customResourceDefinitions in the specified cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/customresourcedefinitions`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster cluster to be queried
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name search the custom resource definitions fo name
  - `--status` (query): Status search the custom resource definitions fo status
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--group` (query): Group is to filter customResourceDefinitions by group.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management apiextensions list-custom-resources`

- Summary: ListCustomResources lists customResources of namespaced scope from the
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/namespaces/{namespace}/{resource}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResources belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResources.
  - `--version` (path, required): Version represents the resource version of CustomResources.
  - `--namespace` (path, required): Namespace represents which namespace the CustomResources belongs to.
  - `--resource` (path, required): Resource represents the resource name of CustomResources, which is plural.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): name is used for query.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--show-detail` (query): ShowDetail is the presentation details, including metadata, spec, and status
  - `--owner-reference` (query): OwnerReference indicates that the query is based on the OwnerReference.
- Output: list path `items`; columns `name`, `namespace`, `kind`, `creationTimestamp`, `apiVersion`, `data`; pagination `offset`

### `dc container-management apiextensions patch-custom-resource`

- Summary: PatchCustomResource patches a customResource of cluster scope from
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/namespaces/{namespace}/{resource}/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--namespace` (path, required): Namespace represents which namespace the CustomResource belongs to.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.

### `dc container-management apiextensions update-cluster-custom-resource`

- Summary: UpdateClusterCustomResource updates a customResource of cluster scope from
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/{resource}/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.

### `dc container-management apiextensions update-cluster-custom-resource-status`

- Summary: UpdateClusterCustomResourceStatus updates the status of a customResource of cluster scope
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/{resource}/{name}/status`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.

### `dc container-management apiextensions update-custom-resource`

- Summary: UpdateCustomResource updates a customResource of namespaced scope from the
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/namespaces/{namespace}/{resource}/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--namespace` (path, required): Namespace represents which namespace the CustomResource belongs to.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.

### `dc container-management apiextensions update-custom-resource-definition`

- Summary: UpdateCustomResourceDefinition updates a customResourceDefinition from the
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/customresourcedefinitions/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified customResourceDefinition belongs to.
  - `--name` (path, required): Name represents for the resource name.

### `dc container-management apiextensions update-custom-resource-status`

- Summary: UpdateCustomResourceStatus updates the status of a customResource
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/gvr/{group}/{version}/namespaces/{namespace}/{resource}/{name}/status`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the CustomResource belongs to.
  - `--group` (path, required): Group represents the resource group of CustomResource.
  - `--version` (path, required): Version represents the resource version of CustomResource.
  - `--namespace` (path, required): Namespace represents which namespace the CustomResource belongs to.
  - `--resource` (path, required): Resource represents the resource name of CustomResource, which is plural.
  - `--name` (path, required): Name represents the name of CustomResource.

## Apps

### `dc container-management apps create-workload-by-json`

- Summary: CreateWorkloadByJSON creates workload by JSON under the namespaces of a
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/{kind}/json`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the Workload belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the Workload belongs to.
  - `--kind` (path, required, one of: deployments|statefulsets|daemonsets|jobs|cronjobs|pods|replicasets): WorkloadKind the workload of kind

### `dc container-management apps delete-daemon-set`

- Summary: DeleteDaemonSet deletes a daemonSets under the namespaces of a specific
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/daemonsets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which namespace the daemonSet belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the daemonSet belongs to.
  - `--name` (path, required): Name represents the name of daemonSet

### `dc container-management apps delete-deployment`

- Summary: DeleteDeployment deletes a deployment under the namespaces of a specific
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--name` (path, required): Name represents the name of deployment

### `dc container-management apps delete-replica-set`

- Summary: DeleteReplicaSet deletes a replicaset in specified namespace of a cluster
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/replicasets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the ReplicaSet belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ReplicaSet.
  - `--name` (path, required): Name represents for the ReplicaSet name.

### `dc container-management apps delete-stateful-set`

- Summary: DeleteStatefulSet deletes a statefulSet under the namespaces of a specific
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--name` (path, required): Name represents the name of deployment

### `dc container-management apps get-daemon-set`

- Summary: GetDaemonSet gets a daemonSets under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/daemonsets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which namespace the workload belongs to.
  - `--namespace` (path, required): Cluster represents which namespace the workload belongs to.
  - `--name` (path, required): Name represents the name of workload to belongs to.

### `dc container-management apps get-deployment`

- Summary: GetDeployment gets a deployment under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which namespace the workload belongs to.
  - `--namespace` (path, required): Cluster represents which namespace the workload belongs to.
  - `--name` (path, required): Name represents the name of workload to belongs to.

### `dc container-management apps get-replica-set`

- Summary: GetReplicaSet gets replicaset detail in specified namespace of a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/replicasets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified replicaSet belongs to.
  - `--namespace` (path, required): Namespace the specified replicaSet belongs to.
  - `--name` (path, required): Name of the specified replicaSet.

### `dc container-management apps get-replica-set-json`

- Summary: GetReplicaSetJSON gets replicaset yaml in specified namespace of a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/replicasets/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified replicaSet belongs to.
  - `--namespace` (path, required): Namespace the specified replicaSet belongs to.
  - `--name` (path, required): Name represents for the replicaSet name.

### `dc container-management apps get-stateful-set`

- Summary: GetStatefulSet gets a statefulSets under the namespaces of a specific
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which namespace the workload belongs to.
  - `--namespace` (path, required): Cluster represents which namespace the workload belongs to.
  - `--name` (path, required): Name represents the name of workload to belongs to.

### `dc container-management apps get-workload-json`

- Summary: GetWorkloadJSON gets workload by JSON under the namespaces of a specific
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/{kind}/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the Workload belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the Workload belongs to.
  - `--kind` (path, required, one of: deployments|statefulsets|daemonsets|jobs|cronjobs|pods|replicasets): WorkloadKind the workload of kind
  - `--name` (path, required): Name represents the name of Workload
  - `--stable` (query): If stable is true, the v1 version under the corresponding package will be returned.

### `dc container-management apps list-all-daemon-sets`

- Summary: List DaemonSets across all namespaces in a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/daemonsets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster represents which cluster the workloads belongs to.
  - `--namespace` (query): Cluster represents which namespace the workloads belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--show-virtual-cluster` (query): ShowVirtualCluster is used to control whether to return data that belongs to a virtual cluster. Default false.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps list-all-deployments`

- Summary: List Deployments across all namespaces in a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/deployments`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster represents which cluster the workloads belongs to.
  - `--namespace` (query): Cluster represents which namespace the workloads belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--show-virtual-cluster` (query): ShowVirtualCluster is used to control whether to return data that belongs to a virtual cluster. Default false.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps list-all-stateful-sets`

- Summary: List StatefulSets across all namespaces in a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/statefulsets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster represents which cluster the workloads belongs to.
  - `--namespace` (query): Cluster represents which namespace the workloads belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--show-virtual-cluster` (query): ShowVirtualCluster is used to control whether to return data that belongs to a virtual cluster. Default false.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps list-cluster-daemon-sets`

- Summary: ListClusterDaemonSets lists DaemonSet in one cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/daemonsets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of Workload to belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps list-cluster-deployments`

- Summary: ListClusterDeployments lists one cluster all namespace's deployments
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/deployments`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of Workload to belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps list-cluster-replica-sets`

- Summary: ListClusterReplicaSets lists replicasets of a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/replicasets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified replicaset belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): PageSize is the data number per page.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): Name is used for query.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management apps list-cluster-stateful-sets`

- Summary: ListClusterStatefulSets lists one cluster all namespace's statefulsets
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/statefulsets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of Workload to belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps list-config-maps-related-workloads`

- Summary: ListConfigMapsRelatedWorkloads list all workloads associated with this cm
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/configmaps/{configmap}/related`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--configmap` (path, required): configmap
- Output: list path `daemonsets`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`

### `dc container-management apps list-controller-revisions`

- Summary: query like controllerrevisions?kind=STATEFULSET
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/controllerrevisions`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified controllerrevision belongs to.
  - `--namespace` (path, required): Namespace the specified controllerrevision belongs to.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|StatefulSet|DaemonSet): Kind stands for what type of revisions are needed.
  - `--kind-name` (query): The name of involvedObject.
  - `--name` (query): Name stands for controllerrevision name, used for fuzzy search.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): SortDir determines the data list order.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps list-daemon-sets`

- Summary: List DaemonSets in a namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/daemonsets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps list-deployments`

- Summary: List Deployments in a namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`
- Example:

```
dc container-management apps list-deployments \
  --cluster prod-cluster \
  --namespace default
```

### `dc container-management apps list-replica-sets`

- Summary: ListReplicaSets lists replicasets in specified namespace of a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/replicasets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of replicaset belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the replicaset belongs to.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Deployment): Kind stands for what type of replicasets are needed.
  - `--kind-name` (query): The name of involvedObject.
  - `--name` (query): Name stands for replicaset name, used for fuzzy search.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): SortDir determines the data list order.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): PageSize is size of every page.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management apps list-secrets-related-workloads`

- Summary: ListSecretsRelatedWorkloads list all workloads associated with this secret
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/secrets/{secret}/related`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--secret` (path, required): secret
- Output: list path `daemonsets`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`

### `dc container-management apps list-stateful-sets`

- Summary: List StatefulSets in a namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of workloads to search
  - `--phase` (query, default `WORKLOAD_STATE_UNSPECIFIED`, one of: WORKLOAD_STATE_UNSPECIFIED|Running|Deleting|Not_Ready|Stopped|Waiting): Phase represents the phase of workloads to search
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `revision`; pagination `offset`

### `dc container-management apps patch-daemon-set`

- Summary: PatchDaemonSet gets a daemonset under the namespaces of a specific cluster
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/daemonsets/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): The cluster which the deployment belongs to.
  - `--namespace` (path, required): The namespace which the deployment belongs to.
  - `--name` (path, required): The name of the deployment.

### `dc container-management apps patch-deployment`

- Summary: PatchDeployment patches a deployment under the namespaces of a
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): The cluster which the deployment belongs to.
  - `--namespace` (path, required): The namespace which the deployment belongs to.
  - `--name` (path, required): The name of the deployment.

### `dc container-management apps patch-stateful-set`

- Summary: PatchStatefulSet update a statefulSet under the namespaces of a specific
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): The cluster which the deployment belongs to.
  - `--namespace` (path, required): The namespace which the deployment belongs to.
  - `--name` (path, required): The name of the deployment.

### `dc container-management apps pause-deployment`

- Summary: PauseDeployment pauses a deployment under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}:pause`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--name` (path, required): Name represents the name of deployment

### `dc container-management apps restart-daemon-set`

- Summary: RestartDaemonSet restarts a daemonSets under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/daemonsets/{name}:restart`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified daemonset belongs to.
  - `--namespace` (path, required): Namespace the specified daemonset belongs to.
  - `--name` (path, required): Daemonset name.

### `dc container-management apps restart-deployment`

- Summary: RestartDeployment restarts a deployment under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}:restart`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--name` (path, required): Name represents the name of deployment

### `dc container-management apps restart-stateful-set`

- Summary: RestartStatefulSet restarts a statefulSet under the namespaces of a
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}:restart`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified statefulset belongs to.
  - `--namespace` (path, required): Namespace the specified statefulset belongs to.
  - `--name` (path, required): StatefulSet name.

### `dc container-management apps resume-deployment`

- Summary: ResumeDeployment resumes a deployment under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}:resume`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--name` (path, required): Name represents the name of deployment

### `dc container-management apps rollback-daemon-set`

- Summary: RollbackDaemonSet rollbacks a daemonSets under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/daemonsets/{name}:rollback`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified daemonset belongs to.
  - `--namespace` (path, required): Namespace the specified daemonset belongs to.
  - `--name` (path, required): Daemonset name.

### `dc container-management apps rollback-deployment`

- Summary: RollbackDeployment rollbacks a deployment under the namespaces of a
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}:rollback`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--name` (path, required): Name represents the name of deployment

### `dc container-management apps rollback-stateful-set`

- Summary: RollbackStatefulSet rollbacks a statefulSet under the namespaces of a
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}:rollback`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified statefulset belongs to.
  - `--namespace` (path, required): Namespace the specified statefulset belongs to.
  - `--name` (path, required): StatefulSet name.

### `dc container-management apps start-deployment`

- Summary: StartDeployment starts a deployment under the namespace of a specific cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}:start`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--name` (path, required): Name represents the name of deployment.

### `dc container-management apps start-stateful-set`

- Summary: StartStatefulSet starts a statefulset under the namespace of a specific cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}:start`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the statefulset belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the statefulset belongs to.
  - `--name` (path, required): Name represents the name of statefulset.

### `dc container-management apps stop-deployment`

- Summary: StopDeployment starts a deployment under the namespace of a specific cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}:stop`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--name` (path, required): Name represents the name of deployment.

### `dc container-management apps stop-stateful-set`

- Summary: StopStatefulSet starts a statefulset under the namespace of a specific cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}:stop`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the statefulset belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the statefulset belongs to.
  - `--name` (path, required): Name represents the name of statefulset.

### `dc container-management apps update-replica-set`

- Summary: UpdateReplicaSet updates a replicaset in specified namespace of a cluster
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/replicasets/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified replicaSet belongs to.
  - `--namespace` (path, required): Namespace the specified replicaSet belongs to.
  - `--name` (path, required): Name of the specified replicaSet.

### `dc container-management apps update-workload-by-json`

- Summary: UpdateWorkloadByJSON updates workload by JSON under the namespaces of a
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/{kind}/{name}/json`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the Workload belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the Workload belongs to.
  - `--kind` (path, required, one of: deployments|statefulsets|daemonsets|jobs|cronjobs|pods|replicasets): WorkloadKind the workload of kind
  - `--name` (path, required): Name represents the name of Workload

## Autoscaling

### `dc container-management autoscaling create-cluster-resource-override`

- Summary: CreateClusterResourceOverride creates a cro by given json.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterresourceoverride`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster defines the cluster name.

### `dc container-management autoscaling create-cron-horizontal-pod-autoscaler`

- Summary: CreateCronHorizontalPodAutoscaler creates a cron hpa by given json.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronhorizontalpodautoscalers`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified hpa belongs to.
  - `--namespace` (path, required): When the current namespace is named, the priority is higher than that in yaml

### `dc container-management autoscaling create-horizontal-pod-autoscaler`

- Summary: CreateHorizontalPodAutoscaler creates a hpa by given json.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/horizontalpodautoscalers`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified hpa belongs to.
  - `--namespace` (path, required): When the current namespace is named, the priority is higher than that in yaml

### `dc container-management autoscaling create-vertical-pod-autoscaler`

- Summary: CreateVerticalPodAutoscaler creates a vpa by given json.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/verticalpodautoscalers`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified vpa belongs to.
  - `--namespace` (path, required): Namespace of the vpa.

### `dc container-management autoscaling delete-cluster-resource-override`

- Summary: DeleteClusterResourceOverride deletes a cro by name.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterresourceoverride/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster defines the cluster name.
  - `--name` (path, required): name defines the name of ClusterResourceOverride.

### `dc container-management autoscaling delete-cron-horizontal-pod-autoscaler`

- Summary: DeleteCronHorizontalPodAutoscaler deletes a cron hpa by given name.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronhorizontalpodautoscalers/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the hpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced hpa.
  - `--name` (path, required): Name is the metadata.name of the referenced hpa.

### `dc container-management autoscaling delete-horizontal-pod-autoscaler`

- Summary: DeleteHorizontalPodAutoscaler deletes a hpa by given name.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/horizontalpodautoscalers/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the hpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced hpa.
  - `--name` (path, required): Name is the metadata.name of the referenced hpa.

### `dc container-management autoscaling delete-vertical-pod-autoscaler`

- Summary: DeleteVerticalPodAutoscaler deletes a vpa by given name.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/verticalpodautoscalers/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the vpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced vpa.
  - `--name` (path, required): Name is the metadata.name of the vpa.

### `dc container-management autoscaling get-cluster-resource-override`

- Summary: GetClusterResourceOverride gets a cro by name.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterresourceoverride/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster defines the cluster name.
  - `--name` (path, required): name defines the name of ClusterResourceOverride.

### `dc container-management autoscaling get-cron-horizontal-pod-autoscaler-json`

- Summary: GetCronHorizontalPodAutoscalerJSON gets the cron hpa by namespace and name,
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronhorizontalpodautoscalers/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the pod belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced HorizontalPodAutoscaler.
  - `--name` (path, required): HorizontalPodAutoscaler name.
  - `--stable` (query): If stable is true, the v2 version under the corresponding package will be returned.

### `dc container-management autoscaling get-horizontal-pod-autoscaler-json`

- Summary: GetHorizontalPodAutoscalerJSON gets the hpa by namespace and name,
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/horizontalpodautoscalers/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the pod belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced HorizontalPodAutoscaler.
  - `--name` (path, required): HorizontalPodAutoscaler name.
  - `--stable` (query): If stable is true, the v2 version under the corresponding package will be returned.

### `dc container-management autoscaling get-vertical-pod-autoscaler-json`

- Summary: GetVerticalPodAutoscalerJSON gets a vpa by namespace and name, returning a string in JSON format.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/verticalpodautoscalers/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the vpa belongs to.
  - `--namespace` (path, required): Namespace of the vpa.
  - `--name` (path, required): Name of the vpa.
  - `--stable` (query): If stable is true, the v2 version under the corresponding package will be returned.

### `dc container-management autoscaling list-cron-horizontal-pod-autoscalers`

- Summary: ListCronHorizontalPodAutoscalers lists cron hpas in the specified cluster and namespace.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronhorizontalpodautoscalers`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the hpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced hpa.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Deployment|StatefulSet|ReplicaSet): The kind of hpa targetRef.
  - `--name` (query): The workload name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management autoscaling list-custom-metric-summary`

- Summary: ListCustomMetricsSummary return the custom metrics for specified
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/custommetricsummary`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the custom metrics belongs to.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Pod|Service): The kind of hpa targetRef.
- Output: list path `items`

### `dc container-management autoscaling list-horizontal-pod-autoscalers`

- Summary: ListHorizontalPodAutoscalers lists hpas in the specified cluster and namespace.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/horizontalpodautoscalers`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the hpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced hpa.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Deployment|StatefulSet|ReplicaSet): The kind of hpa targetRef.
  - `--name` (query): The workload name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management autoscaling list-metric-values`

- Summary: ListMetricValueList returns a list of metrics values for a given
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/metricvalues`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the hpa belongs to.
  - `--namespace` (path, required): namespace
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Pod|Service): The kind of metrics.
  - `--kind-name` (query): kindName
  - `--name` (query): The exact name of metric.
- Output: list path `items`; columns `metricName`, `timestamp`, `value`

### `dc container-management autoscaling list-vertical-pod-autoscalers`

- Summary: ListVerticalPodAutoscalers lists vpas in the specified cluster and namespace.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/verticalpodautoscalers`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the vpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced vpa.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Deployment|StatefulSet|DaemonSet|ReplicaSet|Job|CronJob|ReplicationController): The kind of vpa targetRef.
  - `--kind-name` (query): The name of the targetRef.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management autoscaling update-cluster-resource-override`

- Summary: UpdateClusterResourceOverride updates a cro by given json.
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterresourceoverride`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster defines the cluster name.

### `dc container-management autoscaling update-cron-horizontal-pod-autoscaler`

- Summary: UpdateCronHorizontalPodAutoscaler updates the specified cron hpa, the body must
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronhorizontalpodautoscalers/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified hpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced hpa.
  - `--name` (path, required): name represents for the resource name

### `dc container-management autoscaling update-horizontal-pod-autoscaler`

- Summary: UpdateHorizontalPodAutoscaler updates the specified hpa, the body must
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/horizontalpodautoscalers/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified hpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced hpa.
  - `--name` (path, required): name represents for the resource name

### `dc container-management autoscaling update-vertical-pod-autoscaler`

- Summary: UpdateVerticalPodAutoscaler updates the specified vpa, the body must
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/verticalpodautoscalers/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified vpa belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced vpa.
  - `--name` (path, required): Name represents for the resource name.

## Batch

### `dc container-management batch delete-cron-job`

- Summary: DeleteCronJob deletes a cronJob under the namespaces of a specific cluster
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronjobs/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the cronjob belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the cronjob belongs to.
  - `--name` (path, required): Cronjob name.

### `dc container-management batch delete-job`

- Summary: DeleteJob deletes a job under the namespaces of a specific cluster
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/jobs/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified job belongs to.
  - `--namespace` (path, required): Namespace the specified job belongs to.
  - `--name` (path, required): Name of the job.

### `dc container-management batch get-cron-job`

- Summary: GetCronJob gets a cronJob under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronjobs/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the cronjob belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the cronjob belongs to.
  - `--name` (path, required): Cronjob name.
- Output: list path `images`

### `dc container-management batch get-job`

- Summary: GetJob gets a job under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/jobs/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified job belongs to.
  - `--namespace` (path, required): Namespace the specified service belongs to.
  - `--name` (path, required): Name of the job.

### `dc container-management batch list-all-cron-jobs`

- Summary: ListAllCronJobs lists all clusters cronjob
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/cronjobs`
- Auth: required
- Body: none
- Flags:
  - `--clusters` (query): Cluster the specified job belongs to.
  - `--namespace` (query): Namespace the specified service belongs to.
  - `--job-state` (query, default `JOB_STATE_UNSPECIFIED`, one of: JOB_STATE_UNSPECIFIED|Waiting|Running|Completed|Deleting|Failed): Job_state represents the current state of a job.
  - `--cronjob-state` (query, default `CRONJOB_STATE_UNSPECIFIED`, one of: CRONJOB_STATE_UNSPECIFIED|Waiting_CronJob|Activated_CronJob|Stopped_CronJob|Deleting_CronJob): cronjob_state represents the current state of a cron job.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): Name of the job.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--show-virtual-cluster` (query): ShowVirtualCluster is used to control whether to return data that belongs to a virtual cluster. Default false.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`, `availed`, `executionTimestamp`; pagination `offset`

### `dc container-management batch list-all-jobs`

- Summary: ListAllJobs lists all cluster jobs
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/jobs`
- Auth: required
- Body: none
- Flags:
  - `--clusters` (query): Cluster the specified job belongs to.
  - `--namespace` (query): Namespace the specified service belongs to.
  - `--job-state` (query, default `JOB_STATE_UNSPECIFIED`, one of: JOB_STATE_UNSPECIFIED|Waiting|Running|Completed|Deleting|Failed): Job_state represents the current state of a job.
  - `--cronjob-state` (query, default `CRONJOB_STATE_UNSPECIFIED`, one of: CRONJOB_STATE_UNSPECIFIED|Waiting_CronJob|Activated_CronJob|Stopped_CronJob|Deleting_CronJob): cronjob_state represents the current state of a cron job.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): Name of the job.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--show-virtual-cluster` (query): ShowVirtualCluster is used to control whether to return data that belongs to a virtual cluster. Default false.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`, `executionTimestamp`; pagination `offset`

### `dc container-management batch list-cluster-cron-jobs`

- Summary: ListClusterCronJobs lists cluster cronJobs under the namespaces of a
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronjobs`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified job belongs to.
  - `--namespace` (path, required): Namespace the specified service belongs to.
  - `--job-state` (query, default `JOB_STATE_UNSPECIFIED`, one of: JOB_STATE_UNSPECIFIED|Waiting|Running|Completed|Deleting|Failed): Job_state represents the current state of a job.
  - `--cronjob-state` (query, default `CRONJOB_STATE_UNSPECIFIED`, one of: CRONJOB_STATE_UNSPECIFIED|Waiting_CronJob|Activated_CronJob|Stopped_CronJob|Deleting_CronJob): cronjob_state represents the current state of a cron job.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): Name of the job.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`, `availed`, `executionTimestamp`; pagination `offset`

### `dc container-management batch list-cluster-jobs`

- Summary: ListClusterJobs list cluster jobs under the namespaces of a specific
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/jobs`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified job belongs to.
  - `--namespace` (path, required): Namespace the specified service belongs to.
  - `--job-state` (query, default `JOB_STATE_UNSPECIFIED`, one of: JOB_STATE_UNSPECIFIED|Waiting|Running|Completed|Deleting|Failed): Job_state represents the current state of a job.
  - `--cronjob-state` (query, default `CRONJOB_STATE_UNSPECIFIED`, one of: CRONJOB_STATE_UNSPECIFIED|Waiting_CronJob|Activated_CronJob|Stopped_CronJob|Deleting_CronJob): cronjob_state represents the current state of a cron job.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): Name of the job.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`, `executionTimestamp`; pagination `offset`

### `dc container-management batch list-cron-jobs`

- Summary: List CronJobs in a namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/cronjobs`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified job belongs to.
  - `--job-state` (query, default `JOB_STATE_UNSPECIFIED`, one of: JOB_STATE_UNSPECIFIED|Waiting|Running|Completed|Deleting|Failed): Job_state represents the current state of a job.
  - `--cronjob-state` (query, default `CRONJOB_STATE_UNSPECIFIED`, one of: CRONJOB_STATE_UNSPECIFIED|Waiting_CronJob|Activated_CronJob|Stopped_CronJob|Deleting_CronJob): cronjob_state represents the current state of a cron job.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): Name of the job.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`, `availed`, `executionTimestamp`; pagination `offset`

### `dc container-management batch list-jobs`

- Summary: List Jobs in a namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/jobs`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified job belongs to.
  - `--job-state` (query, default `JOB_STATE_UNSPECIFIED`, one of: JOB_STATE_UNSPECIFIED|Waiting|Running|Completed|Deleting|Failed): Job_state represents the current state of a job.
  - `--cronjob-state` (query, default `CRONJOB_STATE_UNSPECIFIED`, one of: CRONJOB_STATE_UNSPECIFIED|Waiting_CronJob|Activated_CronJob|Stopped_CronJob|Deleting_CronJob): cronjob_state represents the current state of a cron job.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): Name of the job.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`, `executionTimestamp`; pagination `offset`

### `dc container-management batch list-jobs-by-cron-jobs-name`

- Summary: ListJobsByCronJobsName lists Jobs By CronJobs's Name under the namespaces
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronjobs/{cronjob}/jobs`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the cronjob belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the cronjob belongs to.
  - `--cronjob` (path, required): Cronjob name.
  - `--phase` (query): Represents the current state of a cron job.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the job list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the job list order.
  - `--name` (query): Cronjob name.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`, `executionTimestamp`; pagination `offset`

### `dc container-management batch pause-cron-job`

- Summary: PauseCronJob pauses a cronjob under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronjobs/{name}:pause`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the cronjob belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the cronjob belongs to.
  - `--name` (path, required): Name represents the name of cronjob

### `dc container-management batch restart-job`

- Summary: RestartJob restarts a job under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/jobs/{name}:restart`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified job belongs to.
  - `--namespace` (path, required): Namespace the specified job belongs to.
  - `--name` (path, required): Name of the job.

### `dc container-management batch resume-cron-job`

- Summary: ResumeCronJob resumes a cronjob under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronjobs/{name}:resume`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the cronjob belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the cronjob belongs to.
  - `--name` (path, required): Name represents the name of cronjob

## CloudShell

### `dc container-management cloudshell create-cloud-shell`

- Summary: CreateCloudShell create a cloudshell in golobal cluster.
- HTTP: `POST /apis/kpanda.io/v1alpha1/cloudshells`
- Auth: required
- Body: required
- Flags: none

### `dc container-management cloudshell delete-cloud-shell`

- Summary: DeleteCloudShell delete a cloudshell in golobal cluster.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/cloudshells/{name}`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): name specified the cloudshell name.

### `dc container-management cloudshell get-cloud-shell`

- Summary: GetCloudShell get a cloudshell in golobal cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/cloudshells/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name specified the cloudshell name.

## Cluster

### `dc container-management cluster create-cluster`

- Summary: Register or create a cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters`
- Auth: required
- Body: required
- Flags: none
- Example: `dc container-management cluster create-cluster --file cluster.json`

### `dc container-management cluster create-open-api-cluster-cert`

- Summary: CreateOpenAPIClusterCert creates openAPI cluster cert
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/clustercert`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): one of cluster or kubeSystemID has value

### `dc container-management cluster create-open-api-cluster-cert-by-kube-system-id`

- Summary: CreateOpenAPIClusterCertByKubeSystemID creates openAPI cluster cert by
- HTTP: `POST /apis/kpanda.io/v1alpha1/kubesystemid/{kubeSystemID}/clustercert`
- Auth: required
- Body: required
- Flags:
  - `--kube-system-id` (path, required): kubeSystemID is the cluster system ID.

### `dc container-management cluster delete-cluster`

- Summary: Remove a cluster from management
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{name}`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): Name is the user-specified identifier.

### `dc container-management cluster edit-cluster-labels`

- Summary: EditClusterLabels edits the specified cluster's labels
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{name}/labels`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): Name is the user-specified identifier.

### `dc container-management cluster get-cluster`

- Summary: Get cluster details
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): Name is the user-specified identifier.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--status` (query): Status represents the current state of cluster.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--exclude-metrics` (query): exclude_metrics
- Output: pagination `offset`
- Example: `dc container-management cluster get-cluster --name prod-cluster`

### `dc container-management cluster get-cluster-kube-config`

- Summary: Download kubeconfig for a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/kubeconfig`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
- Example: `dc container-management cluster get-cluster-kube-config --cluster prod-cluster -o raw > kubeconfig.yaml`

### `dc container-management cluster list-all-cluster-gpu`

- Summary: ListClusters lists kpanda cr resources
- HTTP: `GET /apis/kpanda.io/v1alpha1/gpus`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `uuid`, `modelName`, `memory`

### `dc container-management cluster list-cluster-preferred-resources`

- Summary: Cluster_ListClusterPreferredResources
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/preferredresources`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster belongs to.
  - `--namespaced` (query): namespaced indicates whether this resource is cluster or namespace scoped.
- Output: list path `resources`; columns `groupVersion`

### `dc container-management cluster list-cluster-summary`

- Summary: List cluster summary (lightweight)
- HTTP: `GET /apis/kpanda.io/v1alpha1/clustersummary`
- Auth: required
- Body: none
- Flags:
  - `--show-virtual-cluster` (query): ShowVirtualCluster is used to control whether returned data contains
  - `--filter-by-strategy` (query): FilterByStrategy is to list all the clusters without strategies if true, default false.
  - `--filter-by-snapshot` (query): FilterBySnapshot is to list all the clusters which has snapshot if true, default false.
  - `--show-shim-cluster` (query): ShowShimCluster is used to control whether returned clusters contain shim cluster, default false.
- Output: list path `clusterSummary`; columns `name`, `phase`, `kubeSystemID`

### `dc container-management cluster list-clusters`

- Summary: List all managed clusters
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters`
- Auth: required
- Body: none
- Flags:
  - `--name` (query): Name is the user-specified identifier.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--role` (query, default `CLUSTER_ROLE_UNSPECIFIED`, one of: CLUSTER_ROLE_UNSPECIFIED|CLUSTER_ROLE_MANAGER|CLUSTER_ROLE_GLOBAL_SERVICE|CLUSTER_ROLE_WORKER|CLUSTER_ROLE_THIRD_PARTY): role
  - `--kubernetes-version` (query): KUBERNETESVERSION cluster k8s version use to support search sub cluster at
  - `--phase` (query, default `CLUSTER_PHASE_UNSPECIFIED`, one of: CLUSTER_PHASE_UNSPECIFIED|Unknown|Creating|Running|Updating|Deleting|Failed|DeleteFailed): Phase is used for filter.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter clusters.
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter the clusters.
  - `--managed-by` (query): ManagedBy represents who manages the cluster
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the cluster list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the cluster list order.
  - `--show-virtual-cluster` (query): ShowVirtualCluster is used to control whether returned data contains
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by cluster name or cluster alias name.
  - `--exclude-metrics` (query): exclude_metrics
  - `--show-shim-cluster` (query): ShowShimCluster is used to control whether returned clusters contain shim cluster, default false.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `spec.provider`, `spec.region`, `metadata.creationTimestamp`; pagination `offset`
- Example:

```
dc container-management cluster list-clusters
dc container-management cluster list-clusters -o json | jq '.items[].name'
```

### `dc container-management cluster update-clusters`

- Summary: Update cluster configuration
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{name}`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): Name is the user-specified identifier.

### `dc container-management cluster validate-cluster`

- Summary: ValidateCluster checks if residuals which affect integrating exist in a cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{name}/validate`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): Name is the user-specified identifier.

### `dc container-management cluster validate-kube-config`

- Summary: Validate a kubeconfig before registration
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/validate`
- Auth: required
- Body: required
- Flags: none

## ClusterSetting

### `dc container-management clustersetting disable-plugin`

- Summary: Disable a plugin so that it can be shown by the frontend.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/settings/plugins/{name}:disable`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The cluster name of the clustersetting.
  - `--name` (path, required, one of: PLUGIN_NAME_UNSPECIFIED|HPA|Insight|GPU|METALLB|Spiderpool|CustomMetrics|CronHPA|VPA|Hwameistor|Flannel|KubeOvn|OLM|EgressGateway|Snapshot|DRA): The name of the plugin which needs to disable.

### `dc container-management clustersetting enable-plugin`

- Summary: Enable a plugin so that it can be shown by the frontend.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/settings/plugins/{name}:enable`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): The cluster name of the clustersetting.
  - `--name` (path, required, one of: PLUGIN_NAME_UNSPECIFIED|HPA|Insight|GPU|METALLB|Spiderpool|CustomMetrics|CronHPA|VPA|Hwameistor|Flannel|KubeOvn|OLM|EgressGateway|Snapshot|DRA): The name of the plugin which needs to enable.

### `dc container-management clustersetting get-cluster-setting`

- Summary: Gets the setting under a given cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/settings`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The cluster name of the clustersetting.
- Output: list path `network`; columns `name`, `enabled`, `externalAddress`, `healthy`, `intelligentDetection`, `setting`

### `dc container-management clustersetting list-gpu-setting`

- Summary: ClusterSetting_ListGPUSetting
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/settings/gpu`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The cluster name of the clustersetting.
  - `--available-enable` (query): if available_enable is true will return available gpu number
- Output: list path `items`; columns `type`, `alias`, `isDynamic`

### `dc container-management clustersetting list-plugins`

- Summary: Lists plugins under a given cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/settings/plugins`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The cluster name of the clustersetting.
- Output: list path `data`; columns `name`, `enabled`, `externalAddress`, `healthy`, `intelligentDetection`, `setting`

### `dc container-management clustersetting update-cluster-setting`

- Summary: UpdateClusterSetting will update the cluster setting and returns the settings
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/settings`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): one of cluster or kubeSystemID has value
- Output: list path `network`; columns `name`, `enabled`, `externalAddress`, `healthy`, `intelligentDetection`, `setting`

## Clusterlcm

### `dc container-management clusterlcm batch-add-node`

- Summary: Clusterlcm_BatchAddNode
- HTTP: `POST /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/nodes`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster

### `dc container-management clusterlcm check-cluster`

- Summary: Clusterlcm_CheckCluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/cluster-lcm/{name}:check`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): name

### `dc container-management clusterlcm create-cluster`

- Summary: Register or create a cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/cluster-lcm`
- Auth: required
- Body: required
- Flags: none
- Example: `dc container-management cluster create-cluster --file cluster.json`

### `dc container-management clusterlcm delete-clusterlcm-ops`

- Summary: Clusterlcm_DeleteClusterlcmOps
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/ops/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The name of the manger cluster.
  - `--name` (path, required): The name of the cluster which needs to be create.

### `dc container-management clusterlcm get-clusterlcm-ops`

- Summary: Clusterlcm_GetClusterlcmOps
- HTTP: `GET /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/ops/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The name of the cluster.
  - `--name` (path, required): The name of the clusterclmOps.

### `dc container-management clusterlcm get-clusterlcm-ops-json`

- Summary: Clusterlcm_GetClusterlcmOpsJSON
- HTTP: `GET /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/ops/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The name of the cluster.
  - `--name` (path, required): The name of the clusterclmOps.

### `dc container-management clusterlcm get-clusterlcm-settings`

- Summary: Clusterlcm_GetClusterlcmSettings
- HTTP: `GET /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/settings`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The name of the cluster which needs to be create.
- Output: list path `preinstallAddons`; columns `repoUrl`

### `dc container-management clusterlcm get-pre-check-cluster-info`

- Summary: Clusterlcm_GetPreCheckClusterInfo
- HTTP: `POST /apis/kpanda.io/v1alpha1/cluster-lcm/{name}/precheck-infos`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): The name of the cluster which needs to be create.

### `dc container-management clusterlcm list-cluster-upgrade-histories`

- Summary: Clusterlcm_ListClusterUpgradeHistories
- HTTP: `GET /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/upgrade-histories`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--target-cluster` (query): targetCluster
- Output: list path `upgradeHistories`; columns `phase`, `changeTime`, `kubeVersion`

### `dc container-management clusterlcm list-clusterlcm-ops`

- Summary: Clusterlcm_ListClusterlcmOps
- HTTP: `GET /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/ops`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): The name of the cluster.
  - `--name` (query): The fuzzy-name of the clusterclmOps.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): SortDir determines the order of the data.
  - `--target-cluster` (query): targetCluster
  - `--action` (query, default `ACTION_UNSPECIFIED`, one of: ACTION_UNSPECIFIED|CREATE_CLUSTER|UPGRADE_CLUSTER|RESET_CLUSTER|ADD_NODE|REMOVE_NODE): action
  - `--phase` (query, default `STATUS_UNSPECIFIED`, one of: STATUS_UNSPECIFIED|Running|Succeeded|Failed|Blocked): phase
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by cluster name or cluster alias name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management clusterlcm list-kube-versions`

- Summary: Clusterlcm_ListKubeVersions
- HTTP: `GET /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/available-kube-versions`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
- Output: list path `kubernetesVersions`

### `dc container-management clusterlcm list-runtime-versions`

- Summary: Clusterlcm_ListRuntimeVersions
- HTTP: `GET /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/available-runtime-versions`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--kube-version` (query): kubeVersion
- Output: list path `containerdVersions`

### `dc container-management clusterlcm pre-check-cluster`

- Summary: Clusterlcm_PreCheckCluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/cluster-lcm/{name}:precheck`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): The name of the cluster which needs to be create.

### `dc container-management clusterlcm remove-node`

- Summary: Clusterlcm_RemoveNode
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/cluster-lcm/{cluster}/nodes/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--name` (path, required): name

### `dc container-management clusterlcm reset-cluster`

- Summary: Clusterlcm_ResetCluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/cluster-lcm/{name}:reset`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): name

### `dc container-management clusterlcm upgrade-cluster`

- Summary: Clusterlcm_UpgradeCluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/cluster-lcm/{name}:upgrade`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): The name of the cluster which needs to upgrade.

## Core

### `dc container-management core batch-bind-node-to-namespace`

- Summary: BatchBindNodeToNamespace makes the specified node to exclusive.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes:batchBindNamespace`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster is the cluster for namespace and node.
- Output: list path `failedResults`; columns `error`, `nodeName`

### `dc container-management core compute-limit-range`

- Summary: ComputeLimitRange returns the final effective quota detail of multi limit range in specified namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/limitranges:compute`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified LimitRange belongs to.
  - `--namespace` (path, required): Namespace the specified LimitRange belongs to.

### `dc container-management core compute-resource-quota`

- Summary: ComputeResourceQuota returns the final effective quota detail of multi quotas in specified namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/resourcequotas:compute`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified resourceQuotas belongs to.
  - `--namespace` (path, required): Namespace the specified resourceQuotas belongs to.

### `dc container-management core cordon-node`

- Summary: CordonNode makes the specified node to unschedulable.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/cordon`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified node belongs to.
  - `--node` (path, required): Node name.

### `dc container-management core create-config-map`

- Summary: CreateConfigMap creates a configMap under the namespaces of a specific
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/configmaps`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified configmap belongs to.
  - `--namespace` (path, required): When the current namespace is named, the priority is higher than that in yaml

### `dc container-management core create-limit-range`

- Summary: CreateLimitRange creates a limitrange in the specified cluster and namespace.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/limitranges`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified limitRange belongs to.
  - `--namespace` (path, required): Namespace the specified limitRange belongs to.

### `dc container-management core create-namespace`

- Summary: CreateNamespace creates a namespace from the system by given namespace name
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster the specified namespace belongs to.

### `dc container-management core create-persistent-volume`

- Summary: CreatePersistentVolume creates a persistentvolume to the system by given persistentvolume data
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/persistentvolumes`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified persistentVolume belongs to.

### `dc container-management core create-persistent-volume-claim`

- Summary: CreatePersistentVolumeClaim create persistent volume claim
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of PVC to belongs to.
  - `--namespace` (path, required): namespace represents the namespace of PVC to belongs to.

### `dc container-management core create-resource-quota`

- Summary: CreateResourceQuota creates a resourceQuota to the system by given resourceQuota data
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/resourcequotas`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified resourceQuota belongs to.
  - `--namespace` (path, required): Namespace the specified resourceQuota belongs to.

### `dc container-management core create-secret`

- Summary: CreateSecret creates a secret under the namespaces of a specific cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/secrets`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the secret belongs to.
  - `--namespace` (path, required): When the current namespace is named, the priority is higher than that in yaml

### `dc container-management core create-service`

- Summary: CreateService creates a service to the system by given service data
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/services`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified service belongs to.
  - `--namespace` (path, required): When the current namespace is named, the priority is higher than that in

### `dc container-management core create-service-account`

- Summary: CreateServiceAccount creates a sa from the system by given sa name
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/serviceaccounts`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents the cluster of ServiceAccount to belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced pod.

### `dc container-management core delete-config-map`

- Summary: DeleteConfigMap deletes a configMap under the namespaces of a specific
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/configmaps/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the configmap belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ConfigMap.
  - `--name` (path, required): Name is the metadata.name of the referenced ConfigMap.

### `dc container-management core delete-limit-range`

- Summary: DeleteLimitRange deletes the limitrange by name.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/limitranges/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the LimitRange belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced LimitRange.
  - `--name` (path, required): Name represents for the LimitRange name.

### `dc container-management core delete-namespace`

- Summary: DeleteNamespace deletes a namespace from the system by given namespace name
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified namespace belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management core delete-persistent-volume`

- Summary: DeletePersistentVolume deletes a persistentvolume from the system by given persistentvolume name
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/persistentvolumes/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the PersistentVolume belongs to.
  - `--name` (path, required): Name represents for the PersistentVolume name.

### `dc container-management core delete-persistent-volume-claim`

- Summary: DeletePersistentVolumeClaim delete the specified pvc
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of PVC to belongs to.
  - `--namespace` (path, required): namespace represents the namespace of PVC to belongs to.
  - `--name` (path, required): name represents the name of PVC to belongs to.

### `dc container-management core delete-pod`

- Summary: DeletePod deletes a pod under the namespaces of a specific cluster
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the pod belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced pod.
  - `--name` (path, required): Pod name.

### `dc container-management core delete-secret`

- Summary: DeleteSecret deletes a secret under the namespaces of a specific cluster
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/secrets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the secret belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced secret.
  - `--name` (path, required): Secret name.

### `dc container-management core delete-service`

- Summary: DeleteService deletes a service from the system by given service name
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/services/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the service belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced service.
  - `--name` (path, required): Name represents for the service name

### `dc container-management core delete-service-account`

- Summary: DeleteServiceAccount deletes a sa from the system by given sa name
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/serviceaccounts/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the ServiceAccount belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced pod.
  - `--name` (path, required): Name represents the name of StorageClass

### `dc container-management core disable-namespace-pod-security`

- Summary: DisableNamespacePodSecurity enables pod security policy of a namespace
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}/podsecurity:disable`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster of the namespace.
  - `--name` (path, required): Name represents for the resource name.

### `dc container-management core enable-namespace-pod-security`

- Summary: EnableNamespacePodSecurity enables pod security policy of a namespace
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}/podsecurity:enable`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster of the namespace.
  - `--name` (path, required): Name represents for the resource name.

### `dc container-management core get-config-map`

- Summary: GetConfigMap gets a configMap under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/configmaps/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the configmap belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ConfigMap.
  - `--name` (path, required): name represents for the resource name

### `dc container-management core get-config-map-json`

- Summary: GetConfigMapJSON gets a configMap json under the namespaces of a specific
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/configmaps/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the configmap belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ConfigMap.
  - `--name` (path, required): name represents for the resource name

### `dc container-management core get-limit-range`

- Summary: GetLimitRange gets the limitrange by namespace and name.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/limitranges/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified limitRange belongs to.
  - `--namespace` (path, required): Namespace the specified limitRange belongs to.
  - `--name` (path, required): Name of the specified limitRange.

### `dc container-management core get-limit-range-json`

- Summary: GetLimitRangeJSON gets the limitrange by namespace and name, returns a string in JSON format.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/limitranges/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified limitRange belongs to.
  - `--namespace` (path, required): Namespace the specified limitRange belongs to.
  - `--name` (path, required): Name represents for the limitRange name.

### `dc container-management core get-namespace`

- Summary: GetNamespace gets a namespace from the system by given namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the namespace belongs to.
  - `--name` (path, required): Node name.

### `dc container-management core get-namespace-json`

- Summary: GetNamespaceJSON gets a namespace json from the system by given namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the namespace belongs to.
  - `--name` (path, required): Name represents for the requested namespace name.

### `dc container-management core get-node`

- Summary: GetNode gets a node from the system by given node name
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the node belongs to.
  - `--name` (path, required): Node name.
  - `--show-pods` (query): ShowPods is to control whether returned data contains
  - `--exclude-metrics` (query): exclude_metrics

### `dc container-management core get-node-gpu-stats`

- Summary: GetNodeGPUStats get node gpu stats
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/gpu-stats`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--node` (path, required): node

### `dc container-management core get-node-json`

- Summary: GetNodeJSON gets a node's json from the system by given node name
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified node belongs to.
  - `--name` (path, required): Name represents for the node name.

### `dc container-management core get-persistent-volume`

- Summary: GetPersistentVolume gets a persistentvolume from the system by given persistentvolume name
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/persistentvolumes/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified persistentVolume belongs to.
  - `--name` (path, required): Name of the specified persistentVolume.

### `dc container-management core get-persistent-volume-claim`

- Summary: GetPersistentVolumeClaim gets a pvc from the system by given pvc-name;
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the PVC belongs to.
  - `--name` (path, required): Name represents the name of PVC to search

### `dc container-management core get-persistent-volume-claim-json`

- Summary: GetPersistentVolumeClaimJSON get the specified pvc's JSON
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the PVC belongs to.
  - `--name` (path, required): Name represents the name of PVC to search

### `dc container-management core get-persistent-volume-json`

- Summary: GetPersistentVolumeJSON gets a persistentvolume json from the system by given persistentvolume name
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/persistentvolumes/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified persistentVolume belongs to.
  - `--name` (path, required): Name represents for the persistentVolume name.

### `dc container-management core get-pod`

- Summary: GetPods will get a pod under the namespaces of a specific cluster by pods
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the pod belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced pod.
  - `--name` (path, required): Pod name.

### `dc container-management core get-resource-quota`

- Summary: GetResourceQuota gets a resourceQuota from the system by given resourceQuota name
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/resourcequotas/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified resourceQuota belongs to.
  - `--namespace` (path, required): Namespace the specified resourceQuota belongs to.
  - `--name` (path, required): Name of the specified resourceQuota.

### `dc container-management core get-resource-quota-json`

- Summary: GetResourceQuotaJSON gets a resourceQuota json from the system by given resourceQuota name
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/resourcequotas/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified resourceQuota belongs to.
  - `--namespace` (path, required): Namespace the specified resourceQuota belongs to.
  - `--name` (path, required): Name represents for the resourceQuota name.

### `dc container-management core get-secret`

- Summary: GetClusterSecret gets a secret under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/secrets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the secret belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced secret.
  - `--name` (path, required): Secret name.

### `dc container-management core get-secret-json`

- Summary: GetSecretJSON gets a secret json under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/secrets/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the secret belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced secret.
  - `--name` (path, required): Secret name.

### `dc container-management core get-service`

- Summary: GetService gets a service from the system by given service name
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/services/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified service belongs to.
  - `--namespace` (path, required): Namespace the specified service belongs to.
  - `--name` (path, required): Name represents for the service name.

### `dc container-management core get-service-account`

- Summary: GetServiceAccount gets a sa from the system by given sa
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/serviceaccounts/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC to belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ServiceAccount.
  - `--name` (path, required): name represents the name of ServiceAccount to belongs to.

### `dc container-management core get-service-json`

- Summary: GetServiceJSON gets a service json from the system by given service name
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/services/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified service belongs to.
  - `--namespace` (path, required): Namespace the specified service belongs to.
  - `--name` (path, required): Name represents for the service name.

### `dc container-management core list-all-pods`

- Summary: ListAllPods will list all pod by given cluster and namespace,
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster represents the pods belongs to, it is a array
  - `--namespace` (query): Namespace is the metadata.namespace of the referenced pod.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): Name is used for filter.
  - `--phase` (query, default `PHASE_UNSPECIFIED`, one of: PHASE_UNSPECIFIED|Unknown|Pending|Running|Succeeded|Failed): Phases is used for filter.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-cluster-config-maps`

- Summary: ListClusterConfigMaps lists all configmaps in the specified cluster,
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/configmaps`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified configmap belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the event list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): name is used for query.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--only-metadata` (query): OnlyMetadata lists only metadata of configmaps, default false.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `immutable`; pagination `offset`

### `dc container-management core list-cluster-event-kinds`

- Summary: ListClusterEventKinds lists all involvedObject's kinds of events in the
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/events/kinds`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the events belongs to.
- Output: list path `data`

### `dc container-management core list-cluster-events`

- Summary: ListClusterEvents lists all events in the specified cluster,
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/events`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the events belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--type` (query): Type is used for query, showing events of specified type.
  - `--kind` (query): Kind is used for query, showing events of specified involvedObject kind,
  - `--name` (query): Name is used for query, showing events of specified involvedObject name,
- Output: list path `items`; columns `type`, `firstTimestamp`, `lastTimestamp`, `message`, `reason`; pagination `offset`

### `dc container-management core list-cluster-gpu-summary`

- Summary: ListClusterGPUSummary lists gpu summary of all nodes of the specified cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/gpusummary`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster defines the cluster name.
- Output: list path `summary`; columns `node`

### `dc container-management core list-cluster-limit-ranges`

- Summary: ListClusterLimitRanges lists all limitranges in the specified cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/limitranges`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified LimitRange belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the LimitRange list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the LimitRange list order.
  - `--name` (query): Name is used for fuzzy search.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter.
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by cluster name or cluster alias name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-cluster-namespace-summary`

- Summary: ListClusterNamespaceSummary gets a list of namespace simple information
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespacesummary`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the namespace summary list belong to.
  - `--phase` (query, default `NAMESPACE_PHASE_UNSPECIFIED`, one of: NAMESPACE_PHASE_UNSPECIFIED|Active|Terminating): Phases is used for filter.
- Output: list path `data`; columns `name`, `phase`, `cluster`

### `dc container-management core list-cluster-namespaces`

- Summary: List all namespaces across a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the namespace list belong to.
  - `--workspace-id` (query, int32): workspace_id the specified namespace belongs to.
  - `--workspace-alias` (query): workspace_alias the specified namespace belongs to.
  - `--name` (query): Name is to filter namespaces by namespace name
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the job list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the job list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by cluster name or cluster alias name.
  - `--phase` (query, default `NAMESPACE_PHASE_UNSPECIFIED`, one of: NAMESPACE_PHASE_UNSPECIFIED|Active|Terminating): Phases is used for filter.
  - `--exclude-system` (query): ExcludeSystem determines to exclude system namespaces, defaults to False.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-cluster-node-summary`

- Summary: ListClusterNodeSummary lists the node summary in specified cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodesummary`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
- Output: list path `data`; columns `name`, `phase`, `creationTimestamp`, `uid`, `podCIDR`, `unschedulable`

### `dc container-management core list-cluster-persistent-volume-claims`

- Summary: ListPersistentVolumeClaims gets the pvcs from the system
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/persistentvolumeclaims`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC to belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): Name is used for filter.
  - `--phase` (query): Phase is used for filter.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--access-mode` (query, default `PERSISTENT_VOLUME_ACCESS_MODE_UNSPECIFIED`, one of: PERSISTENT_VOLUME_ACCESS_MODE_UNSPECIFIED|ReadWriteOnce|ReadOnlyMany|ReadWriteMany|ReadWriteOncePod): AccessMode is used searching PVC by accessMode.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-cluster-pods`

- Summary: ListClusterPods will list all pod by given cluster and regardless of
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the pod belongs to.
  - `--namespace` (query): Namespace is the metadata.namespace of the referenced pod.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): Name is used for filter.
  - `--phase` (query, default `PHASE_UNSPECIFIED`, one of: PHASE_UNSPECIFIED|Unknown|Pending|Running|Succeeded|Failed): Phases is used for filter.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--status` (query, default `FILTER_POD_STATUS_UNSPECIFIED`, one of: FILTER_POD_STATUS_UNSPECIFIED|FILTER_POD_STATUS_RUNNING|FILTER_POD_STATUS_ERROR|FILTER_POD_STATUS_COMPLETED|FILTER_POD_STATUS_WAITING): status is filter with pod status ,the status is composite state
  - `--exclude-metrics` (query): exclude_metrics
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
  - `--pod-ip` (query): pod_ip is used for filter.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-cluster-secrets`

- Summary: ListClusterSecrets lists a secret in a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/secrets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the secret belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): The name use to search specific secret
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--type` (query): Type is used to filter secrets by type.
  - `--only-metadata` (query): OnlyMetadata lists only metadata of secrets, default false.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `type`, `metadata.creationTimestamp`, `immutable`; pagination `offset`

### `dc container-management core list-cluster-services`

- Summary: ListClusterServices lists all services in the specified cluster, regardless
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/services`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified service belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the service list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the service list order.
  - `--name` (query): Name is used for query.
  - `--type` (query): Type is a array used for frontend filter.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--ports` (query): Ports is used to filter by port.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-cluster-sriov-allocated-resources`

- Summary: Core_ListClusterSriovAllocatedResources
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/sriovnodesresources`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
- Output: list path `allocatedResources`; columns `resourceName`, `value`

### `dc container-management core list-config-maps`

- Summary: ListConfigMaps lists configmaps in the specified cluster and namespace.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/configmaps`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the configmap belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ConfigMap.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--name` (query): name is used for query.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--only-metadata` (query): OnlyMetadata lists only metadata of configmaps, default false.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `immutable`; pagination `offset`

### `dc container-management core list-containers-by-pod`

- Summary: ListContainersByPod lists containers under the namespaces of a specific
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}/containers`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of pod belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the pod belongs to.
  - `--name` (path, required): Name represents the name of pod to search
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
- Output: list path `items`; columns `name`, `phase`, `image`, `ready`, `restartCount`, `started`; pagination `offset`

### `dc container-management core list-events`

- Summary: ListEvents lists events under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/events`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of deployment belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the deployment belongs to.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Deployment|StatefulSet|DaemonSet|Pod|Service|Ingress|Job|CronJob|HorizontalPodAutoscaler|ReplicaSet|CronHPA|PersistentVolumeClaim|GroupVersionResource): Kind represents what type of event is needed.
  - `--kind-name` (query): The name of involvedObject.
  - `--name` (query): Name stands for event name, used for fuzzy search.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the event list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the event list order.
  - `--type` (query): Type is used for query, showing events of specified type.
  - `--group` (query): resource group,used when the kind type is GroupVersionResource.
  - `--version` (query): resource version,used when the kind type is GroupVersionResource.
  - `--resource` (query): resource name,used when the kind type is GroupVersionResource.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
- Output: list path `items`; columns `type`, `firstTimestamp`, `lastTimestamp`, `message`, `reason`; pagination `offset`

### `dc container-management core list-limit-ranges`

- Summary: ListLimitRanges lists all limitranges in the specified cluster and namespace.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/limitranges`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the LimitRanges belongs to.
  - `--namespace` (path, required): Namespace the LimitRanges belongs to.
  - `--name` (query): Name stands for LimitRange name, used for fuzzy search.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the LimitRange list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the LimitRange list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter.
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by cluster name or cluster alias name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-namespaces`

- Summary: List namespaces in a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/namespaces`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Clusters is to filter namespaces by cluster names
  - `--workspace-id` (query, int32): workspace_id the specified namespace belongs to.
  - `--workspace-alias` (query): workspace_alias the specified namespace belongs to.
  - `--name` (query): Name is to filter namespaces by namespace name
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the job list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the job list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--only-unassign` (query): Only_unassign is used to distinguish workspaces that are not assigned.
  - `--exclude-system` (query): ExcludeSystem determines to exclude system namespaces, defaults to False.
  - `--show-virtual-cluster` (query): ShowVirtualCluster is used to control whether to return data that belongs to a virtual cluster. Default false.
  - `--include-resource-quota` (query): IncludeQuota used to control whether return namespace resource quota, default false.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`
- Example: `dc container-management core list-namespaces --cluster prod-cluster`

### `dc container-management core list-node-gpu`

- Summary: listNodeGPU gets all the gpu info with cluster node
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/gpus`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--node` (path, required): node
- Output: list path `items`; columns `name`, `uid`, `gpuMode`

### `dc container-management core list-nodes`

- Summary: ListNodes lists the node in specified cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the node belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--phase` (query): Phase represents the current phase of node.
  - `--node-ip` (query): nodeIp represents node's ip address
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the job list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the job list order.
  - `--name` (query): Name is to filter nodes by node name
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--role` (query, default `NODE_ROLE_UNSPECIFIED`, one of: NODE_ROLE_UNSPECIFIED|CONTROL_PLANE|WORKER): Role is used for filter by node role.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--exclude-metrics` (query): exclude_metrics
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-persistent-volume-claims`

- Summary: List PersistentVolumeClaims in a namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC to belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the PVC belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): Name is used for fuzzy search by name.
  - `--phase` (query): Phases is used for fuzzy search by phase.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--access-mode` (query, default `PERSISTENT_VOLUME_ACCESS_MODE_UNSPECIFIED`, one of: PERSISTENT_VOLUME_ACCESS_MODE_UNSPECIFIED|ReadWriteOnce|ReadOnlyMany|ReadWriteMany|ReadWriteOncePod): - PERSISTENT_VOLUME_ACCESS_MODE_UNSPECIFIED: This is only a meaningless placeholder, to avoid zero not return.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-persistent-volumes`

- Summary: List PersistentVolumes in a cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/persistentvolumes`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the PersistentVolumes belongs to.
  - `--name` (query): Name stands for PersistentVolume name, used for fuzzy search.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the PersistentVolume list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the PersistentVolume list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter.
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by cluster name or cluster alias name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-pods`

- Summary: ListPods will list all pod by given cluster and namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the pod belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced pod.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Deployment|StatefulSet|DaemonSet|Service|Job|CronJob|ReplicaSet|NetworkPolicy): The kind of pod.
  - `--kind-name` (query): Name of kind.
  - `--name` (query): Name stands for pod name, used for fuzzy search.
  - `--phase` (query, default `PHASE_UNSPECIFIED`, one of: PHASE_UNSPECIFIED|Unknown|Pending|Running|Succeeded|Failed): Phases is used for filter.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--status` (query, default `FILTER_POD_STATUS_UNSPECIFIED`, one of: FILTER_POD_STATUS_UNSPECIFIED|FILTER_POD_STATUS_RUNNING|FILTER_POD_STATUS_ERROR|FILTER_POD_STATUS_COMPLETED|FILTER_POD_STATUS_WAITING): status is filter with pod status ,the status is composite state
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
  - `--pod-ip` (query): pod_ip is used for filter.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-pods-by-node`

- Summary: ListPodsByNode lists pods info by given node in a specific
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the node belongs to.
  - `--node` (path, required): Node represents which node the pod belongs to.
  - `--name` (query): Name is to filter pods by pod name
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the job list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the job list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--status` (query, default `FILTER_POD_STATUS_UNSPECIFIED`, one of: FILTER_POD_STATUS_UNSPECIFIED|FILTER_POD_STATUS_RUNNING|FILTER_POD_STATUS_ERROR|FILTER_POD_STATUS_COMPLETED|FILTER_POD_STATUS_WAITING): status is filter with pod status ,the status is composite state
  - `--gpu-type` (query): gpu_type is filter with pods resources, when value is * search all
  - `--pod-ip` (query): pod_ip is used for filter.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-resource-quotas`

- Summary: ListResourceQuotas lists quotas in specified namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/resourcequotas`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the ResourceQuotas belongs to.
  - `--namespace` (path, required): Namespace the ResourceQuotas belongs to.
  - `--name` (query): Name stands for ResourceQuota name, used for name fuzzy search.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the ResourceQuota list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the ResourceQuota list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter.
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by cluster name or cluster alias name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-secrets`

- Summary: ListSecrets lists a secret under the namespaces of a specific cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/secrets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the secret belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced secret.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): The name use to search specific secret
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--type` (query): Type is used to filter secrets by type.
  - `--only-metadata` (query): OnlyMetadata lists only metadata of secrets, default false.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `type`, `metadata.creationTimestamp`, `immutable`; pagination `offset`

### `dc container-management core list-service-accounts`

- Summary: ListNamespaces gets all the namespaces across clusters
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/serviceaccounts`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of sa to belongs to.
  - `--namesapce` (query): Namespace is the current namespace.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): Name is used for filter.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core list-services`

- Summary: ListServices lists services in the specified cluster and namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/services`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified service belongs to.
  - `--namespace` (path, required): Namespace the specified service belongs to.
  - `--kind` (query, default `KIND_UNSPECIFIED`, one of: KIND_UNSPECIFIED|Deployment|StatefulSet|DaemonSet): The kind of service.
  - `--kind-name` (query): Name of kind.
  - `--name` (query): Name stands for service name, used for fuzzy search.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the service list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the service list order.
  - `--type` (query): Type is a array used for frontend filter.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--ports` (query): Ports is used to filter by port.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management core patch-config-map`

- Summary: PatchConfigMap patchs a configMap under the namespaces of a specific
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/configmaps/{name}/json`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the configmap belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ConfigMap.
  - `--name` (path, required): The name represents for the resource name

### `dc container-management core patch-namespace`

- Summary: PatchNamespace patches a namespace from the system by given namespace name
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified namespace belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management core patch-secret`

- Summary: PatchSecret patchs a Secret under the namespaces of a specific cluster
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/secrets/{name}/json`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the secret belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced secret.
  - `--name` (path, required): The name represents for the resource name

### `dc container-management core patch-service`

- Summary: PatchService patches a service from the system by given service name
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/services/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified service belongs to.
  - `--namespace` (path, required): Namespace the specified service belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management core put-node-labels`

- Summary: PutNodeLabels puts the specified node's labels
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/labels`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the node belongs to.
  - `--node` (path, required): Node name.

### `dc container-management core put-node-taints`

- Summary: PutNodeTaints puts a node's taints in a specific cluster
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/taints`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): // Cluster the specified node belongs to.
  - `--node` (path, required): Node name.
- Output: list path `taints`; columns `effect`, `key`, `value`

### `dc container-management core scale-persistent-volume-claim`

- Summary: ScalePersistentVolumeClaim post scale the persistent volume claim capacity
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims/{name}:scale`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of PVC belongs to.
  - `--namespace` (path, required): namespace represents the namespace of PVC belongs to.
  - `--name` (path, required): name represents the name of PVC belongs to.

### `dc container-management core un-cordon-node`

- Summary: UnCordonNode makes the specified node to schedulable.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/uncordon`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified node belongs to.
  - `--node` (path, required): Node name.

### `dc container-management core unbind-node-to-namespace`

- Summary: UnbindNodeToNamespace makes the specified node to shared.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{name}:unbindNamespace`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster is the cluster for namespace and node.
  - `--name` (path, required): Name is the node name for node which needs to

### `dc container-management core update-config-map`

- Summary: UpdateConfigMap updates a configMap under the namespaces of a specific
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/configmaps/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified configmap belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced ConfigMap.
  - `--name` (path, required): name represents for the resource name

### `dc container-management core update-limit-range`

- Summary: UpdateLimitRange updates the specified limitrange, the body must be a JSON
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/limitranges/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified limitRange belongs to.
  - `--namespace` (path, required): Namespace the specified limitRange belongs to.
  - `--name` (path, required): Name of the specified limitRange.

### `dc container-management core update-namespace`

- Summary: UpdateNamespace updates a namespace from the system by given namespace name
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified namespace belongs to.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management core update-node`

- Summary: UpdateNode updates a node from the system by given node name
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified node belongs to.
  - `--name` (path, required): The name represents for the node name.

### `dc container-management core update-node-annotations`

- Summary: UpdateNodeAnnotations edits annotations of specified node.
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/annotations`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified node belongs to.
  - `--node` (path, required): Node name.

### `dc container-management core update-node-gpu-mode`

- Summary: UpdateNodeGPUMode updates single the gpu mode with cluster node
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/nodes/{node}/gpu-mode`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster
  - `--node` (path, required): node

### `dc container-management core update-persistent-volume`

- Summary: UpdatePersistentVolume updates a persistentvolume from the system by given persistentvolume name
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/persistentvolumes/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified persistentVolume belongs to.
  - `--name` (path, required): Name of the specified persistentVolume.

### `dc container-management core update-persistent-volume-claim`

- Summary: UpdatePersistentVolumeClaim update the persistent volume claim
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of PVC to belongs to.
  - `--namespace` (path, required): namespace represents the namespace of PVC to belongs to.
  - `--name` (path, required): name represents the name of PVC to belongs to.

### `dc container-management core update-persistent-volume-claim-annotations`

- Summary: UpdatePersistentVolumeClaimAnnotations puts the specified pvc's annotations
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims/{name}/annotations`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of PVC to belongs to.
  - `--namespace` (path, required): namespace represents the namespace of PVC to belongs to.
  - `--name` (path, required): name represents the name of PVC to belongs to.

### `dc container-management core update-persistent-volume-claim-labels`

- Summary: UpdatePersistentVolumeClaimLabels puts the specified pvc's labels
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/persistentvolumeclaims/{name}/labels`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the PVC belongs to.
  - `--name` (path, required): Name represents the name of PVC to search

### `dc container-management core update-resource-quota`

- Summary: UpdateResourceQuota updates a resourceQuota from the system by given resourceQuota name
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/resourcequotas/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified resourceQuota belongs to.
  - `--namespace` (path, required): Namespace the specified resourceQuota belongs to.
  - `--name` (path, required): Name of the specified resourceQuota.

### `dc container-management core update-secret`

- Summary: UpdateSecret updates secret under the namespaces of a specific cluster
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/secrets/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the secret belongs to.
  - `--namespace` (path, required): Namespace is the metadata.namespace of the referenced secret.
  - `--name` (path, required): Secret name.

### `dc container-management core update-service`

- Summary: UpdateService updates a service from the system by given service name
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/services/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified service belongs to.
  - `--namespace` (path, required): Namespace the specified service belongs to.
  - `--name` (path, required): Name represents for the service name

### `dc container-management core update-service-account`

- Summary: UpdateServiceAccount updates a sa from the system by given sa name
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/serviceaccounts/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of ServiceAccount to belongs to.
  - `--name` (path, required): name represents the name of ServiceAccount to belongs to.

## Devices

### `dc container-management devices get-dashboard-url`

- Summary: Devices_GetDashboardURL
- HTTP: `GET /apis/kpanda.io/v1alpha1/grafana-dashboards/gpu-overview`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): cluster
  - `--node` (query): node
  - `--vendor` (query): vendor
  - `--gpu-index` (query, int32): gpuIndex
  - `--from` (query, int64): from
  - `--to` (query, int64): to

### `dc container-management devices list-gpu-devices`

- Summary: Devices_ListGPUDevices
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/gpu-devices`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the node belongs to.
  - `--search-node-name` (query): searchNodeName
  - `--search-gpu-model` (query): searchGPUModel
  - `--search-vendor` (query): searchVendor
  - `--search-device-uuid` (query): searchDeviceUUID
  - `--search-gpuid` (query): searchGPUID
- Output: list path `items`; columns `modelName`, `cluster`, `coreUtilization`, `deviceUUID`, `frameBufferMemoryUtilization`, `nodeName`

## EtcdBackupRestore

### `dc container-management etcdbackuprestore create-etcd-backup-strategy`

- Summary: CreateEtcdBackupStrategy creates a etcd backup strategy.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified etcd backup strategy belongs to.

### `dc container-management etcdbackuprestore delete-etcd-backup-strategy`

- Summary: DeleteEtcdBackupStrategy delete a etcd backup strategy in cluster.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the etcd backup strategy belongs to.
  - `--name` (path, required): Name represents the name of etcd backup strategy

### `dc container-management etcdbackuprestore delete-etcd-snapshot`

- Summary: DeleteEtcdBackup delete a etcd backup.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{strategy}/snapshots/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the etcd backup strategy belongs to.
  - `--strategy` (path, required): strategy represents the name of etcd backup strategy.
  - `--name` (path, required): Name represents the name of etcd snapshot.

### `dc container-management etcdbackuprestore execute-etcd-backup-strategy`

- Summary: ExecuteEtcdBackupStrategy executes a etcd backup strategy under the cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{name}:execute`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the etcd backup strategy belongs to.
  - `--name` (path, required): Name represents the name of etcd backup strategy.

### `dc container-management etcdbackuprestore get-etcd-backup-strategy`

- Summary: GetEtcdBackupStrategy get a etcd backup strategy in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified etcd backup strategy belongs to.
  - `--name` (path, required): Name represents for the etcd backup strategy name.

### `dc container-management etcdbackuprestore get-etcd-backup-strategy-json`

- Summary: GetEtcdBackupStrategyJSON get a etcd backup strategy json in cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster the specified etcd backup strategy belongs to.
  - `--name` (path, required): Name represents for the etcd backup strategy name.

### `dc container-management etcdbackuprestore list-etcd-backup-clusters`

- Summary: ListEtcdBackupClusters list clusters with/without etcd backup strategies.
- HTTP: `GET /apis/kpanda.io/v1alpha1/etcdbackuprestore/clusters`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `name`, `phase`, `hasBackup`, `kubeSystemID`

### `dc container-management etcdbackuprestore list-etcd-backup-strategies`

- Summary: ListEtcdBackupStrategies list etcd backup strategies.
- HTTP: `GET /apis/kpanda.io/v1alpha1/etcdbackuprestore/strategies`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): cluster represents which cluster the repository belongs to.
  - `--name` (query): Name is the user-specified identifier.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the repository list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the repository list order.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management etcdbackuprestore list-etcd-snapshots`

- Summary: ListEtcdSnapshots list etcd backup snapshots .
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{strategy}/snapshots`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the etcd backup strategy belongs to.
  - `--strategy` (path, required): strategy represents the name of etcd backup strategy.
- Output: list path `items`; columns `name`, `externalUrl`, `key`, `lastModified`, `size`

### `dc container-management etcdbackuprestore pause-etcd-backup-strategy`

- Summary: PauseEtcdBackupStrategy pauses a etcd backup strategy under the cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{name}:pause`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the etcd backup strategy belongs to.
  - `--name` (path, required): Name represents the name of etcd backup strategy

### `dc container-management etcdbackuprestore resume-etcd-backup-strategy`

- Summary: ResumeEtcdBackupStrategy resumes a etcd backup strategy under the cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{name}:resume`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the etcd backup strategy belongs to.
  - `--name` (path, required): Name represents the name of etcd backup strategy

### `dc container-management etcdbackuprestore update-etcd-backup-strategy`

- Summary: UpdateEtcdBackupStrategy updates tcd backup strategy under the cluster
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/strategies/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster the specified etcd backup strategy belongs to.
  - `--name` (path, required): The name for EtcdBackupStrategy.

### `dc container-management etcdbackuprestore verify-etcd-connection`

- Summary: VerifyEtcdConnection verifies the etcd connection.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/etcd:verify`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the etcd snapstore belongs to.

### `dc container-management etcdbackuprestore verify-snap-store-config`

- Summary: VerifySnapStore verifies the SnapStore config.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/etcdbackuprestore/snapstores:verify`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the etcd snapstore belongs to.

## Image

### `dc container-management image detect-kangaroo`

- Summary: DetectKangaroo returns whether the kangaroo is installed.
- HTTP: `GET /apis/kpanda.io/v1alpha1/registries/kangaroo`
- Auth: required
- Body: none
- Flags: none

### `dc container-management image list-artifacts`

- Summary: ListArtifacts returns a list of tags of specified image
- HTTP: `GET /apis/kpanda.io/v1alpha1/registries/{registry}/repositories/{repository}/artifacts`
- Auth: required
- Body: none
- Flags:
  - `--registry` (path, required): Registry is registry name.
  - `--repository` (path, required): Repository is image name.
  - `--cluster` (query): Cluster is the current cluster.
  - `--namespace` (query): Namespace is the current namespace.
  - `--project` (query): Project is the project to request.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page.
  - `--public` (query): Public is distinguish public images and private images.
  - `--fuzzy-tag-name` (query): FuzzyTagName is used to fuzzy search by tag name.
- Output: list path `items`; columns `digest`, `imageSize`, `pushTime`; pagination `offset`

### `dc container-management image list-projects`

- Summary: ListProjects returns a list of projects of specified registry
- HTTP: `GET /apis/kpanda.io/v1alpha1/registries/{registry}/projects`
- Auth: required
- Body: none
- Flags:
  - `--registry` (path, required): Registry is registry name.
  - `--cluster` (query): Cluster is the current cluster.
  - `--namespace` (query): Namespace is the current namespace.
  - `--public` (query): Public is distinguish public projects and private projects.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by project name.
- Output: list path `items`; pagination `offset`

### `dc container-management image list-registries`

- Summary: ListRegistries returns a list of registries
- HTTP: `GET /apis/kpanda.io/v1alpha1/registries`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster is the current cluster.
  - `--namespace` (query): Namespace is the current namespace.
  - `--global` (query): Global is to list all global registries.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page.
  - `--public` (query): Public is distinguish public images and private images.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by registry name.
- Output: list path `items`; columns `name`, `alias`, `host`; pagination `offset`

### `dc container-management image list-repositories`

- Summary: ListRepositories returns a list of image names of specified project
- HTTP: `GET /apis/kpanda.io/v1alpha1/registries/{registry}/repositories`
- Auth: required
- Body: none
- Flags:
  - `--registry` (path, required): Registry is registry name.
  - `--cluster` (query): Cluster is the current cluster.
  - `--namespace` (query): Namespace is the current namespace.
  - `--project` (query): Project is the project to request, "/" is a possible value.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page.
  - `--public` (query): Public is distinguish public images and private images.
  - `--show-artifacts` (query): ShowArtifacts is to list artifacts of per image, default false.
- Output: list path `items`; columns `name`; pagination `offset`

## Networking

### `dc container-management networking create-ingress`

- Summary: Create an Ingress
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/ingresses`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster
  - `--namespace` (path, required): Namespace specified the namespace of ingress.

### `dc container-management networking create-network-policy`

- Summary: CreateNetworkPolicy creates a networkpolicy in the specified cluster and namespace.
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/networkpolicies`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster to request.
  - `--namespace` (path, required): Namespace specified the namespace of networkpolicy.

### `dc container-management networking delete-ingress`

- Summary: Delete an Ingress
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/ingresses/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster
  - `--namespace` (path, required): Namespace specified the namespace of ingress.
  - `--name` (path, required): Name is the name of ingress.

### `dc container-management networking delete-network-policy`

- Summary: DeleteNetworkPolicy deletes the networkpolicy by name.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/networkpolicies/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster to request.
  - `--namespace` (path, required): Namespace specified the namespace of networkpolicy.
  - `--name` (path, required): Name is the name of networkpolicy.

### `dc container-management networking get-ingress`

- Summary: Get Ingress details
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/ingresses/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster
  - `--namespace` (path, required): Namespace specified the namespace of ingress.
  - `--name` (path, required): Name is the name of the ingress.

### `dc container-management networking get-ingress-json`

- Summary: GetIngressJSON gets the ingress by namespace and name, returns a string in JSON
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/ingresses/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster
  - `--namespace` (path, required): Namespace specified the namespace of ingress.
  - `--name` (path, required): Name is the name of the ingress.
  - `--stable` (query): If stable is true, the v1 version under the corresponding package will be returned.

### `dc container-management networking get-network-policy`

- Summary: GetNetworkPolicy gets the networkpolicy by namespace and name.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/networkpolicies/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster to request.
  - `--namespace` (path, required): Namespace specifies the namespace of networkpolicy.
  - `--name` (path, required): Name is the name of the networkpolicy.

### `dc container-management networking get-network-policy-json`

- Summary: GetNetworkPolicyJSON gets the networkpolicy by namespace and name, returns a string in JSON
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/networkpolicies/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster to request.
  - `--namespace` (path, required): Namespace specified the namespace of networkpolicy.
  - `--name` (path, required): Name is the name of the networkpolicy.
  - `--stable` (query): If stable is true, the v1 version under the corresponding package will be returned.

### `dc container-management networking list-cluster-ingresses`

- Summary: ListClusterIngresses lists all ingresses in the specified cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/ingresses`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, must be specified,
  - `--page` (query, default `1`, int32): Page is the number of pages at the beginning.
  - `--page-size` (query, default `20`, int32): Size is the number of every page displayed.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy defines sort field, please see message kpanda.io.api.types.SortBy.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy defines the type of sort, default type asc, can also specify desc.
  - `--name` (query): Name is the name of the ingress.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management networking list-cluster-network-policies`

- Summary: ListClusterNetworkPolicies lists all networkpolicies in the specified cluster.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/networkpolicies`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, must be specified,
  - `--page` (query, default `1`, int32): Page is current page number.
  - `--page-size` (query, default `20`, int32): Size is the number of every page displayed.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy defines sort field, please see message kpanda.io.api.types.SortBy.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy defines the type of sort, default type asc, can also specify desc.
  - `--name` (query): Name is the name of the networkpolicy.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter.
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management networking list-ingress-class-summary`

- Summary: ListIngressClassSummary gets a list of ingressClass simple information
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/ingressclasssummary`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the ingressClass belongs to.
  - `--namespace` (query): Namespace is the IngressClass to retrieve for a specific namespace scoped.
- Output: list path `items`; columns `name`, `kind`, `isDefaultClass`

### `dc container-management networking list-ingresses`

- Summary: List Ingresses in a namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/ingresses`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster
  - `--namespace` (path, required): Namespace specified the namespace of ingress.
  - `--page` (query, default `1`, int32): Page is the number of pages at the beginning.
  - `--page-size` (query, default `20`, int32): Size is the number of every page displayed.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy defines sort field, please see message kpanda.io.api.types.SortBy.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy defines the type of sort, default type asc, can also specify desc.
  - `--name` (query): Name is the name of the ingress.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management networking list-metallb-ip-address-pools`

- Summary: ListMetallbIPPool lists all metallb in the specified cluster and namespace.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/metallb/ippools`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster
  - `--page` (query, default `1`, int32): Page is the number of pages at the beginning.
  - `--page-size` (query, default `20`, int32): Size is the number of every page displayed.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy defines sort field, please see message kpanda.io.api.types.SortBy.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy defines the type of sort, default type asc, can also specify desc.
  - `--name` (query): Name is the name of the ingress.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management networking list-network-policies`

- Summary: ListNetworkPolicies lists all networkpolicies in the specified cluster and namespace.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/networkpolicies`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the networkpolicies of the cluster
  - `--namespace` (path, required): Namespace of networkpolicy list.
  - `--page` (query, default `1`, int32): Page is current page number.
  - `--page-size` (query, default `20`, int32): Size is the number of every page displayed.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy defines sort field, please see message kpanda.io.api.types.SortBy.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy defines the type of sort, default type asc, can also specify desc.
  - `--name` (query): Name is the name of the networkpolicy.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management networking patch-ingress`

- Summary: PatchIngress patches the specified ingress, the body must be a JSON string.
- HTTP: `PATCH /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/ingresses/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster
  - `--namespace` (path, required): Namespace specified the namespace of ingress.
  - `--name` (path, required): The name represents for the resource name.

### `dc container-management networking update-ingress`

- Summary: UpdateIngress updates the specified ingress, the body must be a JSON
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/ingresses/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster
  - `--namespace` (path, required): Namespace specified the namespace of ingress.
  - `--name` (path, required): Name is the name of ingress.

### `dc container-management networking update-network-policy`

- Summary: UpdateNetworkPolicy updates the specified networkpolicy, the body must be a JSON
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/networkpolicies/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster to request.
  - `--namespace` (path, required): Namespace specified the namespace of networkpolicy.
  - `--name` (path, required): Name is the name of networkpolicy.

### `dc container-management networking validate-metallb-shared-ip-port-conflict`

- Summary: ValidateMetallbSharedIPPortConflict checks whether the service port of
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/metallb/check-serviceports`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster is the name of the cluster, return all the ingress of the cluster

## RBAC

### `dc container-management rbac create-cluster-role`

- Summary: CreateClusterRole creates a ClusterRole
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterroles/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the clusterrole belongs to.
  - `--name` (path, required): the name of role.
- Output: list path `rules`

### `dc container-management rbac create-cluster-role-binding`

- Summary: CreateClusterRoleBinding creates a cluster roleBinding batch
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterrolebindings`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the clusterRoleBinding belongs to.
- Output: list path `subjects`; columns `name`, `namespace`, `kind`, `APIGroup`

### `dc container-management rbac create-role`

- Summary: CreateRole creates a Role
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/roles`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the role belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the role belongs to.
- Output: list path `rules`

### `dc container-management rbac create-role-binding`

- Summary: CreateRoleBinding creates a RoleBinding
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/rolebindings`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the roleBinding belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the roleBinding belongs to.
- Output: list path `subjects`; columns `name`, `namespace`, `kind`, `APIGroup`

### `dc container-management rbac delete-cluster-role`

- Summary: DeleteClusterRole deletes a ClusterRole
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterroles/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the clusterrole belongs to.
  - `--name` (path, required): Name represents the name of the clusterrole to delete.

### `dc container-management rbac delete-cluster-role-binding`

- Summary: DeleteClusterRoleBinding deletes a cluster RoleBinding
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterrolebindings/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the roleBinding belongs to.
  - `--name` (path, required): Name represents the name of the clusterrolebinding to delete.

### `dc container-management rbac delete-role`

- Summary: DeleteRole deletes the roles created by the frontend.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/roles/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the role belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the role belongs to.
  - `--name` (path, required): Name represents the name of the role to delete.

### `dc container-management rbac delete-role-binding`

- Summary: ListRoleBindings lists the clusterrolebidings created by the frontend.
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/rolebindings/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the roleBinding belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the roleBinding belongs to.
  - `--name` (path, required): Name represents the name of the rolebinding to delete.

### `dc container-management rbac get-cluster-role`

- Summary: GetClusterRole gets a ClusterRole
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterroles/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the clusterrole belongs to.
  - `--name` (path, required): Name represents the name of the clusterrole to delete.
- Output: list path `rules`

### `dc container-management rbac get-role`

- Summary: GetRole gets a Role
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/roles/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the role belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the role belongs to.
  - `--name` (path, required): Name represents the name of the role to delete.
- Output: list path `rules`

### `dc container-management rbac list-admin-cluster-summary`

- Summary: ListAdminClusterSummary List cluster summary by adminCluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/admincluster`
- Auth: required
- Body: none
- Flags:
  - `--user` (query): user is the cluster's user
  - `--user-group` (query): userGroup is the cluster user's belong group
- Output: list path `clusters`

### `dc container-management rbac list-all-user-role-summary`

- Summary: ListAllUserRoleSummary lists user role summary
- HTTP: `GET /apis/kpanda.io/v1alpha1/rolesummary`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster represents which cluster the roleBinding belongs to.
  - `--namespace` (query): Namespace represents which namespace the roleBinding belongs to.

### `dc container-management rbac list-cluster-role-bindings`

- Summary: List ClusterRoleBindings
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/clusterrolebindings`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster represents which cluster the roleBinding belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of the user
  - `--role-ref` (query): RoleRef is the role of the user, it should be the same as when it is created.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management rbac list-cluster-roles`

- Summary: List ClusterRoles
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterroles`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the role belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of the user
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management rbac list-groups`

- Summary: ListGroups lists the groups in the system.
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/groups`
- Auth: required
- Body: none
- Flags:
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name is used for fuzzy search.
- Output: list path `items`; columns `name`, `id`; pagination `offset`

### `dc container-management rbac list-role-bindings`

- Summary: List RoleBindings in a namespace
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/rolebindings`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster represents which cluster the roleBinding belongs to.
  - `--namespace` (query): Namespace represents which namespace the roleBinding belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of the user
  - `--role-ref` (query): RoleRef is the role of the user, it should be the same as when it is created.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management rbac list-roles`

- Summary: ListRoles lists the roles created by frontend.
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/roles`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the role belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the role belongs to.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name represents the name of the user
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the data list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the data list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management rbac list-users`

- Summary: ListUsers lists the users in the system.
- HTTP: `GET /apis/kpanda.io/v1alpha1/asl/users`
- Auth: required
- Body: none
- Flags:
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--name` (query): Name is used for fuzzy search.
- Output: list path `items`; columns `name`, `id`; pagination `offset`

### `dc container-management rbac update-cluster-role`

- Summary: UpdateClusterRole updates a ClusterRole
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/clusterroles/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the clusterrole belongs to.
  - `--name` (path, required): Name represents the name of the clusterrole to delete.

### `dc container-management rbac update-role`

- Summary: UpdateRole updates a Role
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/roles/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the role belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the role belongs to.
  - `--name` (path, required): Name represents the name of the role to delete.

## Registry

### `dc container-management registry list-image-tags`

- Summary: Registry_ListImageTags
- HTTP: `GET /apis/kpanda.io/v1alpha1/registry/tags`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster presents the cluster of dockeconfig belongs to.
  - `--namespace` (query): Namespace presents the namespace of dockeconfig belongs to.
  - `--secret` (query): Secret is the name of dockeconfig.
  - `--image` (query): Image is the name of repository which needs verify.
  - `--registry-host` (query): The registry host which the repository belongs to.
- Output: list path `data`

### `dc container-management registry verify-image`

- Summary: Registry_VerifyImage
- HTTP: `GET /apis/kpanda.io/v1alpha1/registry/verifyImage`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Cluster presents the cluster of dockeconfig belongs to.
  - `--namespace` (query): Namespace presents the namespace of dockeconfig belongs to.
  - `--secret` (query): Secret is the name of dockeconfig.
  - `--image` (query): Image is the name of repository which needs to list tags.
  - `--registry-host` (query): The registry host which the repository belongs to.

### `dc container-management registry verify-registry`

- Summary: Registry_VerifyRegistry
- HTTP: `POST /apis/kpanda.io/v1alpha1/registry/verify`
- Auth: required
- Body: required
- Flags: none

## SettingService

### `dc container-management settingservice gpu-setting`

- Summary: SettingService_GPUSetting
- HTTP: `GET /apis/kpanda.io/v1alpha1/settings/gpu`
- Auth: required
- Body: none
- Flags: none
- Output: list path `gpuSetting`; columns `type`, `alias`, `isDynamic`

## Storage

### `dc container-management storage create-storage-class`

- Summary: CreateStorageClass
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/storageclasses`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Cluster represents the cluster of StorageClass to belongs to.

### `dc container-management storage create-volume-snapshot`

- Summary: CreateVolumeSnapshot create volume snapshot in single cluster
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/volumesnapshots`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of VolumeSnapshot to belongs to.
  - `--namespace` (path, required): namespace represents the namespace of VolumeSnapshot to belongs to.

### `dc container-management storage delete-storage-class`

- Summary: DeleteStorageClass
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/storageclasses/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Cluster represents which cluster the StorageClass belongs to.
  - `--name` (path, required): Name represents the name of StorageClass

### `dc container-management storage delete-volume-snapshot`

- Summary: DeleteVolumeSnapshot delete volume snapshot in single cluster
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/volumesnapshots/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of VolumeSnapshot to belongs to.
  - `--namespace` (path, required): namespace represents the namespace of VolumeSnapshot to belongs to.
  - `--name` (path, required): name represents the name of VolumeSnapshot to belongs to.

### `dc container-management storage get-storage-class`

- Summary: GetStorageClass get StorageClass in single cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/storageclasses/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC to belongs to.
  - `--name` (path, required): name represents the name of StorageClass to belongs to.
- Output: list path `mountOptions`

### `dc container-management storage get-storage-class-json`

- Summary: GetStorageClassJSON get StorageClass json in single cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/storageclasses/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC to belongs to.
  - `--name` (path, required): name represents the name of StorageClass to belongs to.

### `dc container-management storage get-volume-snapshot-json`

- Summary: GetVolumeSnapshotJSON list StorageClass in single cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/volumesnapshots/{name}/json`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of VolumeSnapshots belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the VolumeSnapshots belongs to.
  - `--name` (path, required): Name represents the name of VolumeSnapshots to search

### `dc container-management storage list-accessible-storage-classes`

- Summary: ListAccessibleStorageClasses lists all storageclasses in accessible clusters
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/accessiblestorageclasses`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC to belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--provisioner` (query): Provisioner is used for fuzzy search by provisioner.
  - `--reclaim-policy` (query): ReclaimPolicy is used for fuzzy search by reclaimPolicy.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `allowVolumeExpansion`, `provisioner`, `reclaimPolicy`; pagination `offset`

### `dc container-management storage list-cluster-volume-snapshots`

- Summary: ListClusterVolumeSnapshots will list all VolumeSnapshot by given cluster and regardless of
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/volumesnapshots`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of VolumeSnapshot to belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): Name is used for filter.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management storage list-storage-classes`

- Summary: ListStorageClass list StorageClass in single cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/storageclasses`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of PVC to belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): Name is used for filter.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
  - `--provisioner` (query): Provisioner is used for fuzzy search by provisioner.
  - `--reclaim-policy` (query): ReclaimPolicy is used for fuzzy search by reclaimPolicy.
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`, `allowVolumeExpansion`, `provisioner`, `reclaimPolicy`; pagination `offset`

### `dc container-management storage list-volume-snapshots`

- Summary: ListVolumeSnapshots list volume snapshot in single cluster
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/volumesnapshots`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster represents the name of VolumeSnapshot to belongs to.
  - `--namespace` (path, required): Namespace represents which namespace the VolumeSnapshot belongs to.
  - `--page` (query, default `1`, int32): Page requested.
  - `--page-size` (query, default `20`, int32): Size per page requested.
  - `--name` (query): Name is used for filter.
  - `--sort-by` (query, default `SORT_BY_UNSPECIFIED`, one of: SORT_BY_UNSPECIFIED|field_name|state|workspace|cluster|namespace|created_at): SortBy determines the list order reference.
  - `--sort-dir` (query, default `desc`, one of: desc|asc): OrderBy determines the list order.
  - `--label-selector` (query): LabelSelector is the format after labels.FormatLabels used to filter
  - `--field-selector` (query): FieldSelector is the format after labels.FormatLabels used to filter
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `metadata.creationTimestamp`; pagination `offset`

### `dc container-management storage update-storage-class`

- Summary: UpdateStorageClass update storage class
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/storageclasses/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of StorageClass to belongs to.
  - `--name` (path, required): name represents the name of StorageClass to belongs to.

### `dc container-management storage update-volume-snapshot`

- Summary: UpdateVolumeSnapshot update volume snapshot
- HTTP: `PUT /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/volumesnapshots/{name}`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster represents the cluster of Volume snapshot to belongs to.
  - `--namespace` (path, required): namespace represents the namespace of volume snapshot to belongs to.
  - `--name` (path, required): name represents the name of volume snapshot to belongs to.

## Workspace

### `dc container-management workspace bind-cluster-to-workspace`

- Summary: Workspace_BindClusterToWorkspace
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}:bind`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster

### `dc container-management workspace bind-resource-to-workspace`

- Summary: Workspace_BindResourceToWorkspace
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}:bind`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster
  - `--name` (path, required): name

### `dc container-management workspace get-workspace-resource-quota-allocatable`

- Summary: Workspace_GetWorkspaceResourceQuotaAllocatable
- HTTP: `GET /apis/kpanda.io/v1alpha1/workspaces/{workspaceId}/workspacesharedresourcequota`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId
  - `--workspace-alias` (query): workspaceAlias
  - `--cluster` (query): cluster

### `dc container-management workspace list-global-roles-for-current-user`

- Summary: Workspace_ListGlobalRolesForCurrentUser
- HTTP: `GET /apis/kpanda.io/v1alpha1/globalroles`
- Auth: required
- Body: none
- Flags: none
- Output: list path `roles`

### `dc container-management workspace list-workspaces`

- Summary: Workspace_ListWorkspaces
- HTTP: `GET /apis/kpanda.io/v1alpha1/workspaces`
- Auth: required
- Body: none
- Flags: none
- Output: list path `workspaces`; columns `id`, `alias`

### `dc container-management workspace un-bind-cluster-from-workspace`

- Summary: Workspace_UnBindClusterFromWorkspace
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}:unbind`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster

### `dc container-management workspace unbind-resource-from-workspace`

- Summary: Workspace_UnbindResourceFromWorkspace
- HTTP: `DELETE /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{name}:unbind`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): cluster
  - `--name` (path, required): name

## insight

### `dc container-management insight get-pod-container-log`

- Summary: GetPodContainerLog gets pod contianer log
- HTTP: `GET /apis/kpanda.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}/log`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Name of the cluster where the Pod is located
  - `--namespace` (path, required): Name of the namespace where the Pod is located
  - `--name` (path, required): Name of pod
  - `--workload` (query): workload refers to the name of a workload
  - `--container` (query): Name of the pod where the container is located
  - `--start-time` (query): Start time of get pod container log
  - `--end-time` (query): End time of get pod container log
  - `--page` (query, default `1`, int32): Number of page.
  - `--page-size` (query, default `20`, int32): Log number shown per page.
  - `--log-search` (query): for fuzzy query
- Output: list path `data`; columns `log`, `timeStamp`; pagination `offset`

### `dc container-management insight query-cluster-metrics`

- Summary: insight_QueryClusterMetrics
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/metric`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): The name of the cluster
- Output: list path `data`; columns `errorMessage`, `status`

### `dc container-management insight query-cluster-metrics-range`

- Summary: insight_QueryClusterMetricsRange
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/metricrange`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): the name of the cluster
- Output: list path `data`; columns `errorMessage`, `status`

### `dc container-management insight query-public-range-usage`

- Summary: insight_QueryPublicRangeUsage
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/publicmetricrange`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Name of the cluster where the workload is located
- Output: list path `data`; columns `errorMessage`, `status`

### `dc container-management insight query-public-usage`

- Summary: insight_QueryPublicUsage
- HTTP: `POST /apis/kpanda.io/v1alpha1/clusters/{cluster}/publicmetric`
- Auth: required
- Body: required
- Flags:
  - `--cluster` (path, required): Name of the cluster where the workload is located
- Output: list path `data`; columns `errorMessage`, `status`

# Module `global-management`

## Source

- Backend: `swagger`
- Repository: https://github.com/DaoCloud/daocloud-api-docs.git
- Pinned tag: `4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3`
- Files: `docs/openapi/ghippo/v0.45.1.json`
- Resolved SHA: `4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3`

## About

### `dc global-management about list-developers`

- Summary: About_ListDevelopers
- HTTP: `GET /apis/ghippo.io/v1alpha1/about/developers`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `name`, `message`

### `dc global-management about list-g-product-versions`

- Summary: About_ListGProductVersions
- HTTP: `GET /apis/ghippo.io/v1alpha1/about/versions`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `name`, `version`

### `dc global-management about list-open-sources`

- Summary: About_ListOpenSources
- HTTP: `GET /apis/ghippo.io/v1alpha1/about/opensources`
- Auth: required
- Body: none
- Flags:
  - `--page` (query, default `1`, int32): page: 当前页码，默认值为1
  - `--page-size` (query, default `20`, int32): 每页数量,默认为 10
- Output: list path `items`; columns `name`, `license`; pagination `offset`

## Account

### `dc global-management account certify-check`

- Summary: Account_CertifyCheck
- HTTP: `POST /apis/ghippo.io/v1alpha1/current-user/certify/check`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account certify-init`

- Summary: Account_CertifyInit
- HTTP: `POST /apis/ghippo.io/v1alpha1/current-user/certify`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account create-access-token`

- Summary: Account_CreateAccessToken
- HTTP: `POST /apis/ghippo.io/v1alpha1/current-user/accesstoken`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account create-ssh-key`

- Summary: Account_CreateSSHKey
- HTTP: `POST /apis/ghippo.io/v1alpha1/current-user/sshkeys`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account delete-access-token`

- Summary: Account_DeleteAccessToken
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/current-user/accesstokens/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management account delete-ssh-key`

- Summary: Account_DeleteSSHKey
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/current-user/sshkeys/{sshkeyId}`
- Auth: required
- Body: none
- Flags:
  - `--sshkey-id` (path, required, int32): sshkeyId
  - `--id` (query): id

### `dc global-management account get-certify-info`

- Summary: Account_GetCertifyInfo
- HTTP: `GET /apis/ghippo.io/v1alpha1/current-user/certify`
- Auth: required
- Body: none
- Flags: none

### `dc global-management account get-global-permissions`

- Summary: Account_GetGlobalPermissions
- HTTP: `GET /apis/ghippo.io/v1alpha1/current-user/global-permissions`
- Auth: required
- Body: none
- Flags: none
- Output: list path `permissions`

### `dc global-management account get-user`

- Summary: Get user details by ID
- HTTP: `GET /apis/ghippo.io/v1alpha1/current-user`
- Auth: required
- Body: none
- Flags: none

### `dc global-management account list-access-tokens`

- Summary: Account_ListAccessTokens
- HTTP: `GET /apis/ghippo.io/v1alpha1/current-user/accesstokens`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `name`, `id`, `createdAt`, `expiredAt`, `updatedAt`

### `dc global-management account list-ssh-keys`

- Summary: Account_ListSSHKeys
- HTTP: `GET /apis/ghippo.io/v1alpha1/current-user/sshkeys`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `id`, `createdAt`, `expiredAt`, `publicKey`, `sshKeyName`, `updatedAt`

### `dc global-management account password-description`

- Summary: Account_PasswordDescription
- HTTP: `GET /apis/ghippo.io/v1alpha1/current-user/password-description`
- Auth: required
- Body: none
- Flags: none

### `dc global-management account set-current-user-password`

- Summary: Account_SetCurrentUserPassword
- HTTP: `PUT /apis/ghippo.io/v1alpha1/current-user/set-password`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account update-email`

- Summary: Account_UpdateEmail
- HTTP: `PUT /apis/ghippo.io/v1alpha1/current-user/email`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account update-language`

- Summary: Account_UpdateLanguage
- HTTP: `PUT /apis/ghippo.io/v1alpha1/current-user/language`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account update-password`

- Summary: Account_UpdatePassword
- HTTP: `PUT /apis/ghippo.io/v1alpha1/current-user/password`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account update-phone`

- Summary: Account_UpdatePhone
- HTTP: `PUT /apis/ghippo.io/v1alpha1/current-user/phone`
- Auth: required
- Body: required
- Flags: none

### `dc global-management account update-ssh-key`

- Summary: Account_UpdateSSHKey
- HTTP: `PUT /apis/ghippo.io/v1alpha1/current-user/sshkeys/{sshkeyId}`
- Auth: required
- Body: required
- Flags:
  - `--sshkey-id` (path, required, int32): sshkeyId

### `dc global-management account update-user-first-and-last-name`

- Summary: Account_UpdateUserFirstAndLastName
- HTTP: `PUT /apis/ghippo.io/v1alpha1/current-user/name`
- Auth: required
- Body: required
- Flags: none

## Audit

### `dc global-management audit clear-audits-now`

- Summary: Audit_ClearAuditsNow
- HTTP: `POST /apis/ghippo.io/v1alpha3/audits/clear`
- Auth: required
- Body: required
- Flags: none

### `dc global-management audit clear-kube-audits-now`

- Summary: Audit_ClearKubeAuditsNow
- HTTP: `POST /apis/ghippo.io/v1alpha3/audits/kube/clear`
- Auth: required
- Body: required
- Flags: none

### `dc global-management audit export-audits`

- Summary: Audit_ExportAudits
- HTTP: `GET /apis/ghippo.io/v1alpha3/audits/export`
- Auth: required
- Body: none
- Flags:
  - `--start` (query): start
  - `--end` (query): end
  - `--audit-name` (query): auditName
  - `--source-type` (query): sourceType
  - `--source-name` (query): sourceName
  - `--cluster-name` (query): clusterName
  - `--gproduct` (query): gproduct
  - `--status` (query, default `all`, one of: all|succeeded|failed): status
  - `--search-type` (query, default `fuzzy`, one of: fuzzy|exact): searchType
  - `--search-user` (query): searchUser
  - `--export-type` (query, default `Csv`, one of: Csv|Excel): exportType
- Output: list path `extensions`; columns `@type`

### `dc global-management audit export-kube-audits`

- Summary: Audit_ExportKubeAudits
- HTTP: `GET /apis/ghippo.io/v1alpha3/audits/kube/export`
- Auth: required
- Body: none
- Flags:
  - `--start` (query): start
  - `--end` (query): end
  - `--audit-name` (query): auditName
  - `--source-type` (query): sourceType
  - `--source-name` (query): sourceName
  - `--cluster-name` (query): clusterName
  - `--status` (query, default `all`, one of: all|succeeded|failed): status
  - `--search-type` (query, default `fuzzy`, one of: fuzzy|exact): searchType
  - `--search-user` (query): searchUser
  - `--export-type` (query, default `Csv`, one of: Csv|Excel): exportType
- Output: list path `extensions`; columns `@type`

### `dc global-management audit external-audit`

- Summary: 来自外部传递进来的审计日志，用于不经过apiserver的请求，例如直接请求keycloak的请求，由前端埋点调用
- HTTP: `GET /apis/ghippo.io/v1alpha1/audits/external`
- Auth: required
- Body: none
- Flags:
  - `--external-type` (query, default `loginFailed`, one of: loginFailed|forgetPassword|resetPassword): externalType
  - `--resource-name` (query): resourceName
  - `--code` (query, int32): code

### `dc global-management audit get-audit-detail`

- Summary: Audit_GetAuditDetail
- HTTP: `GET /apis/ghippo.io/v1alpha3/audits/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management audit get-audit-resource-report`

- Summary: Audit_GetAuditResourceReport
- HTTP: `GET /apis/ghippo.io/v1alpha1/audits/reports/resources`
- Auth: required
- Body: none
- Flags:
  - `--start` (query): start
  - `--end` (query): end
- Output: list path `items`; columns `Count`, `EventName`, `ResourceType`

### `dc global-management audit get-audit-user-report`

- Summary: Audit_GetAuditUserReport
- HTTP: `GET /apis/ghippo.io/v1alpha1/audits/reports/users`
- Auth: required
- Body: none
- Flags:
  - `--start` (query): start
  - `--end` (query): end
- Output: list path `items`; columns `FailedCount`, `SuccessCount`, `TotalCount`, `UserName`

### `dc global-management audit get-auto-clear-audit-time`

- Summary: Audit_GetAutoClearAuditTime
- HTTP: `GET /apis/ghippo.io/v1alpha1/audits/clear`
- Auth: required
- Body: none
- Flags: none

### `dc global-management audit get-export-uri`

- Summary: Audit_GetExportURI
- HTTP: `GET /apis/ghippo.io/v1alpha3/audits/export/uri`
- Auth: required
- Body: none
- Flags:
  - `--module` (query, default `audit`, one of: audit|kube_audit): module

### `dc global-management audit get-kube-audit-detail`

- Summary: Audit_GetKubeAuditDetail
- HTTP: `GET /apis/ghippo.io/v1alpha3/audits/kube/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management audit get-limit-range-time`

- Summary: Audit_GetLimitRangeTime
- HTTP: `GET /apis/ghippo.io/v1alpha1/audits/limit-range`
- Auth: required
- Body: none
- Flags: none

### `dc global-management audit list-audits`

- Summary: List audit log entries
- HTTP: `GET /apis/ghippo.io/v1alpha3/audits`
- Auth: required
- Body: none
- Flags:
  - `--audit-name` (query): auditName
  - `--source-type` (query): sourceType
  - `--source-name` (query): sourceName
  - `--cluster-name` (query): clusterName
  - `--status` (query, default `all`, one of: all|succeeded|failed): status
  - `--search-type` (query, default `fuzzy`, one of: fuzzy|exact): searchType
  - `--search-user` (query): searchUser
  - `--gproduct` (query): gproduct
  - `--start` (query): start
  - `--end` (query): end
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
- Output: list path `items`; columns `id`, `auditName`, `client`, `clusterName`, `createdAt`, `gproduct`; pagination `offset`
- Example: `dc global-management audit list-audits --page-size 100 -o json`

### `dc global-management audit list-csp-audits`

- Summary: Audit_ListCSPAudits
- HTTP: `GET /apis/ghippo.io/v1alpha1/csp-audits`
- Auth: required
- Body: none
- Flags:
  - `--account-name` (query): accountName
  - `--start` (query): start
  - `--end` (query): end
  - `--gproduct` (query): gproduct
  - `--resource-type` (query): resourceType
  - `--resource-name` (query): resourceName
  - `--verb` (query): verb
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): 分页大小
- Output: list path `items`; columns `createdAt`, `gproduct`, `ip`, `operator`, `resourceName`, `resourceType`; pagination `offset`

### `dc global-management audit list-kube-audits`

- Summary: Audit_ListKubeAudits
- HTTP: `GET /apis/ghippo.io/v1alpha3/audits/kube`
- Auth: required
- Body: none
- Flags:
  - `--audit-name` (query): auditName
  - `--source-type` (query): sourceType
  - `--source-name` (query): sourceName
  - `--cluster-name` (query): clusterName
  - `--status` (query, default `all`, one of: all|succeeded|failed): status
  - `--search-type` (query, default `fuzzy`, one of: fuzzy|exact): searchType
  - `--search-user` (query): searchUser
  - `--start` (query): start
  - `--end` (query): end
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
- Output: list path `items`; columns `id`, `auditName`, `client`, `clusterName`, `createdAt`, `ip`; pagination `offset`

### `dc global-management audit set-auto-clear-audit-setting`

- Summary: Audit_SetAutoClearAuditSetting
- HTTP: `PUT /apis/ghippo.io/v1alpha3/audits/set-auto-clear`
- Auth: required
- Body: required
- Flags: none

### `dc global-management audit set-auto-clear-kube-audit-setting`

- Summary: Audit_SetAutoClearKubeAuditSetting
- HTTP: `PUT /apis/ghippo.io/v1alpha3/audits/set-auto-clear/kube`
- Auth: required
- Body: required
- Flags: none

## Client

### `dc global-management client create-client`

- Summary: Client_CreateClient
- HTTP: `POST /apis/ghippo.io/v1alpha1/clients`
- Auth: required
- Body: required
- Flags: none

### `dc global-management client delete-client`

- Summary: Client_DeleteClient
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/clients/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management client get-client`

- Summary: Client_GetClient
- HTTP: `GET /apis/ghippo.io/v1alpha1/clients/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management client list-clients`

- Summary: Client_ListClients
- HTTP: `GET /apis/ghippo.io/v1alpha1/clients`
- Auth: required
- Body: none
- Flags:
  - `--client-id` (query): clientId
- Output: list path `items`; columns `name`, `id`, `baseUrl`, `clientId`, `secret`

### `dc global-management client update-client`

- Summary: Client_UpdateClient
- HTTP: `PUT /apis/ghippo.io/v1alpha1/clients/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id

## Domain

### `dc global-management domain create-domain`

- Summary: Domain_CreateDomain
- HTTP: `POST /apis/ghippo.io/v1alpha1/domain`
- Auth: required
- Body: required
- Flags: none

## FeatureGate

### `dc global-management featuregate list-feature-gates`

- Summary: FeatureGate_ListFeatureGates
- HTTP: `GET /apis/ghippo.io/v1alpha1/feature-gate`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `id`, `description`, `enabled`

## GProductLicenses

### `dc global-management gproductlicenses delete-g-product-licenses`

- Summary: GProductLicenses_DeleteGProductLicenses
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/gproduct-licenses/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management gproductlicenses get-g-product-licenses`

- Summary: GProductLicenses_GetGProductLicenses
- HTTP: `GET /apis/ghippo.io/v1alpha1/gproduct-licenses/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management gproductlicenses get-g-product-licenses-esn`

- Summary: GProductLicenses_GetGProductLicensesESN
- HTTP: `GET /apis/ghippo.io/v1alpha1/gproduct-licenses/esn`
- Auth: required
- Body: none
- Flags: none

### `dc global-management gproductlicenses get-g-product-licenses-expired`

- Summary: GProductLicenses_GetGProductLicensesExpired
- HTTP: `GET /apis/ghippo.io/v1alpha1/gproduct-licenses/expired`
- Auth: required
- Body: none
- Flags: none
- Output: list path `expireSoonLicenses`; columns `name`, `id`, `expiredAt`, `level`, `module`, `status`

### `dc global-management gproductlicenses get-g-product-licenses-yaml`

- Summary: GProductLicenses_GetGProductLicensesYaml
- HTTP: `GET /apis/ghippo.io/v1alpha1/gproduct-licenses/yaml`
- Auth: required
- Body: none
- Flags: none

### `dc global-management gproductlicenses update-g-product-licenses`

- Summary: GProductLicenses_UpdateGProductLicenses
- HTTP: `PUT /apis/ghippo.io/v1alpha1/gproduct-licenses`
- Auth: required
- Body: required
- Flags: none
- Output: list path `licenses`; columns `name`, `id`, `expiredAt`, `level`, `module`, `status`

## Group

### `dc global-management group add-user-to-group`

- Summary: Group_AddUserToGroup
- HTTP: `POST /apis/ghippo.io/v1alpha1/groups/{id}/members/{userId}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--user-id` (path, required): userId

### `dc global-management group create-group`

- Summary: Create a user group
- HTTP: `POST /apis/ghippo.io/v1alpha1/groups`
- Auth: required
- Body: required
- Flags: none
- Example:

```
dc global-management group create-group \
  --set name=dev-team \
  --set description="Development team"
```

### `dc global-management group delete-group`

- Summary: Delete a user group
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/groups/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management group delete-user-from-group`

- Summary: Group_DeleteUserFromGroup
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/groups/{id}/members/{userId}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--user-id` (path, required): userId

### `dc global-management group get-group`

- Summary: Get group details
- HTTP: `GET /apis/ghippo.io/v1alpha1/groups/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management group group-members`

- Summary: Group_GroupMembers
- HTTP: `GET /apis/ghippo.io/v1alpha1/groups/{id}/members`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--search` (query): 搜索关键字
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
- Output: list path `items`; columns `name`, `id`, `createdAt`, `description`, `email`, `updatedAt`; pagination `offset`

### `dc global-management group list-group-roles`

- Summary: Group_ListGroupRoles
- HTTP: `GET /apis/ghippo.io/v1alpha1/groups/{id}/roles`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--search` (query): 搜索关键字
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
  - `--type` (query): role type
  - `--authorized` (query): 是否授权
- Output: list path `items`; columns `name`, `type`, `authorized`, `createdAt`, `description`, `updatedAt`; pagination `offset`

### `dc global-management group list-group-subjects`

- Summary: Group_ListGroupSubjects
- HTTP: `GET /apis/ghippo.io/v1alpha1/groups/{id}/subjects`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--search` (query): search
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `type`, `id`, `roleId`, `roleName`, `subjectName`; pagination `offset`

### `dc global-management group list-groups`

- Summary: List user groups
- HTTP: `GET /apis/ghippo.io/v1alpha1/groups`
- Auth: required
- Body: none
- Flags:
  - `--search` (query): 搜索关键字
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
- Output: list path `items`; columns `name`, `id`, `canAuthorize`, `createdAt`, `description`, `userCount`; pagination `offset`

### `dc global-management group update-group`

- Summary: Update a user group
- HTTP: `PUT /apis/ghippo.io/v1alpha1/groups/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Example:

```
dc global-management group update-group --id <id> \
  --set name=dev-team-renamed \
  --set description="Renamed team"
```

### `dc global-management group update-group-roles`

- Summary: Group_UpdateGroupRoles
- HTTP: `PUT /apis/ghippo.io/v1alpha1/groups/{id}/roles`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id

## IDP

### `dc global-management idp create-idp`

- Summary: IDP_CreateIDP
- HTTP: `POST /apis/ghippo.io/v1alpha1/idp`
- Auth: required
- Body: required
- Flags: none

### `dc global-management idp delete-idp`

- Summary: IDP_DeleteIDP
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/idp/{alias}`
- Auth: required
- Body: none
- Flags:
  - `--alias` (path, required): alias

### `dc global-management idp get-idp`

- Summary: IDP_GetIDP
- HTTP: `GET /apis/ghippo.io/v1alpha1/idp/{alias}`
- Auth: required
- Body: none
- Flags:
  - `--alias` (path, required): alias

### `dc global-management idp get-redirect-url`

- Summary: IDP_GetRedirectUrl
- HTTP: `GET /apis/ghippo.io/v1alpha1/idp/{alias}/redirect-url`
- Auth: required
- Body: none
- Flags:
  - `--alias` (path, required): alias

### `dc global-management idp get-well-known-url`

- Summary: IDP_GetWellKnownUrl
- HTTP: `GET /apis/ghippo.io/v1alpha1/idp/wellknown-url`
- Auth: required
- Body: none
- Flags: none

### `dc global-management idp import-open-id-configuration`

- Summary: IDP_ImportOpenIdConfiguration
- HTTP: `GET /apis/ghippo.io/v1alpha1/idp/import-openid-configuration`
- Auth: required
- Body: none
- Flags:
  - `--url` (query): url

### `dc global-management idp list-id-ps`

- Summary: IDP_ListIDPs
- HTTP: `GET /apis/ghippo.io/v1alpha1/idp`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `alias`, `authorizationUrl`, `clientAuthentications`, `clientId`, `clientSecret`, `displayName`

### `dc global-management idp update-idp`

- Summary: IDP_UpdateIDP
- HTTP: `PUT /apis/ghippo.io/v1alpha1/idp/{alias}`
- Auth: required
- Body: required
- Flags:
  - `--alias` (path, required): alias

## KeycloakEvent

### `dc global-management keycloakevent keycloak-event`

- Summary: KeycloakEvent_KeycloakEvent
- HTTP: `POST /apis/ghippo.io/v1alpha1/keycloak-event`
- Auth: required
- Body: required
- Flags: none

## Ldap

### `dc global-management ldap create-ldap`

- Summary: Ldap_CreateLdap
- HTTP: `POST /apis/ghippo.io/v1alpha2/ldap`
- Auth: required
- Body: required
- Flags: none

### `dc global-management ldap create-ldap-group`

- Summary: Ldap_CreateLdapGroup
- HTTP: `POST /apis/ghippo.io/v1alpha2/ldaps/{id}/group`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id

### `dc global-management ldap delete-ldap`

- Summary: Ldap_DeleteLdap
- HTTP: `DELETE /apis/ghippo.io/v1alpha2/ldaps/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management ldap delete-ldap-group`

- Summary: Ldap_DeleteLdapGroup
- HTTP: `DELETE /apis/ghippo.io/v1alpha2/ldaps/{ldapId}/group/{id}`
- Auth: required
- Body: none
- Flags:
  - `--ldap-id` (path, required): ldapId
  - `--id` (path, required): id

### `dc global-management ldap get-ldap`

- Summary: Ldap_GetLdap
- HTTP: `GET /apis/ghippo.io/v1alpha2/ldaps/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management ldap get-ldap-group`

- Summary: Ldap_GetLdapGroup
- HTTP: `GET /apis/ghippo.io/v1alpha2/ldaps/{id}/group`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management ldap list-ldaps`

- Summary: Ldap_ListLdaps
- HTTP: `GET /apis/ghippo.io/v1alpha2/ldaps`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `name`, `id`, `enabled`, `vendor`

### `dc global-management ldap sync-ldap-groups`

- Summary: Ldap_SyncLdapGroups
- HTTP: `GET /apis/ghippo.io/v1alpha2/ldaps/{ldapId}/group/{id}/sync`
- Auth: required
- Body: none
- Flags:
  - `--ldap-id` (path, required): ldapId
  - `--id` (path, required): id

### `dc global-management ldap sync-users`

- Summary: Ldap_SyncUsers
- HTTP: `GET /apis/ghippo.io/v1alpha2/ldaps/{id}/sync`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management ldap test-ldap-authentication`

- Summary: Ldap_TestLdapAuthentication
- HTTP: `POST /apis/ghippo.io/v1alpha2/testLdapAuthentication`
- Auth: required
- Body: required
- Flags: none

### `dc global-management ldap test-ldap-connection`

- Summary: Ldap_TestLdapConnection
- HTTP: `POST /apis/ghippo.io/v1alpha2/testLdapConnection`
- Auth: required
- Body: required
- Flags: none

### `dc global-management ldap update-ldap`

- Summary: Ldap_UpdateLdap
- HTTP: `PUT /apis/ghippo.io/v1alpha2/ldaps/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id

### `dc global-management ldap update-ldap-group`

- Summary: Ldap_UpdateLdapGroup
- HTTP: `PUT /apis/ghippo.io/v1alpha2/ldaps/{ldapId}/group/{id}`
- Auth: required
- Body: required
- Flags:
  - `--ldap-id` (path, required): ldapId
  - `--id` (path, required): id

## Login

### `dc global-management login check-session-limit`

- Summary: Login_CheckSessionLimit
- HTTP: `POST /apis/ghippo.io/v1alpha1/session-limit`
- Auth: required
- Body: required
- Flags: none

### `dc global-management login oidc-login`

- Summary: Login_OIDCLogin
- HTTP: `POST /apis/ghippo.io/v1alpha1/login`
- Auth: required
- Body: required
- Flags: none

### `dc global-management login oidc-logout`

- Summary: Login_OIDCLogout
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/logout`
- Auth: required
- Body: none
- Flags: none

### `dc global-management login redirect-login`

- Summary: Login_RedirectLogin
- HTTP: `GET /apis/ghippo.io/v1alpha1/login`
- Auth: required
- Body: none
- Flags:
  - `--callback-url` (query): callbackUrl

### `dc global-management login refresh-token`

- Summary: Login_RefreshToken
- HTTP: `POST /apis/ghippo.io/v1alpha1/refresh-token`
- Auth: required
- Body: required
- Flags: none

## LoginPage

### `dc global-management loginpage get-info`

- Summary: LoginPage_GetInfo
- HTTP: `GET /apis/ghippo.io/v1alpha1/login-page/info`
- Auth: required
- Body: none
- Flags: none

### `dc global-management loginpage get-login-page-logo-redirect-url`

- Summary: LoginPage_GetLoginPageLogoRedirectURL
- HTTP: `GET /apis/ghippo.io/v1alpha1/login-page/logo-redirect-url`
- Auth: required
- Body: none
- Flags: none

### `dc global-management loginpage get-privacy-policy`

- Summary: LoginPage_GetPrivacyPolicy
- HTTP: `GET /apis/ghippo.io/v1alpha1/login-page/privacy`
- Auth: required
- Body: none
- Flags: none

### `dc global-management loginpage get-support-qr-code`

- Summary: LoginPage_GetSupportQRCode
- HTTP: `GET /apis/ghippo.io/v1alpha1/login-page/support_qrcode`
- Auth: required
- Body: none
- Flags: none

### `dc global-management loginpage get-terms-of-services`

- Summary: LoginPage_GetTermsOfServices
- HTTP: `GET /apis/ghippo.io/v1alpha1/login-page/terms`
- Auth: required
- Body: none
- Flags: none

### `dc global-management loginpage get-version`

- Summary: LoginPage_GetVersion
- HTTP: `GET /apis/ghippo.io/v1alpha1/login-page/version`
- Auth: required
- Body: none
- Flags: none

### `dc global-management loginpage reset-info`

- Summary: LoginPage_ResetInfo
- HTTP: `POST /apis/ghippo.io/v1alpha1/login-page/reset`
- Auth: required
- Body: none
- Flags: none

### `dc global-management loginpage update-info`

- Summary: LoginPage_UpdateInfo
- HTTP: `PUT /apis/ghippo.io/v1alpha1/login-page/info`
- Auth: required
- Body: required
- Flags: none

## Message

### `dc global-management message delete-messages`

- Summary: Message_DeleteMessages
- HTTP: `POST /apis/ghippo.io/v1alpha1/messages/delete`
- Auth: required
- Body: required
- Flags: none

### `dc global-management message get-message`

- Summary: Message_GetMessage
- HTTP: `GET /apis/ghippo.io/v1alpha1/messages/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required, int32): id

### `dc global-management message get-messages-count`

- Summary: Message_GetMessagesCount
- HTTP: `GET /apis/ghippo.io/v1alpha1/messages/count`
- Auth: required
- Body: none
- Flags: none

### `dc global-management message get-system-message`

- Summary: Message_GetSystemMessage
- HTTP: `GET /apis/ghippo.io/v1alpha1/messages/system/system-message`
- Auth: required
- Body: none
- Flags: none

### `dc global-management message list-messages`

- Summary: List platform messages/notifications
- HTTP: `GET /apis/ghippo.io/v1alpha1/messages`
- Auth: required
- Body: none
- Flags:
  - `--unread-count` (query): 是否只返回统计未读数量
  - `--search` (query): 搜索关键字
  - `--read` (query, default `all`, one of: all|read|unread): 是否只返回已读或未读，传"read"或"unread"来区分，不传返回已读和未读的消息
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
- Output: list path `items`; columns `type`, `id`, `createdAt`, `message`, `read`, `subject`; pagination `offset`

### `dc global-management message set-read-messages`

- Summary: Message_SetReadMessages
- HTTP: `POST /apis/ghippo.io/v1alpha1/read-messages`
- Auth: required
- Body: required
- Flags: none

### `dc global-management message toggle-unread-message`

- Summary: Message_ToggleUnreadMessage
- HTTP: `GET /apis/ghippo.io/v1alpha1/messages/toggle-unread`
- Auth: required
- Body: none
- Flags:
  - `--id` (query, int32): id
  - `--next` (query): next

## OIDC

### `dc global-management oidc oidc-logout`

- Summary: OIDC_OIDCLogout
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/oidc/logout`
- Auth: required
- Body: none
- Flags: none

### `dc global-management oidc oidc-token`

- Summary: OIDC_OIDCToken
- HTTP: `POST /apis/ghippo.io/v1alpha1/oidc/token`
- Auth: required
- Body: required
- Flags: none

### `dc global-management oidc oidc-user-info`

- Summary: OIDC_OIDCUserInfo
- HTTP: `GET /apis/ghippo.io/v1alpha1/oidc/userinfo`
- Auth: required
- Body: none
- Flags: none

### `dc global-management oidc redirect-frontend-logout`

- Summary: OIDC_RedirectFrontendLogout
- HTTP: `GET /apis/ghippo.io/v1alpha1/oidc/logout`
- Auth: required
- Body: none
- Flags: none

### `dc global-management oidc well-known`

- Summary: OIDC_WellKnown
- HTTP: `GET /apis/ghippo.io/v1alpha1/.well-known/openid-configuration`
- Auth: required
- Body: none
- Flags: none
- Output: list path `idTokenSigningAlgValuesSupported`

## Oauth2

### `dc global-management oauth2 create-oauth2`

- Summary: Oauth2_CreateOauth2
- HTTP: `POST /apis/ghippo.io/v1alpha1/oauth2`
- Auth: required
- Body: required
- Flags: none

### `dc global-management oauth2 delete-oauth2`

- Summary: Oauth2_DeleteOauth2
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/oauth2`
- Auth: required
- Body: none
- Flags:
  - `--provider-type` (query, default `wechatwork`, one of: wechatwork): providerType

### `dc global-management oauth2 get-oauth2`

- Summary: Oauth2_GetOauth2
- HTTP: `GET /apis/ghippo.io/v1alpha1/oauth2`
- Auth: required
- Body: none
- Flags: none

### `dc global-management oauth2 get-oauth2redirect-domain`

- Summary: Oauth2_GetOauth2RedirectDomain
- HTTP: `GET /apis/ghippo.io/v1alpha1/oauth2/redirect-domain`
- Auth: required
- Body: none
- Flags: none

### `dc global-management oauth2 update-oauth2`

- Summary: Oauth2_UpdateOauth2
- HTTP: `PUT /apis/ghippo.io/v1alpha1/oauth2`
- Auth: required
- Body: required
- Flags: none

## Openapi

### `dc global-management openapi auth-token`

- Summary: Openapi_AuthToken
- HTTP: `GET /apis/ghippo.io/v1alpha1/auth-token`
- Auth: required
- Body: none
- Flags: none

### `dc global-management openapi certs`

- Summary: Openapi_Certs
- HTTP: `GET /apis/ghippo.io/v1alpha1/certs`
- Auth: required
- Body: none
- Flags: none
- Output: list path `keys`; columns `alg`, `e`, `kid`, `kty`, `n`, `use`

## ProductNavigator

### `dc global-management productnavigator info`

- Summary: ProductNavigator_Info
- HTTP: `GET /apis/ghippo.io/v1alpha1/product-nav/info`
- Auth: required
- Body: none
- Flags: none
- Output: list path `categories`; columns `name`

## Publish

### `dc global-management publish publish-message`

- Summary: Publish_PublishMessage
- HTTP: `POST /apis/ghippo.io/v1alpha1/publish/messages`
- Auth: required
- Body: required
- Flags: none

## Register

### `dc global-management register redirect-register`

- Summary: Register_RedirectRegister
- HTTP: `GET /apis/ghippo.io/v1alpha1/register`
- Auth: required
- Body: none
- Flags:
  - `--callback-url` (query): callbackUrl
  - `--invite-code` (query): inviteCode

## Role

### `dc global-management role check-role-name`

- Summary: Role_CheckRoleName
- HTTP: `GET /apis/ghippo.io/v1alpha1/roles/check-role-name/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name

### `dc global-management role create-role`

- Summary: Create a custom role
- HTTP: `POST /apis/ghippo.io/v1alpha1/roles`
- Auth: required
- Body: required
- Flags: none
- Example:

```
# scope: platform | folder | workspace
echo '{
  "name": "my-role",
  "description": "Custom role",
  "scope": "platform",
  "perms": [
    {"gproduct": "ghippo", "resourceType": "User", "action": "get"}
  ]
}' | dc global-management role create-role --file -
```

### `dc global-management role delete-role`

- Summary: Delete a custom role
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/roles/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name

### `dc global-management role get-role`

- Summary: Get role details
- HTTP: `GET /apis/ghippo.io/v1alpha1/roles/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
- Output: list path `gproductPerms`

### `dc global-management role get-role-member-count`

- Summary: Role_GetRoleMemberCount
- HTTP: `GET /apis/ghippo.io/v1alpha1/roles/role-member-count/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name

### `dc global-management role list-all-permissions`

- Summary: List all available permissions
- HTTP: `GET /apis/ghippo.io/v1alpha1/permissions`
- Auth: required
- Body: none
- Flags: none
- Output: list path `gproductPerms`

### `dc global-management role list-folder-role-names`

- Summary: Role_ListFolderRoleNames
- HTTP: `GET /apis/ghippo.io/v1alpha1/folderrolenames`
- Auth: required
- Body: none
- Flags:
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--search` (query): search
- Output: list path `items`; columns `name`, `authScope`, `description`; pagination `offset`

### `dc global-management role list-members-by-platform-role`

- Summary: Role_ListMembersByPlatformRole
- HTTP: `GET /apis/ghippo.io/v1alpha1/platformroles/{name}/members`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--search` (query): search
- Output: list path `items`; columns `name`, `type`, `id`; pagination `offset`

### `dc global-management role list-members-folders-by-folder-role`

- Summary: Role_ListMembersFoldersByFolderRole
- HTTP: `GET /apis/ghippo.io/v1alpha1/folderroles/{name}/members-folders`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--search` (query): search
- Output: list path `items`; columns `folderAlias`, `folderId`, `memberId`, `memberName`, `memberType`; pagination `offset`

### `dc global-management role list-members-workspaces-by-workspace-role`

- Summary: Role_ListMembersWorkspacesByWorkspaceRole
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaceroles/{name}/members-workspaces`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--search` (query): search
- Output: list path `items`; columns `memberId`, `memberName`, `memberType`, `workspaceAlias`, `workspaceId`; pagination `offset`

### `dc global-management role list-roles`

- Summary: List platform roles
- HTTP: `GET /apis/ghippo.io/v1alpha1/roles`
- Auth: required
- Body: none
- Flags:
  - `--search` (query): 搜索关键字
  - `--page-size` (query, default `20`, int32): 每页条数
  - `--page` (query, default `1`, int32): 当前页
  - `--role-type` (query, default `query_all_role_type`, one of: query_all_role_type|query_system|query_custom): roleType
  - `--scope` (query, default `query_all_auth_scope`, one of: query_all_auth_scope|query_platform|query_folder|query_workspace): scope
- Output: list path `items`; columns `name`, `type`, `createdAt`, `description`, `scope`, `updatedAt`; pagination `offset`

### `dc global-management role list-workspace-role-names`

- Summary: Role_ListWorkspaceRoleNames
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspacerolenames`
- Auth: required
- Body: none
- Flags:
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--search` (query): search
- Output: list path `items`; columns `name`, `authScope`, `description`; pagination `offset`

### `dc global-management role update-role`

- Summary: Update a custom role
- HTTP: `PUT /apis/ghippo.io/v1alpha1/roles/{name}`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): name
- Example:

```
echo '{
  "description": "Updated description",
  "perms": [
    {"gproduct": "ghippo", "resourceType": "User", "action": "get"}
  ]
}' | dc global-management role update-role --name <name> --file -
```

## SecurityPolicy

### `dc global-management securitypolicy get-account-lockout-policy`

- Summary: SecurityPolicy_GetAccountLockoutPolicy
- HTTP: `GET /apis/ghippo.io/v1alpha1/securitypolicy/accountlockout`
- Auth: required
- Body: none
- Flags: none

### `dc global-management securitypolicy get-logout-policy`

- Summary: SecurityPolicy_GetLogoutPolicy
- HTTP: `GET /apis/ghippo.io/v1alpha1/securitypolicy/logout`
- Auth: required
- Body: none
- Flags: none

### `dc global-management securitypolicy get-mfa`

- Summary: SecurityPolicy_GetMFA
- HTTP: `GET /apis/ghippo.io/v1alpha1/securitypolicy/mfa`
- Auth: required
- Body: none
- Flags: none

### `dc global-management securitypolicy get-password-policy`

- Summary: SecurityPolicy_GetPasswordPolicy
- HTTP: `GET /apis/ghippo.io/v1alpha1/securitypolicy/password`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `type`, `value`

### `dc global-management securitypolicy get-session-timeout`

- Summary: SecurityPolicy_GetSessionTimeout
- HTTP: `GET /apis/ghippo.io/v1alpha1/securitypolicy/sessiontimeout`
- Auth: required
- Body: none
- Flags: none

### `dc global-management securitypolicy get-system-session-limit`

- Summary: SecurityPolicy_GetSystemSessionLimit
- HTTP: `GET /apis/ghippo.io/v1alpha1/securitypolicy/sessionlimit/system`
- Auth: required
- Body: none
- Flags: none

### `dc global-management securitypolicy get-time-session-limit`

- Summary: SecurityPolicy_GetTimeSessionLimit
- HTTP: `GET /apis/ghippo.io/v1alpha1/securitypolicy/sessionlimit/time`
- Auth: required
- Body: none
- Flags: none

### `dc global-management securitypolicy get-user-session-limit`

- Summary: SecurityPolicy_GetUserSessionLimit
- HTTP: `GET /apis/ghippo.io/v1alpha1/securitypolicy/sessionlimit/user`
- Auth: required
- Body: none
- Flags: none

### `dc global-management securitypolicy set-account-lockout-policy`

- Summary: SecurityPolicy_SetAccountLockoutPolicy
- HTTP: `PUT /apis/ghippo.io/v1alpha1/securitypolicy/accountlockout`
- Auth: required
- Body: required
- Flags: none

### `dc global-management securitypolicy set-logout-policy`

- Summary: SecurityPolicy_SetLogoutPolicy
- HTTP: `PUT /apis/ghippo.io/v1alpha1/securitypolicy/logout`
- Auth: required
- Body: required
- Flags: none

### `dc global-management securitypolicy set-mfa`

- Summary: SecurityPolicy_SetMFA
- HTTP: `PUT /apis/ghippo.io/v1alpha1/securitypolicy/mfa`
- Auth: required
- Body: required
- Flags: none

### `dc global-management securitypolicy set-password-policy`

- Summary: SecurityPolicy_SetPasswordPolicy
- HTTP: `PUT /apis/ghippo.io/v1alpha1/securitypolicy/password`
- Auth: required
- Body: required
- Flags: none

### `dc global-management securitypolicy set-session-timeout`

- Summary: SecurityPolicy_SetSessionTimeout
- HTTP: `PUT /apis/ghippo.io/v1alpha1/securitypolicy/sessiontimeout`
- Auth: required
- Body: required
- Flags: none

### `dc global-management securitypolicy set-system-session-limit`

- Summary: SecurityPolicy_SetSystemSessionLimit
- HTTP: `PUT /apis/ghippo.io/v1alpha1/securitypolicy/sessionlimit/system`
- Auth: required
- Body: required
- Flags: none

### `dc global-management securitypolicy set-time-session-limit`

- Summary: SecurityPolicy_SetTimeSessionLimit
- HTTP: `PUT /apis/ghippo.io/v1alpha1/securitypolicy/sessionlimit/time`
- Auth: required
- Body: required
- Flags: none

### `dc global-management securitypolicy set-user-session-limit`

- Summary: SecurityPolicy_SetUserSessionLimit
- HTTP: `PUT /apis/ghippo.io/v1alpha1/securitypolicy/sessionlimit/user`
- Auth: required
- Body: required
- Flags: none

## Sms

### `dc global-management sms batch-create-sms-templates-by-domain`

- Summary: Sms_BatchCreateSmsTemplatesByDomain
- HTTP: `POST /apis/ghippo.io/v1alpha1/sms/template/batch-by-domain`
- Auth: required
- Body: required
- Flags: none

### `dc global-management sms create-sms-template`

- Summary: Sms_CreateSmsTemplate
- HTTP: `POST /apis/ghippo.io/v1alpha1/sms/template`
- Auth: required
- Body: required
- Flags: none

### `dc global-management sms list-sms-template`

- Summary: Sms_ListSmsTemplate
- HTTP: `GET /apis/ghippo.io/v1alpha1/sms/template`
- Auth: required
- Body: none
- Flags:
  - `--template` (query): template
  - `--domain` (query): domain
  - `--channel` (query): channel
  - `--channel-template` (query): channelTemplate
- Output: list path `items`; columns `id`, `channel`, `channelTemplate`, `domain`, `enable`, `template`

### `dc global-management sms send-verification-code`

- Summary: Sms_SendVerificationCode
- HTTP: `POST /apis/ghippo.io/v1alpha1/sms/verification`
- Auth: required
- Body: required
- Flags: none

## SmtpSetting

### `dc global-management smtpsetting get-smtp-server`

- Summary: SmtpSetting_GetSmtpServer
- HTTP: `GET /apis/ghippo.io/v1alpha1/smtp-setting`
- Auth: required
- Body: none
- Flags: none

### `dc global-management smtpsetting set-smtp-server`

- Summary: SmtpSetting_SetSmtpServer
- HTTP: `PUT /apis/ghippo.io/v1alpha1/smtp-setting`
- Auth: required
- Body: required
- Flags: none

### `dc global-management smtpsetting smtp-server-conn-test`

- Summary: SmtpSetting_SmtpServerConnTest
- HTTP: `POST /apis/ghippo.io/v1alpha1/smtp-setting/conn-test`
- Auth: required
- Body: required
- Flags: none

## Theme

### `dc global-management theme get-footer-theme-config`

- Summary: Theme_GetFooterThemeConfig
- HTTP: `GET /apis/ghippo.io/v1alpha1/themes/footer-theme`
- Auth: required
- Body: none
- Flags: none

### `dc global-management theme get-login-theme-config`

- Summary: Theme_GetLoginThemeConfig
- HTTP: `GET /apis/ghippo.io/v1alpha1/themes/login_page`
- Auth: required
- Body: none
- Flags: none

### `dc global-management theme get-login-theme-css`

- Summary: Theme_GetLoginThemeCSS
- HTTP: `GET /apis/ghippo.io/v1alpha1/themes/login_page.css`
- Auth: required
- Body: none
- Flags: none
- Output: list path `extensions`; columns `@type`

### `dc global-management theme get-theme-config`

- Summary: Theme_GetThemeConfig
- HTTP: `GET /apis/ghippo.io/v1alpha1/themes/theme`
- Auth: required
- Body: none
- Flags: none

### `dc global-management theme get-theme-css`

- Summary: Theme_GetThemeCSS
- HTTP: `GET /apis/ghippo.io/v1alpha1/themes/theme.css`
- Auth: required
- Body: none
- Flags: none
- Output: list path `extensions`; columns `@type`

### `dc global-management theme reset-footer-theme-config`

- Summary: Theme_ResetFooterThemeConfig
- HTTP: `POST /apis/ghippo.io/v1alpha1/themes/footer/reset`
- Auth: required
- Body: none
- Flags: none

### `dc global-management theme reset-login-theme-config`

- Summary: Theme_ResetLoginThemeConfig
- HTTP: `POST /apis/ghippo.io/v1alpha1/themes/login_page/reset`
- Auth: required
- Body: none
- Flags: none

### `dc global-management theme reset-theme-config`

- Summary: Theme_ResetThemeConfig
- HTTP: `POST /apis/ghippo.io/v1alpha1/themes/theme/reset`
- Auth: required
- Body: none
- Flags: none

### `dc global-management theme set-footer-theme-config`

- Summary: Theme_SetFooterThemeConfig
- HTTP: `POST /apis/ghippo.io/v1alpha1/themes/footer-theme`
- Auth: required
- Body: required
- Flags: none

### `dc global-management theme set-login-theme-config`

- Summary: Theme_SetLoginThemeConfig
- HTTP: `POST /apis/ghippo.io/v1alpha1/themes/login_page`
- Auth: required
- Body: required
- Flags: none

### `dc global-management theme set-theme-config`

- Summary: Theme_SetThemeConfig
- HTTP: `POST /apis/ghippo.io/v1alpha1/themes/theme`
- Auth: required
- Body: required
- Flags: none

## TopNavigator

### `dc global-management topnavigator info`

- Summary: TopNavigator_Info
- HTTP: `GET /apis/ghippo.io/v1alpha1/top-nav/info`
- Auth: required
- Body: none
- Flags: none

### `dc global-management topnavigator reset-top-nav`

- Summary: TopNavigator_ResetTopNav
- HTTP: `POST /apis/ghippo.io/v1alpha1/top-nav/reset`
- Auth: required
- Body: none
- Flags: none

### `dc global-management topnavigator set-top-nav`

- Summary: TopNavigator_SetTopNav
- HTTP: `POST /apis/ghippo.io/v1alpha1/top-nav`
- Auth: required
- Body: required
- Flags: none

## Users

### `dc global-management users check-user`

- Summary: Users_CheckUser
- HTTP: `GET /apis/ghippo.io/v1alpha1/users/check/{username}`
- Auth: required
- Body: none
- Flags:
  - `--username` (path, required): username

### `dc global-management users check-user-email`

- Summary: Users_CheckUserEmail
- HTTP: `GET /apis/ghippo.io/v1alpha1/users/check-user-email/{username}`
- Auth: required
- Body: none
- Flags:
  - `--username` (path, required): username

### `dc global-management users create-user`

- Summary: Create a new platform user
- HTTP: `POST /apis/ghippo.io/v1alpha1/users`
- Auth: required
- Body: required
- Flags: none
- Example:

```
dc global-management users create-user \
  --set name=alice \
  --set password=changeme \
  --set description="Alice from dev team" \
  --set temporary=false
```

### `dc global-management users create-user-access-token`

- Summary: Create an access token for a user
- HTTP: `POST /apis/ghippo.io/v1alpha1/users/{id}/accesstoken`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Example:

```
dc global-management users create-user-access-token --id <id> \
  --set name=my-token \
  --set expiredAt=2026-12-31T00:00:00Z
```

### `dc global-management users create-user-without-password`

- Summary: Users_CreateUserWithoutPassword
- HTTP: `POST /apis/ghippo.io/v1alpha1/users/without-password`
- Auth: required
- Body: required
- Flags: none

### `dc global-management users delete-user`

- Summary: Delete a user by ID
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/users/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management users delete-user-access-token`

- Summary: Delete an access token
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/users/{id}/accesstokens/{aid}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--aid` (path, required): aid

### `dc global-management users get-user`

- Summary: Get user details by ID
- HTTP: `GET /apis/ghippo.io/v1alpha1/users/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management users get-user-by-name`

- Summary: Users_GetUserByName
- HTTP: `GET /apis/ghippo.io/v1alpha1/users/username/{username}`
- Auth: required
- Body: none
- Flags:
  - `--username` (path, required): username

### `dc global-management users list-user-access-tokens`

- Summary: List access tokens for a user
- HTTP: `GET /apis/ghippo.io/v1alpha1/users/{id}/accesstokens`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `items`; columns `name`, `id`, `createdAt`, `expiredAt`, `updatedAt`

### `dc global-management users list-user-groups`

- Summary: List groups a user belongs to
- HTTP: `GET /apis/ghippo.io/v1alpha1/users/{id}/groups`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--search` (query): 搜索关键字
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
- Output: list path `items`; columns `name`, `id`; pagination `offset`

### `dc global-management users list-user-roles`

- Summary: List roles assigned to a user
- HTTP: `GET /apis/ghippo.io/v1alpha1/users/{id}/roles`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--search` (query): 搜索关键字
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
  - `--type` (query): role type
  - `--authorized` (query): 是否授权
- Output: list path `items`; columns `name`, `type`, `authorized`, `createdAt`, `description`, `updatedAt`; pagination `offset`

### `dc global-management users list-user-subjects`

- Summary: Users_ListUserSubjects
- HTTP: `GET /apis/ghippo.io/v1alpha1/users/{id}/subjects`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--search` (query): search
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `type`, `id`, `roleName`, `subjectName`; pagination `offset`

### `dc global-management users list-users`

- Summary: List platform users
- HTTP: `GET /apis/ghippo.io/v1alpha1/users`
- Auth: required
- Body: none
- Flags:
  - `--search` (query): 搜索关键字
  - `--page-size` (query, default `20`, int32): Number of results per page
  - `--page` (query, default `1`, int32): 当前页, 大于等于 0，小于等于 1000
- Output: list path `items`; columns `name`, `id`, `canAuthorize`, `createdAt`, `description`, `email`; pagination `offset`
- Example:

```
dc global-management users list-users
dc global-management users list-users --page-size 50 -o json
```

### `dc global-management users reset-user-mfa`

- Summary: Users_ResetUserMFA
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/users/{id}/mfa`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id

### `dc global-management users set-user-password`

- Summary: Set or reset a user's password
- HTTP: `PUT /apis/ghippo.io/v1alpha1/users/{id}/password`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Example:

```
dc global-management users set-user-password --id <id> \
  --set password=NewP@ssw0rd
```

### `dc global-management users update-user`

- Summary: Update user profile
- HTTP: `PUT /apis/ghippo.io/v1alpha1/users/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Example:

```
dc global-management users update-user --id <id> \
  --set email=newemail@example.com \
  --set firstname=Alice \
  --set lastname=Smith \
  --set description="updated" \
  --set enabled=true
```

### `dc global-management users update-user-certify`

- Summary: Users_UpdateUserCertify
- HTTP: `PUT /apis/ghippo.io/v1alpha1/users/certify`
- Auth: required
- Body: required
- Flags: none

### `dc global-management users update-user-roles`

- Summary: Assign or update roles for a user
- HTTP: `PUT /apis/ghippo.io/v1alpha1/users/{id}/roles`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Example:

```
# Add roles
echo '{"addRoles":["Admin"],"removeRoles":[]}' | \
  dc global-management users update-user-roles --id <id> --file -
# Remove roles
echo '{"addRoles":[],"removeRoles":["Editor"]}' | \
  dc global-management users update-user-roles --id <id> --file -
```

## Webhook

### `dc global-management webhook create-webhook`

- Summary: 接入管理
- HTTP: `POST /apis/ghippo.io/v1alpha1/webhook`
- Auth: required
- Body: required
- Flags: none

### `dc global-management webhook create-webhook-endpoint`

- Summary: Webhook_CreateWebhookEndpoint
- HTTP: `POST /apis/ghippo.io/v1alpha1/webhook-endpoint`
- Auth: required
- Body: required
- Flags: none

### `dc global-management webhook delete-webhook`

- Summary: Webhook_DeleteWebhook
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/webhook/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required, int32): id

### `dc global-management webhook delete-webhook-endpoint`

- Summary: Webhook_DeleteWebhookEndpoint
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/webhook-endpoint/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required, int32): id

### `dc global-management webhook get-webhook`

- Summary: Webhook_GetWebhook
- HTTP: `GET /apis/ghippo.io/v1alpha1/webhook/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required, int32): id

### `dc global-management webhook get-webhook-record`

- Summary: Webhook_GetWebhookRecord
- HTTP: `GET /apis/ghippo.io/v1alpha1/webhook-record/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required, int32): id

### `dc global-management webhook list-gproduct-webhook-events`

- Summary: Webhook_ListGproductWebhookEvents
- HTTP: `GET /apis/ghippo.io/v1alpha1/gproduct-webhook-events`
- Auth: required
- Body: none
- Flags: none
- Output: list path `gEvents`; columns `name`, `localizedName`

### `dc global-management webhook list-webhook-endpoint-events`

- Summary: Webhook_ListWebhookEndpointEvents
- HTTP: `GET /apis/ghippo.io/v1alpha1/webhook-endpoint/{id}/events`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required, int32): id
  - `--event-name` (query): eventName
  - `--gproduct` (query): gproduct
  - `--object-name` (query): objectName
  - `--page-size` (query, default `20`, int32): pageSize
  - `--page` (query, default `1`, int32): page
- Output: list path `items`; columns `body`, `eventName`, `gproduct`, `headers`, `method`, `objectName`; pagination `offset`

### `dc global-management webhook list-webhook-endpoints`

- Summary: Webhook_ListWebhookEndpoints
- HTTP: `GET /apis/ghippo.io/v1alpha1/webhook-endpoints`
- Auth: required
- Body: none
- Flags:
  - `--domain` (query): domain
  - `--url` (query): url
  - `--name` (query): name
  - `--enabled` (query): enabled
  - `--page-size` (query, default `20`, int32): pageSize
  - `--page` (query, default `1`, int32): page
- Output: list path `items`; columns `name`, `id`, `createdAt`, `domain`, `enabled`, `endpoint`; pagination `offset`

### `dc global-management webhook list-webhook-records-by-client-id`

- Summary: Webhook_ListWebhookRecordsByClientId
- HTTP: `GET /apis/ghippo.io/v1alpha1/webhook-record`
- Auth: required
- Body: none
- Flags:
  - `--client-id` (query): clientId
  - `--search` (query): search
  - `--status` (query, default `all`, one of: all|successful|failed): status
  - `--page-size` (query, default `20`, int32): pageSize
  - `--page` (query, default `1`, int32): page
- Output: list path `items`; columns `id`, `action`, `clientId`, `errMessage`, `eventData`, `eventTime`; pagination `offset`

### `dc global-management webhook list-webhooks-by-client-id`

- Summary: Webhook_ListWebhooksByClientId
- HTTP: `GET /apis/ghippo.io/v1alpha1/webhook`
- Auth: required
- Body: none
- Flags:
  - `--search` (query): search
  - `--page-size` (query, default `20`, int32): pageSize
  - `--page` (query, default `1`, int32): page
  - `--client-id` (query): clientId
- Output: list path `items`; columns `name`, `id`, `action`, `clientId`, `createdAt`, `headers`; pagination `offset`

### `dc global-management webhook update-webhook`

- Summary: Webhook_UpdateWebhook
- HTTP: `PUT /apis/ghippo.io/v1alpha1/webhook/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required, int32): id

### `dc global-management webhook update-webhook-endpoint`

- Summary: Webhook_UpdateWebhookEndpoint
- HTTP: `PUT /apis/ghippo.io/v1alpha1/webhook-endpoint/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required, int32): id

### `dc global-management webhook webhook-endpoint-connectivity-test`

- Summary: Webhook_WebhookEndpointConnectivityTest
- HTTP: `POST /apis/ghippo.io/v1alpha1/webhook-endpoint/connectivity-test`
- Auth: required
- Body: required
- Flags: none

## Workspace

### `dc global-management workspace authorize`

- Summary: Grant a role to a user or group within a folder
- HTTP: `POST /apis/ghippo.io/v1alpha1/folders/{folderId}/authorize`
- Auth: required
- Body: required
- Flags:
  - `--folder-id` (path, required, int32): folderId
- Example:

```
dc global-management workspace authorize --folder-id <folderId> \
  --set memberId=<userId> \
  --set memberType=user \
  --set memberName=alice \
  --set-str 'roleNames[0]=Workspace Admin'
```

### `dc global-management workspace bind-exclusive-resource-to-workspace`

- Summary: Workspace_BindExclusiveResourceToWorkspace
- HTTP: `POST /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/bind-exclusiveresource`
- Auth: required
- Body: required
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId

### `dc global-management workspace bind-shared-resource-and-set-quota-hard-to-workspace`

- Summary: Workspace_BindSharedResourceAndSetQuotaHardToWorkspace
- HTTP: `POST /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/bind-sharedresource-setquota`
- Auth: required
- Body: required
- Flags:
  - `--workspace-id` (path, required, int32): cluster 资源 resource_scope 为空

### `dc global-management workspace bind-shared-resource-to-workspace`

- Summary: Workspace_BindSharedResourceToWorkspace
- HTTP: `POST /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/bind-sharedresource`
- Auth: required
- Body: required
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId

### `dc global-management workspace create-folder`

- Summary: Create a folder
- HTTP: `POST /apis/ghippo.io/v1alpha1/folders`
- Auth: required
- Body: required
- Flags: none
- Example:

```
# alias is the display name; parentFolderId=0 places it under root
dc global-management workspace create-folder \
  --set alias=my-folder \
  --set parentFolderId=0
```

### `dc global-management workspace create-workspace`

- Summary: Create a workspace
- HTTP: `POST /apis/ghippo.io/v1alpha1/workspaces`
- Auth: required
- Body: required
- Flags: none
- Example:

```
# alias is the display name; parentFolderId=0 places it under root
dc global-management workspace create-workspace \
  --set alias=my-workspace \
  --set parentFolderId=0
```

### `dc global-management workspace deauthorize`

- Summary: Workspace_Deauthorize
- HTTP: `PUT /apis/ghippo.io/v1alpha1/folders/{folderId}/deauthorize`
- Auth: required
- Body: required
- Flags:
  - `--folder-id` (path, required, int32): folderId

### `dc global-management workspace delete-folder`

- Summary: Delete a folder
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/folders/{folderId}`
- Auth: required
- Body: none
- Flags:
  - `--folder-id` (path, required, int32): folderId

### `dc global-management workspace delete-workspace`

- Summary: Delete a workspace
- HTTP: `DELETE /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId

### `dc global-management workspace folder-list-groups`

- Summary: Workspace_FolderListGroups
- HTTP: `GET /apis/ghippo.io/v1alpha1/folders/{folderId}/groups`
- Auth: required
- Body: none
- Flags:
  - `--folder-id` (path, required, int32): folderId
  - `--search` (query): 搜索关键字
  - `--page` (query, default `1`, int32): 搜索偏移量
  - `--page-size` (query, default `20`, int32): 分页大小
- Output: list path `items`; columns `name`, `id`, `authorized`, `canAuthorize`, `createdAt`, `description`; pagination `offset`

### `dc global-management workspace folder-list-permissions`

- Summary: Workspace_FolderListPermissions
- HTTP: `GET /apis/ghippo.io/v1alpha1/folders/{folderId}/permissions`
- Auth: required
- Body: none
- Flags:
  - `--folder-id` (path, required, int32): folderId
- Output: list path `permissions`

### `dc global-management workspace folder-list-users`

- Summary: Workspace_FolderListUsers
- HTTP: `GET /apis/ghippo.io/v1alpha1/folders/{folderId}/users`
- Auth: required
- Body: none
- Flags:
  - `--folder-id` (path, required, int32): folderId
  - `--search` (query): 搜索关键字
  - `--page-size` (query, default `20`, int32): 每页条数
  - `--page` (query, default `1`, int32): 当前页
- Output: list path `items`; columns `name`, `id`, `authorized`, `canAuthorize`, `description`, `email`; pagination `offset`

### `dc global-management workspace get-folder`

- Summary: Get folder details
- HTTP: `GET /apis/ghippo.io/v1alpha1/folders/{folderId}`
- Auth: required
- Body: none
- Flags:
  - `--folder-id` (path, required, int32): folderId

### `dc global-management workspace get-workspace`

- Summary: Get workspace details
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId

### `dc global-management workspace get-workspace-shared-resource-quota`

- Summary: Workspace_GetWorkspaceSharedResourceQuota
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspace-sharedresource-quota`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (query, int32): workspaceId
  - `--resource-name` (query): resourceName
  - `--resource-type` (query): resourceType
  - `--not-formatted` (query): notFormatted

### `dc global-management workspace list-available-exclusive-resources-by-workspace`

- Summary: Workspace_ListAvailableExclusiveResourcesByWorkspace
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/available-exclusiveresources`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--resource-name` (query): resourceName
  - `--resource-type` (query): resourceType
  - `--resource-scope` (query): resourceScope
- Output: list path `items`; columns `bound`, `clusterStatus`, `gproduct`, `resourceName`, `resourceScope`, `resourceType`; pagination `offset`

### `dc global-management workspace list-available-shared-resources-by-workspace`

- Summary: Workspace_ListAvailableSharedResourcesByWorkspace
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/available-sharedresources`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--resource-name` (query): resourceName
  - `--resource-type` (query): resourceType
- Output: list path `items`; columns `bound`, `clusterStatus`, `gproduct`, `resourceName`, `resourceScope`, `resourceType`; pagination `offset`

### `dc global-management workspace list-exclusive-resource-types`

- Summary: Workspace_ListExclusiveResourceTypes
- HTTP: `GET /apis/ghippo.io/v1alpha1/exclusiveresource-types`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`

### `dc global-management workspace list-exclusive-resources-by-workspace`

- Summary: Workspace_ListExclusiveResourcesByWorkspace
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/exclusiveresources`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--resource-name` (query): resourceName
  - `--resource-type` (query): resourceType
- Output: list path `items`; columns `clusterStatus`, `gproduct`, `module`, `resourceName`, `resourceScope`, `resourceType`; pagination `offset`

### `dc global-management workspace list-folder-tree`

- Summary: Workspace_ListFolderTree
- HTTP: `GET /apis/ghippo.io/v1alpha1/folders-tree`
- Auth: required
- Body: none
- Flags: none

### `dc global-management workspace list-folders`

- Summary: List folders (namespaces within workspaces)
- HTTP: `GET /apis/ghippo.io/v1alpha1/folders`
- Auth: required
- Body: none
- Flags:
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `name`, `id`, `alias`; pagination `offset`

### `dc global-management workspace list-members-roles-by-folder`

- Summary: Workspace_ListMembersRolesByFolder
- HTTP: `GET /apis/ghippo.io/v1alpha1/folders/{folderId}/members-roles`
- Auth: required
- Body: none
- Flags:
  - `--folder-id` (path, required, int32): folderId
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--member-name` (query): memberName
  - `--member-type` (query): memberType
  - `--role-name` (query): roleName
- Output: list path `items`; columns `folderId`, `memberId`, `memberName`, `memberType`, `roleName`; pagination `offset`

### `dc global-management workspace list-members-roles-by-workspace`

- Summary: Workspace_ListMembersRolesByWorkspace
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/members-roles`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--member-name` (query): memberName
- Output: list path `items`; columns `memberId`, `memberName`, `memberType`, `roleName`, `workspaceId`; pagination `offset`

### `dc global-management workspace list-resource-quota-types`

- Summary: Workspace_ListResourceQuotaTypes
- HTTP: `GET /apis/ghippo.io/v1alpha1/resourcequota-types`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`

### `dc global-management workspace list-shared-resource-types`

- Summary: Workspace_ListSharedResourceTypes
- HTTP: `GET /apis/ghippo.io/v1alpha1/sharedresource-types`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`

### `dc global-management workspace list-shared-resources-by-workspace`

- Summary: Workspace_ListSharedResourcesByWorkspace
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/sharedresources`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--resource-name` (query): resourceName
- Output: list path `items`; columns `clusterStatus`, `gproduct`, `module`, `resourceName`, `resourceScope`, `resourceType`; pagination `offset`

### `dc global-management workspace list-workspace-share-resource-quota-types`

- Summary: Workspace_ListWorkspaceShareResourceQuotaTypes
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/sharedresource/{resourceName}/quota-types`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId
  - `--resource-name` (path, required): resourceName
- Output: list path `gpus`; columns `type`, `alias`, `isDynamic`

### `dc global-management workspace list-workspaces`

- Summary: List workspaces
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces`
- Auth: required
- Body: none
- Flags:
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `name`, `id`, `alias`; pagination `offset`
- Example:

```
dc global-management workspace list-workspaces
dc global-management workspace list-workspaces -o json
```

### `dc global-management workspace move-workspace`

- Summary: Workspace_MoveWorkspace
- HTTP: `POST /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/move`
- Auth: required
- Body: required
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId

### `dc global-management workspace move-workspace-folder-list`

- Summary: Workspace_MoveWorkspaceFolderList
- HTTP: `GET /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/move-folders`
- Auth: required
- Body: none
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
  - `--folder` (query): folder
- Output: list path `items`; columns `folderAlias`, `folderId`, `parentAlias`, `parentId`; pagination `offset`

### `dc global-management workspace reauthorize`

- Summary: Workspace_Reauthorize
- HTTP: `PUT /apis/ghippo.io/v1alpha1/folders/{folderId}/reauthorize`
- Auth: required
- Body: required
- Flags:
  - `--folder-id` (path, required, int32): folderId

### `dc global-management workspace set-quota-hard-for-workspace-shared-resource`

- Summary: Workspace_SetQuotaHardForWorkspaceSharedResource
- HTTP: `PUT /apis/ghippo.io/v1alpha1/workspace-sharedresource-quota-hard`
- Auth: required
- Body: required
- Flags: none

### `dc global-management workspace unbind-resource-from-workspace`

- Summary: Workspace_UnbindResourceFromWorkspace
- HTTP: `PUT /apis/ghippo.io/v1alpha1/workspaces/{workspaceId}/unbind-resource`
- Auth: required
- Body: required
- Flags:
  - `--workspace-id` (path, required, int32): workspaceId

### `dc global-management workspace update-folder`

- Summary: Update a folder
- HTTP: `PUT /apis/ghippo.io/v1alpha1/folders/{folderId}`
- Auth: required
- Body: required
- Flags:
  - `--folder-id` (path, required, int32): folderId
- Example:

```
dc global-management workspace update-folder --folder-id <id> \
  --set alias=new-folder-name
```

### `dc global-management workspace update-quota-check`

- Summary: Workspace_UpdateQuotaCheck
- HTTP: `POST /apis/ghippo.io/v1alpha1/update-quota-check`
- Auth: required
- Body: required
- Flags: none

# Module `insight`

## Source

- Backend: `swagger`
- Repository: https://github.com/DaoCloud/daocloud-api-docs.git
- Pinned tag: `4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3`
- Files: `docs/openapi/insight/v0.41.0.json`
- Resolved SHA: `4bc92dd4c0c1637b4257f69e26eb8dd6cdd269f3`

## Alert

### `dc insight alert add-group-rule`

- Summary: Add a rule to an existing group
- HTTP: `POST /apis/insight.io/v1alpha1/alert/groups/{id}/rules`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): required;
- Example:

```
# rule.source 必填（METRIC_TPL | PROMQL | LOG_TPL | EVENT_TPL），见 create-group 说明
echo '{
  "rule": {
    "name": "HighMem",
    "source": "PROMQL",
    "severity": "WARNING",
    "duration": "5m",
    "expr": "node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes < 0.1",
    "description": "memory low",
    "labels": {"team":"ops"},
    "annotations": {"summary":"low memory on {{ $labels.instance }}"}
  }
}' | dc insight alert add-group-rule --id <gid> --file -
```

### `dc insight alert clean-alert-history`

- Summary: Trigger cleanup of alert history (respects retention config)
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/history/clean`
- Auth: required
- Body: none
- Flags: none
- Example: `dc insight alert clean-alert-history`

### `dc insight alert count-alert`

- Summary: Count alerts grouped by time/severity/target
- HTTP: `GET /apis/insight.io/v1alpha1/alert/alertcount`
- Auth: required
- Body: none
- Flags:
  - `--resolved` (query): resolved
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): namespace
  - `--target-type` (query, default `TARGET_TYPE_UNSPECIFIED`, one of: TARGET_TYPE_UNSPECIFIED|GLOBAL|CLUSTER|NAMESPACE|NODE|DEPLOYMENT|STATEFULSET|DAEMONSET|POD): targetType
  - `--target` (query): target
  - `--severity` (query, default `SEVERITY_UNSPECIFIED`, one of: SEVERITY_UNSPECIFIED|CRITICAL|WARNING|INFO): severity
  - `--start` (query, int64): start == 0 means from 1970.01.01
  - `--end` (query, int64): end
  - `--step` (query, int64): step unit is minute
  - `--group-by-type` (query): groupByType
- Output: list path `data`; columns `end`, `start`
- Example:

```
# ⚠️ --start 与 --end（unix 秒）必填，缺失返回 HTTP 400 "value must be greater than 0"
# --step 单位为分钟，0 表示返回时间范围内的总数（不分桶）
END=$(date +%s); START=$((END - 86400))
dc insight alert count-alert \
  --cluster-name kpanda-global-cluster \
  --severity CRITICAL \
  --start $START --end $END --step 60 \
  --group-by-type=true -o json
```

### `dc insight alert create-group`

- Summary: Create an alert group (with rules / receivers)
- HTTP: `POST /apis/insight.io/v1alpha1/alert/groups`
- Auth: required
- Body: required
- Flags: none
- Output: list path `notifyRepeatConfig`; columns `interval`, `severity`
- Example:

```
# ⚠️ 关键字段：
#   clusterName  必填
#   rules[].source 必填，枚举：METRIC_TPL | PROMQL | LOG_TPL | EVENT_TPL
#     - METRIC_TPL  从指标模板派生（rules[].metricTpl 等）
#     - PROMQL      自定义 PromQL 表达式（最常用，rules[].expr）
#     - LOG_TPL     日志告警（额外字段：rules[].logTpl 等）
#     - EVENT_TPL   事件告警
#   缺少 source 会创建失败（典型表现：rule source unknown）
echo '{
  "name": "node-health",
  "clusterName": "kpanda-global-cluster",
  "namespace": "insight-system",
  "description": "Node health alerts",
  "targetType": "NODE",
  "targets": ["*"],
  "receivers": [
    {"type": "email", "names": ["ops-mail"]}
  ],
  "notifyRepeatConfig": [
    {"severity": "CRITICAL", "interval": 300}
  ],
  "rules": [
    {
      "name": "NodeDown",
      "source": "PROMQL",
      "description": "node unreachable for 5m",
      "severity": "CRITICAL",
      "duration": "5m",
      "expr": "up{job=\"node-exporter\"} == 0",
      "labels": {"team": "ops"},
      "annotations": {"summary": "Node {{ $labels.instance }} down"}
    }
  ]
}' | dc insight alert create-group --file -
```

### `dc insight alert create-inhibition`

- Summary: Create an inhibition rule (source matchers suppress target matchers)
- HTTP: `POST /apis/insight.io/v1alpha1/alert/inhibitions`
- Auth: required
- Body: required
- Flags: none
- Output: list path `equal`
- Example:

```
echo '{
  "name": "cluster-down-suppresses-node",
  "clusterName": "prod-1",
  "namespace": "insight-system",
  "description": "if cluster is down, suppress node-level alerts",
  "equal": ["clusterName"],
  "sourceMatchers": [{"type":"EQUAL","key":"alertname","value":"ClusterDown"}],
  "targetMatchers": [{"type":"EQUAL","key":"severity","value":"WARNING"}]
}' | dc insight alert create-inhibition --file -

# matches/sourceMatchers/targetMatchers 的 type 同 silence：EQUAL / NOT_EQUAL / REGEXP
```

### `dc insight alert create-provider`

- Summary: Create an SMS provider
- HTTP: `POST /apis/insight.io/v1alpha1/alert/providers`
- Auth: required
- Body: required
- Flags: none
- Example:

```
echo '{
  "name": "aliyun-sms",
  "type": "aliyun",
  "template": "default",
  "aliyun": {
    "accessKeyId": "AKID...",
    "accessKeySecret": "SECRET...",
    "signName": "MyCompany",
    "templateCode": "SMS_123"
  }
}' | dc insight alert create-provider --file -
```

### `dc insight alert create-receiver`

- Summary: Create a notification receiver (email/dingtalk/wecom/webhook/lark/sms/message)
- HTTP: `POST /apis/insight.io/v1alpha1/alert/receivers`
- Auth: required
- Body: required
- Flags: none
- Example:

```
# Email receiver
echo '{
  "name": "ops-mail",
  "type": "email",
  "description": "ops mailing list",
  "email": {"to": ["ops@example.com"]}
}' | dc insight alert create-receiver --file -

# Webhook receiver with bearer token
echo '{
  "name": "my-webhook",
  "type": "webhook",
  "webhook": {
    "url": "https://hooks.example.com/insight",
    "httpConfig": {
      "bearerToken": "xxx",
      "tlsConfig": {"insecureSkipVerify": false}
    }
  }
}' | dc insight alert create-receiver --file -
```

### `dc insight alert create-rule-template`

- Summary: Create a rule template (bundle of rules)
- HTTP: `POST /apis/insight.io/v1alpha1/alert/rule-templates`
- Auth: required
- Body: required
- Flags: none
- Output: list path `rules`; columns `name`, `description`, `duration`, `expr`, `logFilterCondition`, `logQueryString`
- Example:

```
echo '{
  "name": "node-basics",
  "description": "basic node alerts",
  "targetType": "NODE",
  "rules": [
    {"name":"NodeDown","severity":"CRITICAL","duration":"5m","expr":"up == 0"},
    {"name":"NodeHighLoad","severity":"WARNING","duration":"10m","expr":"node_load5 > 8"}
  ]
}' | dc insight alert create-rule-template --file -
```

### `dc insight alert create-silence`

- Summary: Create an alert silence (label matchers + optional schedule)
- HTTP: `POST /apis/insight.io/v1alpha1/alert/silences`
- Auth: required
- Body: required
- Flags: none
- Output: list path `matches`; columns `type`, `key`, `value`
- Example:

```
# ⚠️ matches[].type 是枚举字符串，不是 "=" / "=~"。可选：
#   EQUAL | NOT_EQUAL | REGEXP | MATCH_TYPE_UNSPECIFIED
echo '{
  "name": "maint-window",
  "clusterName": "kpanda-global-cluster",
  "namespace": "insight-system",
  "description": "weekly maintenance",
  "matches": [
    {"type": "EQUAL",  "key": "alertname", "value": "HighCPU"},
    {"type": "REGEXP", "key": "instance",  "value": "node-.*"}
  ],
  "activeTimeInterval": {
    "weekdayRange": [0],
    "timeRanges": [{"start":"02:00","end":"04:00"}]
  }
}' | dc insight alert create-silence --file -
```

### `dc insight alert create-template`

- Summary: Create a notification template (body per channel)
- HTTP: `POST /apis/insight.io/v1alpha1/alert/templates`
- Auth: required
- Body: required
- Flags: none
- Example:

```
echo '{
  "name": "crit-email",
  "description": "critical alert template",
  "body": {
    "email": {
      "subject": "[CRITICAL] {{ .CommonLabels.alertname }}",
      "body": "{{ range .Alerts }}{{ .Annotations.summary }}\n{{ end }}"
    },
    "dingtalk": "**[CRITICAL]** {{ .CommonLabels.alertname }}",
    "wecom": "[CRITICAL] {{ .CommonLabels.alertname }}"
  }
}' | dc insight alert create-template --file -
```

### `dc insight alert delete-group`

- Summary: Delete an alert group
- HTTP: `DELETE /apis/insight.io/v1alpha1/alert/groups/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Example: `dc insight alert delete-group --id <gid>`

### `dc insight alert delete-group-rule`

- Summary: Delete a rule from a group
- HTTP: `DELETE /apis/insight.io/v1alpha1/alert/groups/{id}/rules/{name}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): required; id is group id
  - `--name` (path, required): required; name is rule name
- Example: `dc insight alert delete-group-rule --id <gid> --name HighCPU`

### `dc insight alert delete-inhibition`

- Summary: Delete an inhibition rule
- HTTP: `DELETE /apis/insight.io/v1alpha1/alert/inhibitions/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Example: `dc insight alert delete-inhibition --id <iid>`

### `dc insight alert delete-provider`

- Summary: Delete an SMS provider
- HTTP: `DELETE /apis/insight.io/v1alpha1/alert/providers/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
- Example: `dc insight alert delete-provider --name aliyun-sms`

### `dc insight alert delete-receiver`

- Summary: Delete a notification receiver
- HTTP: `DELETE /apis/insight.io/v1alpha1/alert/receivers/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
- Example: `dc insight alert delete-receiver --name ops-mail`

### `dc insight alert delete-rule-template`

- Summary: Delete a rule template
- HTTP: `DELETE /apis/insight.io/v1alpha1/alert/rule-templates/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Example: `dc insight alert delete-rule-template --id <rtid>`

### `dc insight alert delete-silence`

- Summary: Delete an alert silence
- HTTP: `DELETE /apis/insight.io/v1alpha1/alert/silences/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Example: `dc insight alert delete-silence --id <sid>`

### `dc insight alert delete-template`

- Summary: Delete a notification template
- HTTP: `DELETE /apis/insight.io/v1alpha1/alert/templates/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
- Example: `dc insight alert delete-template --name crit-email`

### `dc insight alert get-alert`

- Summary: Get a single alert by ID
- HTTP: `GET /apis/insight.io/v1alpha1/alert/alerts/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required, int64): id
  - `--resolved` (query): resolved
- Example:

```
dc insight alert get-alert --id <alertId>
dc insight alert get-alert --id <alertId> --resolved=true
```

### `dc insight alert get-group`

- Summary: Get an alert group by ID
- HTTP: `GET /apis/insight.io/v1alpha1/alert/groups/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `notifyRepeatConfig`; columns `interval`, `severity`
- Example:

```
dc insight alert get-group --id <gid>
dc insight alert get-group --id <gid> -o json
```

### `dc insight alert get-group-rule`

- Summary: Get a single rule by group id + rule name
- HTTP: `GET /apis/insight.io/v1alpha1/alert/groups/{id}/rules/{name}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): required; id is group id
  - `--name` (path, required): required; name is rule name
- Example: `dc insight alert get-group-rule --id <gid> --name HighCPU`

### `dc insight alert get-inhibition`

- Summary: Get an inhibition by ID
- HTTP: `GET /apis/insight.io/v1alpha1/alert/inhibitions/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `equal`
- Example:

```
dc insight alert get-inhibition --id <iid>
dc insight alert get-inhibition --id <iid> -o json
```

### `dc insight alert get-provider`

- Summary: Get an SMS provider by name
- HTTP: `GET /apis/insight.io/v1alpha1/alert/providers/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
- Example:

```
dc insight alert get-provider --name aliyun-sms
dc insight alert get-provider --name aliyun-sms -o json
```

### `dc insight alert get-receiver`

- Summary: Get a receiver by name + type
- HTTP: `GET /apis/insight.io/v1alpha1/alert/receivers/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
  - `--type` (query, default `RECEIVER_TYPE_UNSPECIFIED`, one of: RECEIVER_TYPE_UNSPECIFIED|webhook|email|dingtalk|wecom|sms|message|lark): Required. webhook | email | dingtalk | wecom | sms | message | lark
- Example:

```
# ⚠️ --type 必填（proto enum.defined_only），缺失返回 HTTP 400 "type cannot be empty"
# type 取值：webhook | email | dingtalk | wecom | sms | message | lark
dc insight alert get-receiver --name ops-mail --type email -o json
dc insight alert get-receiver --name my-bot   --type lark  -o json
```

### `dc insight alert get-rule-template`

- Summary: Get a rule template by ID
- HTTP: `GET /apis/insight.io/v1alpha1/alert/rule-templates/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `rules`; columns `name`, `description`, `duration`, `expr`, `logFilterCondition`, `logQueryString`
- Example:

```
dc insight alert get-rule-template --id <rtid>
dc insight alert get-rule-template --id <rtid> -o json
```

### `dc insight alert get-silence`

- Summary: Get a silence by ID
- HTTP: `GET /apis/insight.io/v1alpha1/alert/silences/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `matches`; columns `type`, `key`, `value`
- Example:

```
dc insight alert get-silence --id <sid>
dc insight alert get-silence --id <sid> -o json
```

### `dc insight alert get-smtp-status`

- Summary: Check whether SMTP is configured (required for email receivers)
- HTTP: `GET /apis/insight.io/v1alpha1/alert/smtp`
- Auth: required
- Body: none
- Flags: none
- Example:

```
dc insight alert get-smtp-status
dc insight alert get-smtp-status -o json
```

### `dc insight alert get-template`

- Summary: Get a notification template by name
- HTTP: `GET /apis/insight.io/v1alpha1/alert/templates/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
- Example:

```
dc insight alert get-template --name crit-email
dc insight alert get-template --name crit-email -o json
```

### `dc insight alert list-alerts`

- Summary: List alerts (active or historical)
- HTTP: `GET /apis/insight.io/v1alpha1/alert/alerts`
- Auth: required
- Body: none
- Flags:
  - `--resolved` (query): set resolved to True shows alert histories
  - `--group-name` (query): filter alerts by group name fuzzily
  - `--group-id` (query): filter alerts by group id
  - `--rule-name` (query): filter alerts by rule name fuzzily
  - `--rule-id` (query): filter alerts by rule id
  - `--cluster-name` (query): filter alerts by cluster name
  - `--namespace` (query): filter alerts by namespace
  - `--severity` (query, default `SEVERITY_UNSPECIFIED`, one of: SEVERITY_UNSPECIFIED|CRITICAL|WARNING|INFO): SEVERITY_UNSPECIFIED | CRITICAL | WARNING | INFO
  - `--target-type` (query, default `TARGET_TYPE_UNSPECIFIED`, one of: TARGET_TYPE_UNSPECIFIED|GLOBAL|CLUSTER|NAMESPACE|NODE|DEPLOYMENT|STATEFULSET|DAEMONSET|POD): TARGET_TYPE_UNSPECIFIED | GLOBAL | CLUSTER | NAMESPACE | NODE | DEPLOYMENT | STATEFULSET | DAEMONSET | POD
  - `--target` (query): filter alerts by target
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
  - `--status` (query): filter by alert's status
- Output: list path `items`; columns `namespace`, `id`, `builtin`, `clusterName`, `description`, `groupId`; pagination `offset`
- Example:

```
# Active alerts in a cluster
dc insight alert list-alerts --cluster-name prod-1 --severity CRITICAL
# Alert history (resolved=true)
dc insight alert list-alerts --resolved=true --page 1 --page-size 50 -o json
# Filter by group / rule
dc insight alert list-alerts --group-id <gid> --rule-name "HighCPU"
```

### `dc insight alert list-group-rules`

- Summary: List rules under an alert group
- HTTP: `GET /apis/insight.io/v1alpha1/alert/groups/{id}/rules`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--name` (query): filter rule by name
  - `--severity` (query, default `SEVERITY_UNSPECIFIED`, one of: SEVERITY_UNSPECIFIED|CRITICAL|WARNING|INFO): SEVERITY_UNSPECIFIED | CRITICAL | WARNING | INFO
  - `--status` (query, default `UNSPECIFIED`, one of: UNSPECIFIED|FIRING|ENABLED): UNSPECIFIED | FIRING | ENABLED
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
- Output: list path `items`; columns `name`, `id`, `createAt`, `description`, `duration`, `expr`; pagination `offset`
- Example:

```
# All rules in a group
dc insight alert list-group-rules --id <gid>
# Filter by name + severity
dc insight alert list-group-rules --id <gid> --name HighCPU --severity CRITICAL
# Only firing rules, paged
dc insight alert list-group-rules --id <gid> --status FIRING --page 1 --page-size 50 -o json
```

### `dc insight alert list-groups`

- Summary: List alert groups
- HTTP: `GET /apis/insight.io/v1alpha1/alert/groups`
- Auth: required
- Body: none
- Flags:
  - `--builtin` (query): builtin
  - `--name` (query): filter group by name
  - `--cluster-name` (query): filter alerts by cluster name
  - `--namespace` (query): filter alerts by namespace
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
- Output: list path `items`; columns `name`, `namespace`, `id`, `builtin`, `clusterName`, `createAt`; pagination `offset`
- Example:

```
# All alert groups
dc insight alert list-groups
# Filter by name (fuzzy) within a cluster + namespace
dc insight alert list-groups --name node --cluster-name prod-1 --namespace insight-system
# Only built-in groups, page through results
dc insight alert list-groups --builtin=true --page 1 --page-size 50 -o json
```

### `dc insight alert list-inhibitions`

- Summary: List inhibition rules
- HTTP: `GET /apis/insight.io/v1alpha1/alert/inhibitions`
- Auth: required
- Body: none
- Flags:
  - `--name` (query): name
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): namespace
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
- Output: list path `items`; columns `name`, `namespace`, `id`, `clusterName`, `createAt`, `description`; pagination `offset`
- Example:

```
dc insight alert list-inhibitions
dc insight alert list-inhibitions --cluster-name prod-1 --namespace insight-system
dc insight alert list-inhibitions --name cluster-down --page 1 --page-size 50 -o json
```

### `dc insight alert list-providers`

- Summary: List SMS providers (Aliyun / Tencent / custom)
- HTTP: `GET /apis/insight.io/v1alpha1/alert/providers`
- Auth: required
- Body: none
- Flags:
  - `--name` (query): filter template by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
  - `--exact-search` (query): exact search by name
- Output: list path `items`; columns `name`, `type`, `createAt`, `template`, `updateAt`; pagination `offset`
- Example:

```
dc insight alert list-providers
dc insight alert list-providers --name aliyun --exact-search=true
dc insight alert list-providers --page 1 --page-size 50 -o json
```

### `dc insight alert list-receivers`

- Summary: List notification receivers
- HTTP: `GET /apis/insight.io/v1alpha1/alert/receivers`
- Auth: required
- Body: none
- Flags:
  - `--name` (query): name
  - `--type` (query, default `RECEIVER_TYPE_UNSPECIFIED`, one of: RECEIVER_TYPE_UNSPECIFIED|webhook|email|dingtalk|wecom|sms|message|lark): RECEIVER_TYPE_UNSPECIFIED | webhook | email | dingtalk | wecom | sms | message | lark
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
  - `--exact-search` (query): exact search by name
- Output: list path `items`; columns `name`, `type`, `createAt`, `description`, `updateAt`; pagination `offset`
- Example:

```
# All receivers
dc insight alert list-receivers
# Only email receivers, exact name match
dc insight alert list-receivers --type email --name ops-mail --exact-search=true
# Paged JSON output
dc insight alert list-receivers --page 1 --page-size 50 -o json
```

### `dc insight alert list-rule-template-summary`

- Summary: List rule template summaries (id/name/targetType only)
- HTTP: `GET /apis/insight.io/v1alpha1/alert/rule-template-summary`
- Auth: required
- Body: none
- Flags:
  - `--target-type` (query, default `TARGET_TYPE_UNSPECIFIED`, one of: TARGET_TYPE_UNSPECIFIED|GLOBAL|CLUSTER|NAMESPACE|NODE|DEPLOYMENT|STATEFULSET|DAEMONSET|POD): filter by target type
- Output: list path `items`; columns `name`, `id`, `targetType`
- Example:

```
dc insight alert list-rule-template-summary
dc insight alert list-rule-template-summary --target-type CLUSTER -o json
```

### `dc insight alert list-rule-templates`

- Summary: List alert rule templates (reusable rule bundles)
- HTTP: `GET /apis/insight.io/v1alpha1/alert/rule-templates`
- Auth: required
- Body: none
- Flags:
  - `--builtin` (query): builtin
  - `--name` (query): filter group by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
  - `--target-type` (query, default `TARGET_TYPE_UNSPECIFIED`, one of: TARGET_TYPE_UNSPECIFIED|GLOBAL|CLUSTER|NAMESPACE|NODE|DEPLOYMENT|STATEFULSET|DAEMONSET|POD): TARGET_TYPE_UNSPECIFIED | GLOBAL | CLUSTER | NAMESPACE | NODE | DEPLOYMENT | STATEFULSET | DAEMONSET | POD
- Output: list path `items`; columns `name`, `id`, `count`, `createAt`, `description`, `targetType`; pagination `offset`
- Example:

```
dc insight alert list-rule-templates
dc insight alert list-rule-templates --target-type NODE --builtin=false
dc insight alert list-rule-templates --name node --page 1 --page-size 50 -o json
```

### `dc insight alert list-silences`

- Summary: List alert silences
- HTTP: `GET /apis/insight.io/v1alpha1/alert/silences`
- Auth: required
- Body: none
- Flags:
  - `--expired` (query): set "expired" to false show silences that vaild for now, otherwise show
  - `--name` (query): name
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): namespace
- Output: list path `items`; columns `name`, `namespace`, `id`, `clusterName`, `createAt`, `description`
- Example:

```
# All silences (active and expired)
dc insight alert list-silences
# Only currently-active silences
dc insight alert list-silences --expired=false
# Filter by cluster + namespace
dc insight alert list-silences --cluster-name prod-1 --namespace insight-system -o json
```

### `dc insight alert list-template-summary`

- Summary: List notification template summaries (lightweight)
- HTTP: `GET /apis/insight.io/v1alpha1/alert/template-summary`
- Auth: required
- Body: none
- Flags:
  - `--name` (query): filter template by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
  - `--exact-search` (query): exact search by name
  - `--builtin` (query): search builtin only
- Output: list path `items`; columns `name`, `builtin`, `description`, `updateAt`; pagination `offset`
- Example:

```
dc insight alert list-template-summary
dc insight alert list-template-summary --builtin=true -o json
```

### `dc insight alert list-templates`

- Summary: List notification templates
- HTTP: `GET /apis/insight.io/v1alpha1/alert/templates`
- Auth: required
- Body: none
- Flags:
  - `--name` (query): filter template by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): sorts determines the data list order, support multiple sort option.
  - `--exact-search` (query): exact search by name
  - `--builtin` (query): search builtin only
- Output: list path `items`; columns `name`, `builtin`, `createAt`, `description`, `updateAt`; pagination `offset`
- Example:

```
dc insight alert list-templates
dc insight alert list-templates --name crit --exact-search=false
dc insight alert list-templates --builtin=true --page 1 --page-size 50 -o json
```

### `dc insight alert preview-rule`

- Summary: Preview a rule's evaluation (matrix output) before saving
- HTTP: `POST /apis/insight.io/v1alpha1/alert/rules/preview`
- Auth: required
- Body: required
- Flags: none
- Output: list path `matrix`
- Example:

```
# rule.source 必填（同 create-group / add-group-rule）；params 时间为 unix 秒字符串
END=$(date +%s); START=$((END - 3600))
echo '{
  "group": {"clusterName":"kpanda-global-cluster","targetType":"CLUSTER","targets":["*"]},
  "rule":  {"source":"PROMQL","expr":"vector(1)","duration":"1m","severity":"WARNING"},
  "params":{"start":"'"$START"'","end":"'"$END"'","step":60}
}' | dc insight alert preview-rule --file -
```

### `dc insight alert preview-silence`

- Summary: Preview which alerts a silence definition would match
- HTTP: `POST /apis/insight.io/v1alpha1/alert/silences/preview`
- Auth: required
- Body: required
- Flags: none
- Output: list path `items`; columns `namespace`, `id`, `builtin`, `clusterName`, `description`, `groupId`
- Example:

```
# matches[].type 同 create-silence：EQUAL / NOT_EQUAL / REGEXP
echo '{
  "clusterName": "kpanda-global-cluster",
  "namespace": "insight-system",
  "size": "20",
  "matches": [{"type":"EQUAL","key":"alertname","value":"HighCPU"}]
}' | dc insight alert preview-silence --file -
```

### `dc insight alert preview-template`

- Summary: Render a notification template against sample alert data
- HTTP: `POST /apis/insight.io/v1alpha1/alert/templates/preview`
- Auth: required
- Body: required
- Flags: none
- Example:

```
# ⚠️ data 字段使用 commonLabels（驼峰），不是 labels；alerts[] 必填
# 模板里 {{ .CommonLabels.X }} 对应 body 输入的 data.commonLabels.X
echo '{
  "body": {"email":{"subject":"[T] {{ .CommonLabels.alertname }}","body":"x"}},
  "data": {
    "status": "firing",
    "commonLabels": {"alertname":"HighCPU"},
    "alerts": [{"status":"firing","labels":{"instance":"node1"},"annotations":{"summary":"cpu hot"}}]
  }
}' | dc insight alert preview-template --file -
```

### `dc insight alert test-receiver`

- Summary: Send a test message to a receiver definition
- HTTP: `POST /apis/insight.io/v1alpha1/alert/receivers/test`
- Auth: required
- Body: required
- Flags: none
- Example:

```
echo '{
  "name": "ops-mail",
  "type": "email",
  "email": {"to": ["ops@example.com"]}
}' | dc insight alert test-receiver --file -
```

### `dc insight alert update-group`

- Summary: Update an alert group (description / receivers / notify only)
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/groups/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Output: list path `notifyRepeatConfig`; columns `interval`, `severity`
- Example:

```
echo '{
  "description": "updated",
  "notificationTemplate": "default",
  "receivers": [{"type":"email","names":["ops-mail"]}],
  "notifyRepeatConfig": [{"severity":"WARNING","interval":600}]
}' | dc insight alert update-group --id <gid> --file -
```

### `dc insight alert update-group-rule`

- Summary: Update a rule in a group
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/groups/{id}/rules/{name}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): required; id is group id
  - `--name` (path, required): required;
- Example:

```
echo '{
  "source":   "PROMQL",
  "severity": "CRITICAL",
  "duration": "10m",
  "expr": "rate(http_requests_total{code=~\"5..\"}[5m]) > 1",
  "description": "5xx rate too high"
}' | dc insight alert update-group-rule --id <gid> --name HighErr --file -
```

### `dc insight alert update-inhibition`

- Summary: Update an inhibition rule
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/inhibitions/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Output: list path `equal`
- Example:

```
echo '{
  "description": "updated suppression",
  "equal": ["clusterName", "namespace"],
  "sourceMatchers": [{"type":"EQUAL", "key":"alertname","value":"ClusterDown"}],
  "targetMatchers": [{"type":"REGEXP","key":"severity","value":"WARNING|INFO"}]
}' | dc insight alert update-inhibition --id <iid> --file -
```

### `dc insight alert update-provider`

- Summary: Update an SMS provider
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/providers/{name}`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): name
- Example:

```
echo '{
  "type": "aliyun",
  "template": "default",
  "aliyun": {
    "accessKeyId": "AKID...",
    "accessKeySecret": "NEW_SECRET",
    "signName": "MyCompany",
    "templateCode": "SMS_456"
  }
}' | dc insight alert update-provider --name aliyun-sms --file -
```

### `dc insight alert update-receiver`

- Summary: Update a notification receiver
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/receivers/{name}`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): name
- Example:

```
echo '{
  "name": "ops-mail",
  "type": "email",
  "description": "updated mailing list",
  "email": {"to": ["ops@example.com", "oncall@example.com"]}
}' | dc insight alert update-receiver --name ops-mail --file -
```

### `dc insight alert update-rule-template`

- Summary: Update a rule template
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/rule-templates/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Output: list path `rules`; columns `name`, `description`, `duration`, `expr`, `logFilterCondition`, `logQueryString`
- Example:

```
echo '{
  "description": "updated node basics",
  "rules": [
    {"name":"NodeDown","severity":"CRITICAL","duration":"10m","expr":"up == 0"},
    {"name":"NodeHighLoad","severity":"WARNING","duration":"15m","expr":"node_load5 > 10"}
  ]
}' | dc insight alert update-rule-template --id <rtid> --file -
```

### `dc insight alert update-silence`

- Summary: Update an alert silence
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/silences/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): id
- Output: list path `matches`; columns `type`, `key`, `value`
- Example:

```
echo '{
  "description": "extended maintenance window",
  "matches": [
    {"type": "EQUAL",  "key": "alertname", "value": "HighCPU"},
    {"type": "REGEXP", "key": "instance",  "value": "node-.*"}
  ],
  "activeTimeInterval": {
    "weekdayRange": [0, 6],
    "timeRanges": [{"start":"01:00","end":"05:00"}]
  }
}' | dc insight alert update-silence --id <sid> --file -
```

### `dc insight alert update-template`

- Summary: Update a notification template
- HTTP: `PUT /apis/insight.io/v1alpha1/alert/templates/{name}`
- Auth: required
- Body: required
- Flags:
  - `--name` (path, required): name
- Example:

```
echo '{
  "description": "updated critical template",
  "body": {
    "email": {
      "subject": "[CRITICAL] {{ .CommonLabels.alertname }}",
      "body":    "{{ range .Alerts }}{{ .Annotations.summary }}\n{{ end }}"
    }
  }
}' | dc insight alert update-template --name crit-email --file -
```

### `dc insight alert validate-group`

- Summary: Validate a group definition (PrometheusRule YAML)
- HTTP: `POST /apis/insight.io/v1alpha1/alert/groups/validate`
- Auth: required
- Body: required
- Flags: none
- Output: list path `errors`; columns `code`, `message`
- Example:

```
echo '{
  "clusterName": "prod-1",
  "namespace": "insight-system",
  "yamlString": "groups:\n- name: my\n  rules:\n  - alert: A\n    expr: vector(1)\n"
}' | dc insight alert validate-group --file -
```

## Event

### `dc insight event get-reasons`

- Summary: Get the predefined event reason vocabulary grouped by object kind
- HTTP: `GET /apis/insight.io/v1alpha1/event/reasons`
- Auth: required
- Body: none
- Flags: none
- Output: list path `daemonSet`
- Example:

```
dc insight event get-reasons -o json

# 返回字段（每项为字符串数组）：
#   node / daemonSet / deployment / job / pod / statefulSet
```

### `dc insight event query-event-context`

- Summary: Fetch surrounding events around a specific timestamp (context view)
- HTTP: `GET /apis/insight.io/v1alpha1/event/cluster/{clusterName}/events/context`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): Required.
  - `--timestamp` (query): timestamp e.g. 2023-06-20T16:05:16.887681657Z
  - `--namespace` (query): Optional.
  - `--filter.type` (query, default `TYPE_UNSPECIFIED`, one of: TYPE_UNSPECIFIED|Normal|Warning): 此接口忽略；仅 involve-object-kind/involve-object-name 生效
  - `--filter.involve-object-kind` (query): filter.involveObjectKind
  - `--filter.reason` (query): filter.reason
  - `--filter.involve-object-name` (query): fuzzy search
  - `--filter.message` (query): fuzzy search
  - `--before` (query, default `50`, int32): Optional.
  - `--after` (query, default `50`, int32): Optional.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `type`, `metadata.creationTimestamp`, `action`, `clusterName`; pagination `cursor`
- Example:

```
# 重要：filter.involve-object-kind 或 filter.involve-object-name 至少传一个，
# 否则后端返回 HTTP 400。filter 在该接口只识别这两个字段。
#
# 推荐流程：先用 query-events 取锚点，再用 jq 提取 timestamp / involveObject 作参数
EVENT=$(dc insight event query-events \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --start-time 2026-05-21T17:00:00Z --end-time 2026-05-21T18:00:00Z \
  --filter.type Warning --page 1 --page-size 1 -o json)

TS=$(echo "$EVENT"   | jq -r '.items[0].timestamp')
NS=$(echo "$EVENT"   | jq -r '.items[0].metadata.namespace')
KIND=$(echo "$EVENT" | jq -r '.items[0].involveObject.kind')
NAME=$(echo "$EVENT" | jq -r '.items[0].involveObject.name')

dc insight event query-event-context \
  --cluster-name kpanda-global-cluster --namespace "$NS" \
  --timestamp "$TS" \
  --filter.involve-object-kind "$KIND" \
  --filter.involve-object-name "$NAME" \
  --before 20 --after 20 -o json
```

### `dc insight event query-event-count`

- Summary: Aggregate event counts in a time range (POST body supports multiple filters)
- HTTP: `POST /apis/insight.io/v1alpha1/event/cluster/{clusterName}/events/count`
- Auth: required
- Body: required
- Flags:
  - `--cluster-name` (path, required): Required.
- Output: list path `items`
- Example:

```
# filters 列表：每项对应一个聚合通道；响应 items 是与 filters 等长的 int64 计数数组。
# 字段说明（每个 filter）：
#   type               Normal | Warning（可省，省略表示不限）
#   involveObjectKind  关联对象类型，如 Pod / Node / Deployment
#   reason             事件原因（精确）
#   involveObjectName  关联对象名（模糊）
#   message            消息体（模糊）
# 若 filters 省略，服务端使用默认 6 个通道：
#   imagePullFail / healthyCheckFail / podFailed /
#   podFailedScheduling / containerRestartingFailed / podFailedMount
echo '{
  "namespace": "insight-system",
  "startTime": "2026-05-21T17:00:00Z",
  "endTime":   "2026-05-21T18:00:00Z",
  "filters": [
    {"type":"Warning","involveObjectKind":"Pod","reason":"FailedScheduling"},
    {"type":"Warning","involveObjectKind":"Node"}
  ]
}' | dc insight event query-event-count --cluster-name kpanda-global-cluster --file -

# 使用默认 filters（不传 filters 字段）
echo '{
  "namespace": "insight-system",
  "startTime": "2026-05-21T17:00:00Z",
  "endTime":   "2026-05-21T18:00:00Z"
}' | dc insight event query-event-count --cluster-name kpanda-global-cluster --file -
```

### `dc insight event query-event-filter-options`

- Summary: List available filter options (object kinds / reasons) for the event UI
- HTTP: `GET /apis/insight.io/v1alpha1/event/cluster/{clusterName}/events/filter-options`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): Required.
  - `--start-time` (query): startTime e.g. 2006-01-02T15:04:05.999999999Z07:00
  - `--end-time` (query): endTime e.g. 2006-01-02T15:04:05.999999999Z07:00
  - `--namespace` (query): Optional.
- Output: list path `involvedObjectKinds`
- Example:

```
dc insight event query-event-filter-options \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --start-time 2026-05-21T17:00:00Z --end-time 2026-05-21T18:00:00Z -o json

# 返回字段：
#   involvedObjectKinds  当前窗口内出现过的对象类型（注意是 involvedObjectKinds，而事件对象本身用 involveObject）
#   reasons              当前窗口内出现过的 reason 列表
```

### `dc insight event query-event-histogram`

- Summary: Bucket event counts over time (normal vs warning)
- HTTP: `GET /apis/insight.io/v1alpha1/event/cluster/{clusterName}/events/histogram`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): Required.
  - `--start-time` (query): startTime e.g. 2006-01-02T15:04:05.999999999Z07:00
  - `--end-time` (query): endTime e.g. 2006-01-02T15:04:05.999999999Z07:00
  - `--interval` (query): interval e.g 1440s
  - `--namespace` (query): Optional.
- Output: list path `items`; columns `normalCount`, `timestamp`, `warningCount`
- Example:

```
dc insight event query-event-histogram \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --start-time 2026-05-21T17:00:00Z --end-time 2026-05-21T18:00:00Z \
  --interval 60s -o json

# 返回结构：
#   items[].timestamp     桶起点 (RFC3339)
#   items[].normalCount   Normal 事件数
#   items[].warningCount  Warning 事件数
#   totalNormal           窗口内 Normal 总数
#   totalWarning          窗口内 Warning 总数
```

### `dc insight event query-events`

- Summary: Query K8s events of a cluster with filters and pagination
- HTTP: `GET /apis/insight.io/v1alpha1/event/cluster/{clusterName}/events`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): Required.
  - `--start-time` (query): startTime e.g. 2006-01-02T15:04:05.999999999Z07:00
  - `--end-time` (query): endTime e.g. 2006-01-02T15:04:05.999999999Z07:00
  - `--namespace` (query): Optional.
  - `--filter.type` (query, default `TYPE_UNSPECIFIED`, one of: TYPE_UNSPECIFIED|Normal|Warning): TYPE_UNSPECIFIED | Normal | Warning
  - `--filter.involve-object-kind` (query): filter.involveObjectKind
  - `--filter.reason` (query): filter.reason
  - `--filter.involve-object-name` (query): fuzzy search
  - `--filter.message` (query): fuzzy search
  - `--sort` (query): timestamp,desc (默认) | timestamp,asc | type,desc | type,asc
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `type`, `metadata.creationTimestamp`, `action`, `clusterName`; pagination `offset`
- Example:

```
# 最近 1 小时 insight-system 命名空间内的 Warning 事件
dc insight event query-events \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --start-time 2026-05-21T17:00:00Z --end-time 2026-05-21T18:00:00Z \
  --filter.type Warning \
  --page 1 --page-size 50 -o json

# 按 reason + involveObject + message 模糊过滤
dc insight event query-events \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --filter.reason FailedScheduling \
  --filter.involve-object-kind Pod \
  --filter.involve-object-name insight-server \
  --filter.message 'insufficient memory' \
  --sort 'timestamp,desc'

# 返回结构（items 数组每条）：
#   timestamp                 唯一主键，RFC3339Nano，可作 query-event-context 的 --timestamp
#   type                      Normal | Warning
#   reason / message / action / count / firstTimestamp / lastTimestamp
#   metadata.namespace        命名空间
#   metadata.name / uid       事件资源元信息
#   involveObject.kind        关联对象类型 (注意：不是 involvedObject)
#   involveObject.name
#   involveObject.namespace
#   clusterName / clusterUuid
```

## FeatureGate

### `dc insight featuregate get-feature-gate-by-id`

- Summary: Get a single feature gate by ID
- HTTP: `GET /apis/insight.io/v1alpha1/feature-gates/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required, one of: METRICS|LOGGING|TRACING|GRAPH_VIRTUAL_NODE|LOG_ALERT|NET_FLOW|EVENT|SLOW_SQL): id
- Example:

```
# id must be one of:
#   METRICS | LOGGING | TRACING | GRAPH_VIRTUAL_NODE
#   LOG_ALERT | NET_FLOW | EVENT | SLOW_SQL
dc insight featuregate get-feature-gate-by-id --id METRICS
dc insight featuregate get-feature-gate-by-id --id SLOW_SQL -o json
```

### `dc insight featuregate get-feature-gates`

- Summary: List all Insight feature gates and their enabled status
- HTTP: `GET /apis/insight.io/v1alpha1/feature-gates`
- Auth: required
- Body: none
- Flags: none
- Output: list path `items`; columns `name`, `id`, `description`, `enabled`, `status`
- Example:

```
dc insight featuregate get-feature-gates
dc insight featuregate get-feature-gates -o json
```

## Insight

### `dc insight insight get-global-config`

- Summary: Get Insight global configuration (retention, thresholds)
- HTTP: `GET /apis/insight.io/v1alpha1/config`
- Auth: required
- Body: none
- Flags: none
- Output: list path `errorRateThresholds`
- Example:

```
dc insight insight get-global-config
dc insight insight get-global-config -o json
```

### `dc insight insight get-helm-install-config`

- Summary: Generate Helm install parameters for the Insight agent chart
- HTTP: `POST /apis/insight.io/v1alpha1/agentinstallparam`
- Auth: required
- Body: required
- Flags: none
- Example:

```
# Get install params for insight-agent chart
dc insight insight get-helm-install-config \
  --set chartName=insight-agent \
  --set version=0.30.0

# With extra overrides
echo '{
  "chartName": "insight-agent",
  "version": "0.30.0",
  "extra": {
    "global.exporters.logging.enabled": true,
    "global.exporters.metrics.enabled": true
  }
}' | dc insight insight get-helm-install-config --file -
```

### `dc insight insight get-userinfo`

- Summary: Get current user's Insight permissions and accessible resource types
- HTTP: `GET /apis/insight.io/v1alpha1/userinfo`
- Auth: required
- Body: none
- Flags: none
- Output: list path `resourceTypes`
- Example:

```
dc insight insight get-userinfo
dc insight insight get-userinfo -o json
```

### `dc insight insight get-version`

- Summary: Get Insight server version info
- HTTP: `GET /apis/insight.io/v1alpha1/version`
- Auth: required
- Body: none
- Flags: none
- Example:

```
dc insight insight get-version
dc insight insight get-version -o json
```

### `dc insight insight update-global-config`

- Summary: Update Insight global configuration (retention, thresholds)
- HTTP: `PUT /apis/insight.io/v1alpha1/config`
- Auth: required
- Body: required
- Flags: none
- Output: list path `errorRateThresholds`
- Example:

```
# Update retention windows and APM thresholds
dc insight insight update-global-config \
  --set logRetentionTime=7d \
  --set k8sEventLogRetentionTime=7d \
  --set skoalaLogRetentionTime=7d \
  --set traceDataRetentionTime=15d \
  --set vmStorageRetentionTime=30d \
  --set alertHistoryRetentionTime=90 \
  --set traceApdexThreshold=500ms \
  --set slowSqlThreshold=1000 \
  --set-str 'latencyThresholds[0]=500' \
  --set-str 'latencyThresholds[1]=1000' \
  --set-str 'errorRateThresholds[0]=0.01' \
  --set-str 'errorRateThresholds[1]=0.05'

# Or pass the full body via stdin
echo '{
  "logRetentionTime": "7d",
  "k8sEventLogRetentionTime": "7d",
  "skoalaLogRetentionTime": "7d",
  "traceDataRetentionTime": "15d",
  "vmStorageRetentionTime": "30d",
  "alertHistoryRetentionTime": 90,
  "traceApdexThreshold": "500ms",
  "slowSqlThreshold": 1000,
  "latencyThresholds": [500, 1000],
  "errorRateThresholds": [0.01, 0.05]
}' | dc insight insight update-global-config --file -
```

## Log

### `dc insight log download-log`

- Summary: Export logs (or a context window) to a downloadable file
- HTTP: `POST /apis/insight.io/v1alpha1/log/export`
- Auth: required
- Body: required
- Flags: none
- Example:

```
KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)

# 字段说明：
#   type            导出格式枚举：TEXT(默认) / CSV / JSON
#   maxLines        导出上限 [0,10000]，0 视为 2000
#   fields          列枚举（TEXT/CSV 生效；JSON 输出完整记录），可选值：
#                   Timestamp | Cluster | Namespace | Pod | Container | Node | File
#   sorts           仅支持 "time,desc"（默认）或 "time,asc"
#   timeZone        导出时间戳的 IANA 时区，如 "Asia/Shanghai"
#   queryLog        或 queryLogContext，二选一（结构同 query-log / query-log-context）
echo '{
  "type": "CSV",
  "maxLines": 5000,
  "fields": ["Timestamp", "Cluster", "Namespace", "Pod", "Container"],
  "sorts": ["time,asc"],
  "timeZone": "Asia/Shanghai",
  "queryLog": {
    "startTime": "2026-05-21T00:00:00.000000000Z",
    "endTime":   "2026-05-21T01:00:00.000000000Z",
    "sorts":     ["time,asc"],
    "resource": {
      "clusterFilter":   ["'"$KUBESYSTEMID"'"],
      "namespaceFilter": ["insight-system"],
      "workloadFilter":  ["insight-server"]
    }
  }
}' | dc insight log download-log --file -

# 导出某条日志的上下文窗口
echo '{
  "type": "TEXT",
  "maxLines": 200,
  "fields": ["Timestamp", "Pod", "Container"],
  "queryLogContext": {
    "before": 100,
    "after":  100,
    "startTime":     "2026-05-21T00:00:00.000000000Z",
    "endTime":       "2026-05-21T01:00:00.000000000Z",
    "nanotimestamp": "2026-05-21T00:30:12.123456789Z",
    "resource": {
      "cluster":   "'"$KUBESYSTEMID"'",
      "namespace": "insight-system",
      "pod":       "insight-server-0",
      "container": "insight-server"
    }
  }
}' | dc insight log download-log --file -
```

### `dc insight log list-log-file-paths`

- Summary: List system log file paths discovered on a node
- HTTP: `GET /apis/insight.io/v1alpha1/log/filepaths`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): cluster
  - `--cluster-name` (query): clusterName
  - `--node` (query): node
- Output: list path `paths`
- Example:

```
# 用集群名（服务端解析为 UUID）
dc insight log list-log-file-paths --cluster-name kpanda-global-cluster --node node-1
# 或直接传 UUID
KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)
dc insight log list-log-file-paths --cluster "$KUBESYSTEMID" --node node-1 -o json
```

### `dc insight log query-log`

- Summary: Query container or system logs with filters and pagination
- HTTP: `POST /apis/insight.io/v1alpha1/log/query`
- Auth: required
- Body: required
- Flags: none
- Output: list path `items`; columns `log`, `timestamp`
- Example:

```
# 1) 先拿到集群 UUID
KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)

# 2) 容器日志：在 kpanda-global-cluster / insight-system 中检索包含 "error" 的日志
# 字段说明（resource filter）：
#   clusterFilter    集群 UUID 列表，必填且只能 1 个
#   namespaceFilter  命名空间精确匹配（需配合 clusterFilter）
#   workloadFilter   工作负载精确匹配；workloadSearch 为模糊
#   podFilter        Pod 精确匹配；podSearch 为模糊
#   containerFilter  容器精确匹配；containerSearch 为模糊
#   logSearch        日志正文关键字（多值 AND）
#   traceIdSearch    精确匹配 trace_id
#   luceneFilter     Lucene DSL，可选键：
#                    kubernetes.namespace_name.keyword / kubernetes.pod_name.keyword /
#                    kubernetes.container_name.keyword / trace_id.keyword / log
# 顶层字段：
#   startTime/endTime  RFC3339Nano，可空表示无界
#   page/pageSize      分页（默认 1/10，pageSize 软上限 100）
#   sorts              仅支持 time 字段；格式 "time,desc" 或 "time,asc"，默认 "time,desc"
echo '{
  "startTime": "2026-05-21T00:00:00.000000000Z",
  "endTime":   "2026-05-21T01:00:00.000000000Z",
  "page": 1,
  "pageSize": 100,
  "sorts": ["time,desc"],
  "resource": {
    "clusterFilter":   ["'"$KUBESYSTEMID"'"],
    "namespaceFilter": ["insight-system"],
    "workloadFilter":  ["insight-server"],
    "podSearch":       ["insight-server"],
    "logSearch":       ["error"],
    "luceneFilter":    "kubernetes.container_name.keyword:insight-server AND log:error"
  }
}' | dc insight log query-log --file -

# 3) 系统日志（节点 syslog）
# system filter 支持键：nodeFilter / fileFilter / logSearch / luceneFilter
# luceneFilter 可用键：syslog.host.keyword / syslog.file.keyword / syslog.ident.keyword / log
echo '{
  "startTime": "2026-05-21T00:00:00.000000000Z",
  "endTime":   "2026-05-21T01:00:00.000000000Z",
  "system": {
    "clusterFilter": ["'"$KUBESYSTEMID"'"],
    "nodeFilter":    ["node-1"],
    "fileFilter":    ["/var/log/messages"],
    "logSearch":     ["oom"]
  }
}' | dc insight log query-log --file -

# 返回结构（items 数组每条）：
#   timestamp                 RFC3339Nano，可直接作为 query-log-context 的 nanotimestamp
#   log                       日志正文
#   labels.cluster            集群 UUID
#   labels.namespace          命名空间（resource filter 时）
#   labels.pod                Pod 名称
#   labels.container          容器名称
#   labels.node / labels.file 节点 / 文件（system filter 时）
```

### `dc insight log query-log-context`

- Summary: Fetch lines before/after a specific log entry (context view)
- HTTP: `POST /apis/insight.io/v1alpha1/log/context`
- Auth: required
- Body: required
- Flags: none
- Output: list path `items`; columns `log`, `timestamp`
- Example:

```
KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)

# 容器日志上下文
# 字段说明：
#   before/after    锚点前/后行数，范围 [0,10000]，至少一个 > 0
#   nanotimestamp   锚点行的 RFC3339Nano 时间戳（必填）
#   startTime/endTime  搜索窗口（可选）
#   resource filter (全部必填)：cluster=集群 UUID, namespace, pod, container
#
# 推荐流程：先用 query-log 取锚点，再用 jq 提取 timestamp 与 labels.* 作为参数
LOG_RESULT=$(echo '{
  "startTime": "2026-05-21T00:00:00.000000000Z",
  "endTime":   "2026-05-21T01:00:00.000000000Z",
  "page": 1, "pageSize": 1,
  "resource": {
    "clusterFilter": ["'"$KUBESYSTEMID"'"],
    "logSearch": ["error"]
  }
}' | dc insight log query-log --file - -o json)

TS=$(echo "$LOG_RESULT" | jq -r '.items[0].timestamp')
NS=$(echo "$LOG_RESULT" | jq -r '.items[0].labels.namespace')
POD=$(echo "$LOG_RESULT" | jq -r '.items[0].labels.pod')
CT=$(echo "$LOG_RESULT" | jq -r '.items[0].labels.container')

echo '{
  "before": 50,
  "after":  50,
  "startTime":     "2026-05-21T00:00:00.000000000Z",
  "endTime":       "2026-05-21T01:00:00.000000000Z",
  "nanotimestamp": "'"$TS"'",
  "resource": {
    "cluster":   "'"$KUBESYSTEMID"'",
    "namespace": "'"$NS"'",
    "pod":       "'"$POD"'",
    "container": "'"$CT"'"
  }
}' | dc insight log query-log-context --file -

# 系统日志上下文（system filter 三字段全部必填：cluster / node / file）
echo '{
  "before": 30,
  "after":  30,
  "startTime":     "2026-05-21T00:00:00.000000000Z",
  "endTime":       "2026-05-21T01:00:00.000000000Z",
  "nanotimestamp": "2026-05-21T00:30:12.123456789Z",
  "system": {
    "cluster": "'"$KUBESYSTEMID"'",
    "node":    "node-1",
    "file":    "/var/log/messages"
  }
}' | dc insight log query-log-context --file -
```

### `dc insight log query-log-histogram`

- Summary: Bucket log counts over time (histogram)
- HTTP: `POST /apis/insight.io/v1alpha1/log/histogram`
- Auth: required
- Body: required
- Flags: none
- Output: list path `items`; columns `count`, `timestamp`
- Example:

```
KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)

# 字段说明：
#   startTime/endTime  RFC3339Nano（必填）
#   interval           ES date_histogram 间隔，如 "1m"/"5m"/"1h"（必填）
#   resource/system    与 query-log 相同的 filter 二选一
echo '{
  "startTime": "2026-05-21T00:00:00.000000000Z",
  "endTime":   "2026-05-21T01:00:00.000000000Z",
  "interval":  "1m",
  "resource": {
    "clusterFilter":   ["'"$KUBESYSTEMID"'"],
    "namespaceFilter": ["insight-system"],
    "logSearch":       ["error"]
  }
}' | dc insight log query-log-histogram --file -
```

### `dc insight log search-log`

- Summary: Raw Elasticsearch DSL passthrough (advanced)
- HTTP: `GET /apis/insight.io/v1alpha1/log/search`
- Auth: required
- Body: none
- Flags:
  - `--index` (query): index
  - `--query` (query): query
- Example:

```
# --index 传 ILM 索引后缀（服务端会补前缀），常用 "insight-logs-*"
# --query 必须是合法的 ES DSL JSON 字符串
dc insight log search-log \
  --index 'insight-logs-*' \
  --query '{"query":{"match":{"log":"timeout"}}}'

# 在 insight-system 命名空间内查最近 1h 含 "error" 的日志
dc insight log search-log \
  --index 'insight-logs-*' \
  --query '{
    "size": 100,
    "sort": [{"@timestamp":"desc"}],
    "query": {
      "bool": {
        "must":   [{"match": {"log": "error"}}],
        "filter": [
          {"term":  {"kubernetes.namespace_name.keyword": "insight-system"}},
          {"range": {"@timestamp": {"gte": "now-1h", "lte": "now"}}}
        ]
      }
    }
  }' -o json
```

## Metric

### `dc insight metric batch-query-metric`

- Summary: Run multiple PromQL instant queries in one call (shared label match)
- HTTP: `POST /apis/insight.io/v1alpha1/metric/query`
- Auth: required
- Body: required
- Flags: none
- Output: list path `data`; columns `errorMessage`, `status`
- Example:

```
# matchLabel 字段说明：
#   clusterName  集群名（与 cluster 二选一）
#   cluster      集群 UUID（与 clusterName 二选一）
#   namespace    可选
#   extraLabel   附加 label 过滤（map<string,string>），会注入到每条 query
# param.time     unix 秒
# queryList      PromQL 数组，非空
echo '{
  "matchLabel": {
    "clusterName": "kpanda-global-cluster",
    "namespace":   "insight-system"
  },
  "param": {"time": '"$(date +%s)"'},
  "queryList": [
    "up",
    "sum(rate(container_cpu_usage_seconds_total[5m]))"
  ]
}' | dc insight metric batch-query-metric --file - -o json

# 返回结构：
#   data[].data.vector[]  与 query-metric 同结构
#   data[].status         SUCCESS | FAIL
#   data[].errorMessage   失败时的错误信息
# data 数组按 queryList 顺序一一对应。
```

### `dc insight metric batch-query-range-metric`

- Summary: Run multiple PromQL range queries in one call (shared label match)
- HTTP: `POST /apis/insight.io/v1alpha1/metric/queryrange`
- Auth: required
- Body: required
- Flags: none
- Output: list path `data`; columns `errorMessage`, `status`
- Example:

```
# param.start/end 为 unix 秒，step 为秒 (double)
END=$(date +%s); START=$((END - 3600))
echo '{
  "matchLabel": {
    "clusterName": "kpanda-global-cluster",
    "namespace":   "insight-system"
  },
  "param": {"start": '"$START"', "end": '"$END"', "step": 60},
  "queryList": [
    "up",
    "sum(rate(container_cpu_usage_seconds_total[5m]))"
  ]
}' | dc insight metric batch-query-range-metric --file - -o json

# 返回结构：
#   data[].data.matrix[]  与 query-range-metric 同结构
#   data[].status         SUCCESS | FAIL
#   data[].errorMessage
# data 数组按 queryList 顺序一一对应。
```

### `dc insight metric format-query`

- Summary: Pretty-print / normalize a PromQL expression (server-side formatter)
- HTTP: `POST /apis/insight.io/v1alpha1/metric/format_query`
- Auth: required
- Body: required
- Flags: none
- Example:

```
echo '{"query":"sum(rate(http_requests_total{code=~\"5..\"}[5m]))/sum(rate(http_requests_total[5m]))"}' \
  | dc insight metric format-query --file - -o json

# 返回结构：{ "query": "<格式化后的 PromQL>" }（对象，非数组）
```

### `dc insight metric query-metric`

- Summary: Run a PromQL instant query (Prometheus /api/v1/query)
- HTTP: `GET /apis/insight.io/v1alpha1/metric/query`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): cluster
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): namespace
  - `--query` (query): query
  - `--time` (query, int64): Optional, current server time is used if the time parameter is omitted.
- Output: list path `vector`
- Example:

```
# 用集群名 - 当前所有 targets 的 up 状态
dc insight metric query-metric \
  --cluster-name kpanda-global-cluster \
  --query 'up' -o json

# 用集群 UUID（与 --cluster-name 二选一）
KUBESYSTEMID=$(dc insight resource get-cluster --name kpanda-global-cluster -o json | jq -r .kubeSystemId)
dc insight metric query-metric --cluster "$KUBESYSTEMID" --query 'up' -o json

# 指定命名空间 + 时间戳（unix 秒）的瞬时 CPU 查询
dc insight metric query-metric \
  --cluster-name kpanda-global-cluster \
  --namespace insight-system \
  --query 'sum(rate(container_cpu_usage_seconds_total{namespace="insight-system"}[5m])) by (pod)' \
  --time 1747850400 -o json

# 返回结构：vector 数组，每项 { metric: {labels}, values: { timestamp, value } }
```

### `dc insight metric query-range-metric`

- Summary: Run a PromQL range query (Prometheus /api/v1/query_range)
- HTTP: `GET /apis/insight.io/v1alpha1/metric/queryrange`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): cluster
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): namespace
  - `--query` (query): query
  - `--start` (query, int64): start
  - `--end` (query, int64): end
  - `--step` (query, double): step
- Output: list path `matrix`
- Example:

```
# 最近 1 小时 up 指标，30s 采样
END=$(date +%s); START=$((END - 3600))
dc insight metric query-range-metric \
  --cluster-name kpanda-global-cluster \
  --query 'up' \
  --start $START --end $END --step 30 -o json

# insight-system 命名空间内 Pod CPU 使用率
dc insight metric query-range-metric \
  --cluster-name kpanda-global-cluster \
  --namespace insight-system \
  --query 'sum(rate(container_cpu_usage_seconds_total[5m])) by (pod)' \
  --start $START --end $END --step 60 -o json

# 字段说明：
#   --start/--end  unix 秒 (int64)
#   --step         采样间隔秒 (double)，可传小数
# 返回结构：matrix 数组，每项 { metric: {labels}, values: [{timestamp,value}, ...] }
```

## Overview

### `dc insight overview get-resources-count`

- Summary: Get global resource counts (clusters / nodes / pods / deployments / GPU / log / trace)
- HTTP: `GET /apis/insight.io/v1alpha1/overview/resources/count`
- Auth: required
- Body: none
- Flags:
  - `--time` (query, int64): time unix timestamp .e.g. 1697597347
  - `--filters` (query): 可重复传入。可选值： CLUSTER_TOTAL | CLUSTER_NORMAL_TOTAL NODE_TOTAL | NODE_NORMAL_TOTAL DEPLOYMENT_TOTAL | DEPLOYMENT_NORMAL_TOTAL STATEFULSET_TOTAL | STATEFULSET_NORMAL_TOTAL DAEMONSET_TOTAL | DAEMONSET_NORMAL_TOTAL JOB_TOTAL | JOB_NORMAL_TOTAL POD_TOTAL | POD_NORMAL_TOTAL GPU_COUNT | GPU_ALLOCATED_COUNT LOG_TOTAL | TRACE_TOTAL 省略时返回上述全部 16 项。
- Output: list path `data`; columns `errorMessage`, `status`
- Example:

```
# 默认返回 16 个资源类型
dc insight overview get-resources-count -o json

# 指定时间点（unix 秒）+ 仅查集群与节点
dc insight overview get-resources-count \
  --time $(date +%s) \
  --filters CLUSTER_TOTAL --filters CLUSTER_NORMAL_TOTAL \
  --filters NODE_TOTAL --filters NODE_NORMAL_TOTAL -o json
```

### `dc insight overview get-resources-range`

- Summary: Get resource counts over a time range (sparkline data)
- HTTP: `GET /apis/insight.io/v1alpha1/overview/resources/range`
- Auth: required
- Body: none
- Flags:
  - `--filters` (query): 可重复传入。可选值： NODE_TOTAL | POD_TOTAL | POD_NORMAL_TOTAL | POD_ABNORMAL_TOTAL 省略时默认 [NODE_TOTAL, POD_NORMAL_TOTAL, POD_ABNORMAL_TOTAL]。
  - `--start` (query, int64): start unix timestamp .e.g. 1697597347
  - `--end` (query, int64): end unix timestamp .e.g. 1697597347
  - `--step` (query, double): 采样间隔秒 (double)。默认 60。
- Output: list path `data`; columns `errorMessage`, `status`
- Example:

```
# 最近 1 小时，60s 采样
END=$(date +%s); START=$((END - 3600))
dc insight overview get-resources-range \
  --start $START --end $END --step 60 \
  --filters NODE_TOTAL --filters POD_NORMAL_TOTAL --filters POD_ABNORMAL_TOTAL -o json
```

### `dc insight overview get-resources-usage`

- Summary: Get top-N resource usage time series (CPU / memory / disk) for clusters or nodes
- HTTP: `GET /apis/insight.io/v1alpha1/overview/resources/usage`
- Auth: required
- Body: none
- Flags:
  - `--filters` (query): 可重复传入。可选值： CLUSTER_CPU_USAGE | CLUSTER_MEM_USAGE | CLUSTER_DISK_USAGE NODE_CPU_USAGE | NODE_MEM_USAGE | NODE_DISK_USAGE 省略时默认 [CLUSTER_CPU_USAGE, NODE_CPU_USAGE]。
  - `--limit` (query, int64): Top-N 上限（按值降序）。默认 5。
  - `--start` (query, int64): start unix timestamp .e.g. 1697597347
  - `--end` (query, int64): end unix timestamp .e.g. 1697597347
  - `--step` (query, double): 采样间隔秒 (double)。默认 60。
- Output: list path `data`; columns `errorMessage`, `status`; pagination `cursor`
- Example:

```
END=$(date +%s); START=$((END - 3600))
# 节点 CPU 使用率 Top 5
dc insight overview get-resources-usage \
  --start $START --end $END --step 60 \
  --filters NODE_CPU_USAGE --limit 5 -o json

# 集群级 CPU 使用率
dc insight overview get-resources-usage \
  --start $START --end $END --step 60 \
  --filters CLUSTER_CPU_USAGE --limit 10 -o json
```

### `dc insight overview get-services-monitor`

- Summary: Get a snapshot of service-level APM signals (avg latency / error rate)
- HTTP: `GET /apis/insight.io/v1alpha1/overview/services/monitor`
- Auth: required
- Body: none
- Flags:
  - `--filters` (query): 可重复传入。可选值： AVG_LATENCY 返回值单位 ms ERR_RATE 返回值为百分比 省略时默认 [AVG_LATENCY, ERR_RATE]。
  - `--limit` (query, int64): Top-N 上限（按值降序）。默认 5。
  - `--time` (query, int64): timestamp unix timestamp .e.g. 1697597347
  - `--span-kinds` (query): spanKinds is the list of span kinds to include (logical OR) in the resulting metrics aggregation.
- Output: list path `data`; columns `errorMessage`, `status`; pagination `cursor`
- Example:

```
# 默认 - 平均延迟 + 错误率，Top 5
dc insight overview get-services-monitor -o json

# 限制返回 10 条
dc insight overview get-services-monitor --limit 10 -o json

# 指定时间点 + 仅统计 SERVER span
dc insight overview get-services-monitor \
  --time $(date +%s) --limit 5 \
  --span-kinds SPAN_KIND_SERVER -o json
```

## Probe

### `dc insight probe add-probe`

- Summary: Create a probe (PrometheusOperator Probe / blackbox-exporter)
- HTTP: `POST /apis/insight.io/v1alpha1/clusters/{clusterName}/namespaces/{namespace}/probes`
- Auth: required
- Body: required
- Flags:
  - `--cluster-name` (path, required): clusterName
  - `--namespace` (path, required): namespace
- Example:

```
# 1) 先查可用 prober + module
dc insight probe list-probers --cluster-name kpanda-global-cluster -o json

# 2) 用上一步返回的 prober.url / 选定 module 创建
# 字段说明（probe / ProbeSpec）：
#   jobName        必填，^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$，1~63
#   module         必填，须在该 prober 的 modules 列表中
#                  常见: http_2xx | HTTP_GET | HTTP_POST | TCP | POP3S | SSH
#   interval       抓取间隔（go duration），如 "30s"
#   scrapeTimeout  抓取超时
#   prober         { name, url, scheme(http/https), path(/probe), proxyUrl }
#   targets.staticConfig.static  目标地址列表
#   targets.staticConfig.labels  附加 label（map<string,string>）
#   可选：proxyUrl / enableHttp2 / followRedirects / sampleLimit /
#        honorTimestamps / honorLabels / relabelings / metricRelabelings
echo '{
  "probe": {
    "jobName":       "web-check",
    "module":        "http_2xx",
    "interval":      "30s",
    "scrapeTimeout": "10s",
    "prober": {
      "name":   "insight-agent-prometheus-blackbox-exporter",
      "url":    "insight-agent-prometheus-blackbox-exporter.insight-system:9115",
      "scheme": "http",
      "path":   "/probe"
    },
    "targets": {
      "staticConfig": {
        "static": [
          "https://example.com",
          "https://api.example.com/health"
        ],
        "labels": {"team": "ops"}
      }
    }
  }
}' | dc insight probe add-probe \
      --cluster-name kpanda-global-cluster --namespace insight-system --file -
```

### `dc insight probe delete-probe`

- Summary: Delete a probe by cluster + namespace + jobName
- HTTP: `DELETE /apis/insight.io/v1alpha1/clusters/{clusterName}/namespaces/{namespace}/probes/{jobName}`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): clusterName
  - `--namespace` (path, required): namespace
  - `--job-name` (path, required): jobName
- Example:

```
dc insight probe delete-probe \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --job-name web-check
```

### `dc insight probe get-probe`

- Summary: Get a probe by cluster + namespace + jobName
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{clusterName}/namespaces/{namespace}/probes/{jobName}`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): clusterName
  - `--namespace` (path, required): namespace
  - `--job-name` (path, required): jobName
- Example:

```
dc insight probe get-probe \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --job-name web-check -o json

# 资源不存在时返回 HTTP 404。
```

### `dc insight probe list-probers`

- Summary: List blackbox-exporter probers available in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{clusterName}/probers`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): clusterName
- Output: list path `probers`
- Example:

```
dc insight probe list-probers --cluster-name kpanda-global-cluster -o json

# 返回结构：
#   probers[].prober          ProberSpec { name, url, scheme, path, proxyUrl }
#   probers[].modules         该 prober 支持的模块名数组，例如：
#                             [http_2xx, HTTP_GET, HTTP_POST, TCP, POP3S, SSH]
#   probers[].configmapMeta   { clusterName, namespace, name, data } 模块定义来源
```

### `dc insight probe list-probes`

- Summary: List probes in a cluster + namespace
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{clusterName}/namespaces/{namespace}/probes`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): clusterName
  - `--namespace` (path, required): namespace
  - `--fuzzy-name` (query): FuzzyName is used to fuzzy search by multiple parameters including name.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sorts` (query): 单一排序字段，格式 "<field>[,asc|desc]"，仅省略方向时默认 desc。 支持：job_name,desc | job_name,asc | create_at,desc | create_at,asc 默认：create_at,desc
- Output: list path `items`; columns `metadata.name`, `metadata.namespace`, `status.phase`, `kind`, `metadata.creationTimestamp`, `apiVersion`; pagination `offset`
- Example:

```
dc insight probe list-probes \
  --cluster-name kpanda-global-cluster --namespace insight-system -o json

# 模糊搜索 + 分页 + 排序
dc insight probe list-probes \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --fuzzy-name http --sorts 'create_at,desc' \
  --page 1 --page-size 50 -o json

# 返回 items[] 每条结构：
#   kind / apiVersion / metadata
#   spec { jobName, module, prober, targets, interval, scrapeTimeout, ... }
#   status.phase  Pending | Running | Failed
```

### `dc insight probe update-probe`

- Summary: Update a probe's interval / scrapeTimeout / module / targets
- HTTP: `PUT /apis/insight.io/v1alpha1/clusters/{clusterName}/namespaces/{namespace}/probes/{jobName}`
- Auth: required
- Body: required
- Flags:
  - `--cluster-name` (path, required): clusterName
  - `--namespace` (path, required): namespace
  - `--job-name` (path, required): jobName
- Example:

```
# 只能更新这 4 个字段；其他 spec 字段（prober/relabelings/...) 需删了重建。
echo '{
  "interval":      "60s",
  "scrapeTimeout": "15s",
  "module":        "http_2xx",
  "targets": {
    "staticConfig": {
      "static": ["https://example.com"],
      "labels": {"team": "ops", "tier": "edge"}
    }
  }
}' | dc insight probe update-probe \
      --cluster-name kpanda-global-cluster --namespace insight-system \
      --job-name web-check --file -
```

## Resource

### `dc insight resource get-agent-summary`

- Summary: Get the insight-agent component summary for a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/agent`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): use cluster_name
- Example:

```
dc insight resource get-agent-summary --cluster prod-1
dc insight resource get-agent-summary --cluster prod-1 -o json
```

### `dc insight resource get-cluster`

- Summary: Get cluster details by name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{name}`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): name
- Example:

```
dc insight resource get-cluster --name prod-1
dc insight resource get-cluster --name prod-1 -o json
```

### `dc insight resource get-cronjob`

- Summary: Get a CronJob by cluster + namespace + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronjobs/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
- Output: list path `conditions`; columns `type`, `lastTransitionTime`, `lastUpdateTime`, `message`, `reason`, `status`
- Example: `dc insight resource get-cronjob --cluster prod-1 --namespace default --name nightly-backup`

### `dc insight resource get-cronjob-pods`

- Summary: List pods spawned by a CronJob
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/cronjobs/{name}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
  - `--pod` (query): pod
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `name`, `namespace`, `phase`, `cpuUsage`, `memoryUsage`, `nodeName`; pagination `offset`
- Example:

```
dc insight resource get-cronjob-pods \
  --cluster prod-1 --namespace default --name nightly-backup \
  --page 1 --page-size 50 -o json
```

### `dc insight resource get-daemonset`

- Summary: Get a DaemonSet by cluster + namespace + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/daemonsets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
- Output: list path `conditions`; columns `type`, `lastTransitionTime`, `lastUpdateTime`, `message`, `reason`, `status`
- Example: `dc insight resource get-daemonset --cluster prod-1 --namespace kube-system --name fluent-bit`

### `dc insight resource get-daemonset-pods`

- Summary: List pods belonging to a DaemonSet
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/daemonsets/{name}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
  - `--pod` (query): pod
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `name`, `namespace`, `phase`, `cpuUsage`, `memoryUsage`, `nodeName`; pagination `offset`
- Example:

```
dc insight resource get-daemonset-pods \
  --cluster prod-1 --namespace kube-system --name fluent-bit \
  --page 1 --page-size 50 -o json
```

### `dc insight resource get-deployment`

- Summary: Get a Deployment by cluster + namespace + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
- Output: list path `conditions`; columns `type`, `lastTransitionTime`, `lastUpdateTime`, `message`, `reason`, `status`
- Example: `dc insight resource get-deployment --cluster prod-1 --namespace default --name my-app`

### `dc insight resource get-deployment-pods`

- Summary: List pods belonging to a Deployment
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/deployments/{name}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
  - `--pod` (query): pod
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `name`, `namespace`, `phase`, `cpuUsage`, `memoryUsage`, `nodeName`; pagination `offset`
- Example:

```
dc insight resource get-deployment-pods \
  --cluster prod-1 --namespace default --name my-app
dc insight resource get-deployment-pods \
  --cluster prod-1 --namespace default --name my-app \
  --pod my-app-abc --page 1 --page-size 50 -o json
```

### `dc insight resource get-job`

- Summary: Get a Job by cluster + namespace + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/jobs/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
- Output: list path `conditions`; columns `type`, `lastTransitionTime`, `lastUpdateTime`, `message`, `reason`, `status`
- Example: `dc insight resource get-job --cluster prod-1 --namespace default --name backup-20240101`

### `dc insight resource get-job-pods`

- Summary: List pods belonging to a Job
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/jobs/{name}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
  - `--pod` (query): pod
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `name`, `namespace`, `phase`, `cpuUsage`, `memoryUsage`, `nodeName`; pagination `offset`
- Example:

```
dc insight resource get-job-pods \
  --cluster prod-1 --namespace default --name backup-20240101 \
  --page 1 --page-size 50 -o json
```

### `dc insight resource get-namespace`

- Summary: Get a namespace by cluster + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--name` (path, required): name
- Example: `dc insight resource get-namespace --cluster prod-1 --name kube-system`

### `dc insight resource get-node`

- Summary: Get node details by cluster + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/nodes/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--name` (path, required): name
- Example:

```
dc insight resource get-node --cluster prod-1 --name node-1
dc insight resource get-node --cluster prod-1 --name node-1 -o json
```

### `dc insight resource get-node-gpu-dashboards`

- Summary: Get GPU dashboard URLs for a node
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/nodes/{name}/dashboards/gpu`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--name` (path, required): name
- Output: list path `urls`; columns `en`, `vendor`, `zh`
- Example:

```
dc insight resource get-node-gpu-dashboards --cluster prod-1 --name node-1
dc insight resource get-node-gpu-dashboards --cluster prod-1 --name node-1 -o json
```

### `dc insight resource get-pod`

- Summary: Get pod details by cluster + namespace + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
- Output: list path `conditions`; columns `type`, `lastTransitionTime`, `lastUpdateTime`, `message`, `reason`, `status`
- Example:

```
dc insight resource get-pod --cluster prod-1 --namespace default --name my-app-abc123
dc insight resource get-pod --cluster prod-1 --namespace default --name my-app-abc123 -o json
```

### `dc insight resource get-pod-gpu-dashboards`

- Summary: Get GPU dashboard URLs for a pod
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}/dashboards/gpu`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
- Output: list path `urls`; columns `en`, `vendor`, `zh`
- Example:

```
dc insight resource get-pod-gpu-dashboards \
  --cluster prod-1 --namespace default --name my-gpu-pod
```

### `dc insight resource get-pod-jvm-dashboards`

- Summary: Get JVM dashboard URLs for a pod (Java workloads)
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}/dashboards/jvm`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Required.
  - `--namespace` (path, required): required;
  - `--name` (path, required): required;
  - `--start` (query, int64): start
  - `--end` (query, int64): end
  - `--step` (query, double): step
- Example:

```
dc insight resource get-pod-jvm-dashboards \
  --cluster prod-1 --namespace default --name my-java-pod \
  --start 1700000000 --end 1700003600 --step 30
```

### `dc insight resource get-pod-metrics`

- Summary: Get pod metrics over a time range (CPU / memory / network)
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}/metrics`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): Required.
  - `--namespace` (path, required): Required;
  - `--name` (path, required): Required, Pod's name;
  - `--start` (query, int64): start=<rfc3339 | unix_timestamp> Start timestamp, inclusive.
  - `--end` (query, int64): start=<rfc3339 | unix_timestamp> End timestamp, inclusive. Optional.
  - `--step` (query, double): Query resolution step width in duration format or float number of seconds. Optional.
  - `--query-list` (query): Query list. support below metrics:
- Output: list path `metrics`; columns `errorMessage`, `status`
- Example:

```
# 时间格式：--start / --end 同时接受 unix 秒 (int) 或 RFC3339 字符串
# --step 单位为秒
END=$(date +%s); START=$((END - 3600))

# 最近 1 小时，30s 步长
dc insight resource get-pod-metrics \
  --cluster kpanda-global-cluster --namespace kube-system \
  --name coredns-6d4d6f8c7-x8zvw \
  --start $START --end $END --step 30 -o json

# 指定 metric 子集（PromQL-like keys，服务端定义）
dc insight resource get-pod-metrics \
  --cluster kpanda-global-cluster --namespace kube-system \
  --name coredns-6d4d6f8c7-x8zvw \
  --start $START --end $END --step 30 \
  --query-list cpuUsage --query-list memoryUsage -o json

# 输出：.metrics 字段（按 metric key 分组的时序数据）
```

### `dc insight resource get-server-component-summary`

- Summary: Get insight-server-side component status summary (cluster-agnostic)
- HTTP: `GET /apis/insight.io/v1alpha1/server/component`
- Auth: required
- Body: none
- Flags: none
- Output: list path `summary`; columns `name`, `phase`, `creationTimestamp`, `availability`, `message`, `version`
- Example:

```
# 不需要 --cluster 参数；查询 Insight 服务端各组件健康状态。
dc insight resource get-server-component-summary -o json
```

### `dc insight resource get-service`

- Summary: Get a Service (with linked workloads) by cluster + namespace + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/services/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
- Output: list path `workloadData`; columns `name`, `workloadKind`
- Example: `dc insight resource get-service --cluster prod-1 --namespace default --name my-app`

### `dc insight resource get-statefulset`

- Summary: Get a StatefulSet by cluster + namespace + name
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
- Output: list path `conditions`; columns `type`, `lastTransitionTime`, `lastUpdateTime`, `message`, `reason`, `status`
- Example: `dc insight resource get-statefulset --cluster prod-1 --namespace default --name my-db`

### `dc insight resource get-statefulset-pods`

- Summary: List pods belonging to a StatefulSet
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/statefulsets/{name}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
  - `--namespace` (path, required): namespace
  - `--name` (path, required): name
  - `--pod` (query): pod
  - `--page` (query, default `1`, int32): page
  - `--page-size` (query, default `20`, int32): pageSize
- Output: list path `items`; columns `name`, `namespace`, `phase`, `cpuUsage`, `memoryUsage`, `nodeName`; pagination `offset`
- Example:

```
dc insight resource get-statefulset-pods \
  --cluster prod-1 --namespace default --name my-db \
  --page 1 --page-size 50 -o json
```

### `dc insight resource list-cluster-summary`

- Summary: List clusters with status/version/role summary
- HTTP: `GET /apis/insight.io/v1alpha1/clustersummary`
- Auth: required
- Body: none
- Flags:
  - `--name` (query): filter cluster by name
  - `--version` (query): filter cluster by k8s version
  - `--phase` (query, default `CLUSTER_PHASE_UNSPECIFIED`, one of: CLUSTER_PHASE_UNSPECIFIED|UNKNOWN|CREATING|RUNNING|UPDATING|DELETING|FAILED): CLUSTER_PHASE_UNSPECIFIED | UNKNOWN | CREATING | RUNNING | UPDATING | DELETING | FAILED
  - `--show-all-cluster` (query): show_all_cluster default is false, will only return cluster with
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `phase`, `accessScope`, `kubeSystemId`, `role`; pagination `offset`
- Example:

```
dc insight resource list-cluster-summary
dc insight resource list-cluster-summary --phase RUNNING --version v1.28 \
  --page 1 --page-size 50 -o json
```

### `dc insight resource list-clusters`

- Summary: List all clusters known to Insight
- HTTP: `GET /apis/insight.io/v1alpha1/clusters`
- Auth: required
- Body: none
- Flags:
  - `--show-all-cluster` (query): show_all_cluster default is false, will only return cluster with
- Output: list path `items`; columns `name`, `phase`, `accessScope`, `kubeSystemId`, `role`
- Example:

```
dc insight resource list-clusters
# Include clusters that have not enabled monitoring
dc insight resource list-clusters --show-all-cluster=true -o json
```

### `dc insight resource list-cronjobs`

- Summary: List CronJobs in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/cronjobs`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter jobs by cluster
  - `--namespace` (query): filter jobs by namespace
  - `--phase` (query, default `JOB_STATE_UNSPECIFIED`, one of: JOB_STATE_UNSPECIFIED|JOB_STATE_WAITING|JOB_STATE_RUNNING|JOB_STATE_COMPLETED|JOB_STATE_DELETING|JOB_STATE_FAILED): JOB_STATE_UNSPECIFIED | JOB_STATE_WAITING | JOB_STATE_RUNNING | JOB_STATE_COMPLETED | JOB_STATE_DELETING | JOB_STATE_FAILED
  - `--name` (query): filter jobs by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `namespace`, `phase`; pagination `offset`
- Example:

```
dc insight resource list-cronjobs --cluster prod-1
dc insight resource list-cronjobs --cluster prod-1 --namespace default \
  --phase JOB_STATE_RUNNING -o json
```

### `dc insight resource list-daemonsets`

- Summary: List DaemonSets in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/daemonsets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter workloads by cluster
  - `--namespace` (query): filter workloads by namespace
  - `--name` (query): filter workloads by name
  - `--phase` (query, default `WORKLOAD_STATE_UNKNOWN`, one of: WORKLOAD_STATE_UNKNOWN|WORKLOAD_STATE_RUNNING|WORKLOAD_STATE_DELETING|WORKLOAD_STATE_NOT_READY|WORKLOAD_STATE_STOPPED|WORKLOAD_STATE_WAITING): WORKLOAD_STATE_UNKNOWN | WORKLOAD_STATE_RUNNING | WORKLOAD_STATE_DELETING | WORKLOAD_STATE_NOT_READY | WORKLOAD_STATE_STOPPED | WORKLOAD_STATE_WAITING
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `namespace`, `phase`; pagination `offset`
- Example:

```
dc insight resource list-daemonsets --cluster prod-1
dc insight resource list-daemonsets --cluster prod-1 --namespace kube-system \
  --phase WORKLOAD_STATE_NOT_READY -o json
```

### `dc insight resource list-deployments`

- Summary: List Deployments in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/deployments`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter workloads by cluster
  - `--namespace` (query): filter workloads by namespace
  - `--name` (query): filter workloads by name
  - `--phase` (query, default `WORKLOAD_STATE_UNKNOWN`, one of: WORKLOAD_STATE_UNKNOWN|WORKLOAD_STATE_RUNNING|WORKLOAD_STATE_DELETING|WORKLOAD_STATE_NOT_READY|WORKLOAD_STATE_STOPPED|WORKLOAD_STATE_WAITING): WORKLOAD_STATE_UNKNOWN | WORKLOAD_STATE_RUNNING | WORKLOAD_STATE_DELETING | WORKLOAD_STATE_NOT_READY | WORKLOAD_STATE_STOPPED | WORKLOAD_STATE_WAITING
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `namespace`, `phase`; pagination `offset`
- Example:

```
dc insight resource list-deployments --cluster kpanda-global-cluster
dc insight resource list-deployments --cluster kpanda-global-cluster --namespace kube-system \
  --phase WORKLOAD_STATE_NOT_READY -o json

# 输出：.items[] 主要字段 name / namespace / tracingEnabled
# （Deployment 详情通过 get-deployment 获取，含 conditions / metadata 等完整字段）
```

### `dc insight resource list-jobs`

- Summary: List Jobs in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/jobs`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter jobs by cluster
  - `--namespace` (query): filter jobs by namespace
  - `--phase` (query, default `JOB_STATE_UNSPECIFIED`, one of: JOB_STATE_UNSPECIFIED|JOB_STATE_WAITING|JOB_STATE_RUNNING|JOB_STATE_COMPLETED|JOB_STATE_DELETING|JOB_STATE_FAILED): JOB_STATE_UNSPECIFIED | JOB_STATE_WAITING | JOB_STATE_RUNNING | JOB_STATE_COMPLETED | JOB_STATE_DELETING | JOB_STATE_FAILED
  - `--name` (query): filter jobs by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `namespace`, `status.phase`; pagination `offset`
- Example:

```
dc insight resource list-jobs --cluster prod-1
dc insight resource list-jobs --cluster prod-1 --namespace default \
  --phase JOB_STATE_FAILED -o json
```

### `dc insight resource list-namespaces`

- Summary: List namespaces in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): cluster
- Output: list path `namespaces`; columns `name`, `role`
- Example:

```
# --cluster 必填（集群名或 UUID）
dc insight resource list-namespaces --cluster kpanda-global-cluster -o json

# 备注：返回的 items 仅包含被 Insight 监控覆盖的命名空间；
# 如果为空，可能是该集群 insight-agent 未启用或采集尚未生效。
```

### `dc insight resource list-nodes`

- Summary: List nodes in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/nodes`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter nodes by cluster
  - `--phase` (query, default `NODE_PHASE_UNSPECIFIED`, one of: NODE_PHASE_UNSPECIFIED|NODE_PHASE_READY|NODE_PHASE_NOT_READY|NODE_PHASE_UNKNOWN): NODE_PHASE_UNSPECIFIED | NODE_PHASE_READY | NODE_PHASE_NOT_READY | NODE_PHASE_UNKNOWN
  - `--name` (query): filter nodes by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `phase`; pagination `offset`
- Example:

```
dc insight resource list-nodes --cluster prod-1
dc insight resource list-nodes --cluster prod-1 --phase NODE_PHASE_NOT_READY -o json
dc insight resource list-nodes --cluster prod-1 --name node- --page 1 --page-size 50
```

### `dc insight resource list-pod-containers`

- Summary: List containers within a pod
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/namespaces/{namespace}/pods/{name}/containers`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter nodes by cluster
  - `--namespace` (path, required): filter nodes by namespace
  - `--name` (path, required): filter containers by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `phase`; pagination `offset`
- Example:

```
dc insight resource list-pod-containers \
  --cluster prod-1 --namespace default --name my-app-abc123
dc insight resource list-pod-containers \
  --cluster prod-1 --namespace default --name my-app-abc123 \
  --page 1 --page-size 50 -o json
```

### `dc insight resource list-pods`

- Summary: List pods in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/pods`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter nodes by cluster
  - `--namespace` (query): filter nodes by namespaces
  - `--phase` (query, default `POD_PHASE_UNSPECIFIED`, one of: POD_PHASE_UNSPECIFIED|POD_PHASE_UNKNOWN|POD_PHASE_PENDING|POD_PHASE_RUNNING|POD_PHASE_SUCCEED|POD_PHASE_FAILED): POD_PHASE_UNSPECIFIED | POD_PHASE_UNKNOWN | POD_PHASE_PENDING | POD_PHASE_RUNNING | POD_PHASE_SUCCEED | POD_PHASE_FAILED
  - `--name` (query): filter pods by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `namespace`, `phase`, `cpuUsage`, `memoryUsage`, `nodeName`; pagination `offset`
- Example:

```
dc insight resource list-pods --cluster prod-1
dc insight resource list-pods --cluster prod-1 --namespace default --phase POD_PHASE_RUNNING
dc insight resource list-pods --cluster prod-1 --name my-app --page 1 --page-size 50 -o json
```

### `dc insight resource list-services`

- Summary: List Services in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/services`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter services by cluster
  - `--namespace` (query): filter services by namespaces
  - `--name` (query): filter services by name
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `namespace`, `tracingEnabled`; pagination `offset`
- Example:

```
dc insight resource list-services --cluster kpanda-global-cluster
dc insight resource list-services --cluster kpanda-global-cluster \
  --namespace kube-system --name coredns -o json

# 输出：.items[] 主要字段 name / namespace / tracingEnabled
```

### `dc insight resource list-statefulsets`

- Summary: List StatefulSets in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/clusters/{cluster}/statefulsets`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (path, required): filter workloads by cluster
  - `--namespace` (query): filter workloads by namespace
  - `--name` (query): filter workloads by name
  - `--phase` (query, default `WORKLOAD_STATE_UNKNOWN`, one of: WORKLOAD_STATE_UNKNOWN|WORKLOAD_STATE_RUNNING|WORKLOAD_STATE_DELETING|WORKLOAD_STATE_NOT_READY|WORKLOAD_STATE_STOPPED|WORKLOAD_STATE_WAITING): WORKLOAD_STATE_UNKNOWN | WORKLOAD_STATE_RUNNING | WORKLOAD_STATE_DELETING | WORKLOAD_STATE_NOT_READY | WORKLOAD_STATE_STOPPED | WORKLOAD_STATE_WAITING
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
- Output: list path `items`; columns `name`, `namespace`, `phase`; pagination `offset`
- Example:

```
dc insight resource list-statefulsets --cluster prod-1
dc insight resource list-statefulsets --cluster prod-1 --namespace default \
  --phase WORKLOAD_STATE_RUNNING -o json
```

## ServiceGraph

### `dc insight servicegraph get-graph`

- Summary: Get service / workload / namespace topology graph
- HTTP: `POST /apis/insight.io/v1alpha1/service-graph/graph`
- Auth: required
- Body: required
- Flags: none
- Output: list path `edges`; columns `id`, `source`, `target`
- Example:

```
END=$(date +%s)000; START=$(($(date +%s) - 3600))000
echo '{
  "clusterNames": ["kpanda-global-cluster"],
  "start": "'"$START"'",
  "end":   "'"$END"'"
}' | dc insight servicegraph get-graph --file - -o json
# 上例：基础查询（必填 clusterNames + start + end），start/end 为 unix 毫秒字符串
# 按命名空间过滤：
echo '{
  "clusterNames": ["kpanda-global-cluster"],
  "namespaces":   ["insight-system"],
  "start": "'"$START"'",
  "end":   "'"$END"'"
}' | dc insight servicegraph get-graph --file - -o json

# 带 graphType / layer / 依赖深度过滤
# 注意：graphType / layer 是大写枚举字符串（非 "service" / "L7"），传错值会返回 HTTP 400
echo '{
  "clusterNames": ["kpanda-global-cluster"],
  "namespaces":   ["insight-system"],
  "services":     ["insight-server"],
  "workloads":    ["insight-server"],
  "start": "'"$START"'",
  "end":   "'"$END"'",
  "graphType": "SERVICE_SCOPE",
  "layer":     "KUBERNETES",
  "showUpDownRelatedNode": true,
  "filters": {
    "aggType": "INTERSECTION",
    "dependencyMaxDepth": 3,
    "clauses": [
      {"dataType":"NODE_DATA","field":"SERVICE_NAME","operation":"CONTAIN","stringValue":"insight"}
    ]
  }
}' | dc insight servicegraph get-graph --file - -o json

# 请求体字段（BaseGraphQuery）：
#   clusterNames        集群名数组，必填
#   clusters            集群 UUID 数组（与 clusterNames 二选一/并存）
#   start / end         unix 毫秒字符串（必填）
#   namespaces / services / workloads  作用域过滤（可选）
#   extensionLabels     形如 "skoala_registry=ireg-1,instance_name=xxx"
#   layer 枚举          KUBERNETES | MESH | OS_LINUX(=VM) | INFRA | GENERAL
#   graphType 枚举      CLUSTER_SCOPE | NAMESPACE_SCOPE | SERVICE_SCOPE |
#                       WORKLOAD_SCOPE | INSTANCE_SCOPE | MIXED
#   showVirtualNode     默认 false
#   showUpDownRelatedNode 默认 false；true 时展示上下游
#   filters.aggType     INTERSECTION（UNION 暂未支持）
#   filters.dependencyMaxDepth  依赖深度，默认 1
#   filters.clauses[]   { dataType=NODE_DATA, field, operation, stringValue|floatValue }
#     field=SERVICE_NAME      支持 CONTAIN/NOT_CONTAIN/EQUAL/NOT_EQUAL/REGEX_PATTERN
#     field=STATUS_ERROR_RATE 支持 LE/GE，使用 floatValue
#     field=STATUS_LATENCY    支持 LE/GE，使用 floatValue（单位秒）
#
# 返回结构（Graph）：
#   nodes[]   { id, parent, type(NodeType), metadata, position, statuses[] }
#   edges[]   { id, source, target, statuses[], properties }
#   layer / graphType
#   Status.name 约定：requestsPerMinute / errorRate(%) / avgLatency(秒) /
#                     replicas / availableReplicas / healthyStatus(0~3) ...
#
# ──────────────────────────────────────────────────────────────────
# 数据分析指南
# ──────────────────────────────────────────────────────────────────
# Edge.statuses 上的常见指标名：
#   request_total          总请求数
#   request_failed_total   失败请求数
#   request_per_second     QPS
#   request_avg_latency    平均延迟（秒）
#
# 第一步：Node 数据分析
#   1.1 服务类型分布：按 nodes[].type 分组计数
#       jq '.nodes | group_by(.type)
#          | map({type: .[0].type, count: length})'
#
#   1.2 服务依赖数 TOP5（作为 edge.source 出现的次数）
#       jq '.edges | group_by(.source)
#          | map({source: .[0].source, count: length})
#          | sort_by(.count) | reverse | .[:5]'
#
#   1.3 服务被依赖数 TOP5（作为 edge.target 出现的次数）
#       jq '.edges | group_by(.target)
#          | map({target: .[0].target, count: length})
#          | sort_by(.count) | reverse | .[:5]'
#
# 第二步：Edge 指标 TOP5
#   2.1 错误数 TOP5：按 statuses[name=request_failed_total].value 降序
#       jq '.edges
#          | map(select(.statuses[]?
#              | .name == "request_failed_total" and .value > 0))
#          | sort_by(.statuses[] | select(.name == "request_failed_total") | .value)
#          | reverse | .[:5]
#          | map({source, target,
#                 failed: (.statuses[] | select(.name == "request_failed_total") | .value)})'
#
#   2.2 请求数 TOP5：按 statuses[name=request_total].value 降序
#       jq '.edges
#          | sort_by(.statuses[] | select(.name == "request_total") | .value)
#          | reverse | .[:5]
#          | map({source, target,
#                 total: (.statuses[] | select(.name == "request_total") | .value)})'
#
#   2.3 平均延迟 TOP5：按 statuses[name=request_avg_latency].value 降序
#       jq '.edges
#          | sort_by(.statuses[] | select(.name == "request_avg_latency") | .value)
#          | reverse | .[:5]
#          | map({source, target,
#                 latency: (.statuses[] | select(.name == "request_avg_latency") | .value)})'
#       值单位为秒，展示时可换算为 ms 并标注单位。
#
# 第三步：汇总异常服务
#   综合上述结果，按严重度排序输出 service / issue 列表：
#     请求错误 > 请求延迟高 > 请求太多 > 其他
#
# 注意：node.id / edge.source / edge.target 中可能含集群 UUID。
# 展示给用户时应替换为集群名：
#   dc insight resource list-clusters -o json
#     | jq -r '.items[] | .kubeSystemId + " " + .name'
# 用上面映射把 UUID 替换回名字再输出表格。
```

### `dc insight servicegraph get-node-metrics`

- Summary: Get aggregated metrics for a node (service/workload) on the topology graph
- HTTP: `GET /apis/insight.io/v1alpha1/service-graph/node-metrics`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): 集群 UUID（与 --cluster-name 二选一，至少传一个）
  - `--namespace` (query): namespace
  - `--service` (query): service
  - `--extension-filters` (query): extension_filters eg. skoala_registry=ire-111,instance=xxx
  - `--end-time` (query, int64): end_time 结束时间 unix timestamp，单位 ms
  - `--lookback` (query, int64): 回退时长 ms（必填）
  - `--step` (query, int64): 采样步长 ms（必填）
  - `--rate-per` (query, int64): ratePer 变化率计算步长 unix timestamp，单位 ms
  - `--cluster-name` (query): Required. e.g. clusterName=kpanda-global-cluster must give one of
  - `--span-kinds` (query): spanKinds is the list of span kinds to include (logical OR) in the
- Output: list path `errorsRateMetrics`
- Example:

```
END=$(date +%s)000

# 单个服务节点 30 分钟指标（endTime/lookback/step/rate-per 单位都是 ms）
dc insight servicegraph get-node-metrics \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --service insight-server \
  --end-time $END --lookback 1800000 \
  --step 60000 --rate-per 60000 \
  --span-kinds SPAN_KIND_SERVER -o json

# 用 extension-filters 做 label 选择
dc insight servicegraph get-node-metrics \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --service insight-server \
  --extension-filters 'skoala_registry=ire-111,instance=10.0.0.1' \
  --end-time $END --lookback 1800000 --step 60000 --rate-per 60000 -o json
```

## Tracing

### `dc insight tracing find-jaeger-trace`

- Summary: Get a single Jaeger trace by trace ID
- HTTP: `GET /apis/insight.io/v1alpha1/jaeger/v2/traces/{traceId}`
- Auth: required
- Body: none
- Flags:
  - `--trace-id` (path, required): traceId
  - `--cluster` (query): cluster
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): only for auth
- Output: list path `traces`; columns `duration`, `method`, `operationName`, `protocol`, `spanCount`, `startTime`
- Example:

```
# 必填：--trace-id / --cluster-name / --namespace
dc insight tracing find-jaeger-trace --trace-id <traceId> \
  --cluster-name kpanda-global-cluster --namespace insight-system -o json

# 非法 trace id 时后端返回 "uninitialized TraceID is not allowed"
```

### `dc insight tracing find-jaeger-traces`

- Summary: Search Jaeger traces by service / operation / duration window
- HTTP: `GET /apis/insight.io/v1alpha1/jaeger/v2/traces`
- Auth: required
- Body: none
- Flags:
  - `--service-name` (query): serviceName
  - `--operation-name` (query): operationName
  - `--start` (query): e.g. 2022-06-24T08:00:47.850Z
  - `--end` (query): e.g. 2022-06-24T08:00:47.850Z
  - `--duration-min` (query): Span min duration. such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
  - `--duration-max` (query): Span min duration. such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
  - `--limit` (query, int32): limit
  - `--cluster` (query): cluster
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): only for auth
- Output: list path `traces`; columns `duration`, `method`, `operationName`, `protocol`, `spanCount`, `startTime`; pagination `cursor`
- Example:

```
dc insight tracing find-jaeger-traces \
  --cluster-name kpanda-global-cluster --namespace ghippo-system \
  --service-name ghippo-apiserver \
  --start 2026-05-21T07:00:00Z --end 2026-05-21T08:00:00Z \
  --limit 50 -o json
# 上例：最近 1 小时某服务的全部 trace；--start/--end 为 RFC3339，替换为实际窗口即可
# 慢 trace（>500ms）+ 指定 operation：
dc insight tracing find-jaeger-traces \
  --cluster-name kpanda-global-cluster --namespace ghippo-system \
  --service-name ghippo-apiserver --operation-name 'GET /api/v1/orders' \
  --duration-min 500ms --duration-max 5s \
  --start 2026-05-21T07:00:00Z --end 2026-05-21T08:00:00Z -o json
# 输出：.traces[] 含 duration / method / operationName / protocol / spanCount / startTime
```

### `dc insight tracing get-operation-detail`

- Summary: Get per-operation APM metrics for a service
- HTTP: `GET /apis/insight.io/v1alpha1/traces/operation-detail`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (query): Required.
  - `--namespace` (query): Required. namespace
  - `--service-name` (query): Required. At least one service name must be provided.
  - `--sort` (query): Optional.
  - `--page` (query, default `1`, int32): Optional. page is current page.
  - `--page-size` (query, default `20`, int32): Optional. size is the data number shown per page.
  - `--extension-filters` (query): Optional. support extension labels search
  - `--end-time` (query, int64): end_time is the ending time of the time series query range.
  - `--lookback` (query, int64): lookback is the duration from the end_time to look back on for metrics data points.
  - `--step` (query, int64): step size is the duration between data points of the query results.
  - `--rate-per` (query, int64): ratePer is the duration in which the per-second rate of change is calculated for a cumulative counter metric.
  - `--span-kinds` (query): spanKinds is the list of span kinds to include (logical OR) in the resulting metrics aggregation.
- Output: list path `metrics`; columns `operationName`, `spanKind`; pagination `offset`
- Example:

```
END=$(date +%s)000
# 必填：--cluster-name --namespace --service-name
dc insight tracing get-operation-detail \
  --cluster-name kpanda-global-cluster --namespace ghippo-system \
  --service-name ghippo-apiserver \
  --end-time $END --lookback 1800000 \
  --step 60000 --rate-per 60000 \
  --span-kinds SPAN_KIND_SERVER \
  --sort 'p99,desc' --page 1 --page-size 50 -o json

# 输出：.metrics[]  per-operation 的速率 / 错误率 / 延迟分位
```

### `dc insight tracing get-service-detail`

- Summary: Get per-service APM metrics (latency / errors / requests, optionally grouped by operation)
- HTTP: `GET /apis/insight.io/v1alpha1/traces/service-detail`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): cluster
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): Required.
  - `--instance-name` (query): Optional. not default
  - `--extension-filters` (query): Support extension search
  - `--service-names` (query): service_names are the service names to fetch metrics from.
  - `--group-by-operation` (query): groupByOperation determines if the metrics returned should be grouped by operation.
  - `--end-time` (query, int64): end_time is the ending time of the time series query range.
  - `--lookback` (query, int64): lookback is the duration from the end_time to look back on for metrics data points.
  - `--step` (query, int64): step size is the duration between data points of the query results.
  - `--rate-per` (query, int64): ratePer is the duration in which the per-second rate of change is calculated for a cumulative counter metric.
  - `--span-kinds` (query): spanKinds is the list of span kinds to include (logical OR) in the resulting metrics aggregation.
- Output: list path `errorsRateMetrics`
- Example:

```
END=$(date +%s)000
# 必填：--cluster-name --namespace --service-names
dc insight tracing get-service-detail \
  --cluster-name kpanda-global-cluster --namespace insight-system \
  --service-names insight-agent --group-by-operation=true \
  --end-time $END --lookback 1800000 \
  --step 60000 --rate-per 60000 \
  --span-kinds SPAN_KIND_SERVER -o json

# 输出（皆为 SampleStream 时序数组）：
#   .reqRateMetric        吞吐
#   .errorsRateMetrics    错误率
#   .p50Metrics / .p75Metrics / .p95Metrics  延迟分位
```

### `dc insight tracing get-service-pods`

- Summary: List the pods backing a tracing service with per-pod request share
- HTTP: `GET /apis/insight.io/v1alpha1/traces/services/{name}/pods`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): Required.
  - `--cluster-name` (query): Required.
  - `--namespace` (query): Required.
  - `--sort` (query): sorts determines the data list order.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--extension-filters` (query): Support extension search
  - `--end-time` (query, int64): end_time is the ending time of the time series query range.
  - `--lookback` (query, int64): lookback is the duration from the end_time to look back on for metrics data points.
  - `--step` (query, int64): step size is the duration between data points of the query results.
  - `--rate-per` (query, int64): ratePer is the duration in which the per-second rate of change is calculated for a cumulative counter metric.
  - `--span-kinds` (query): spanKinds is the list of span kinds to include (logical OR) in the resulting metrics aggregation.
- Output: list path `items`; columns `namespace`, `clusterName`, `podName`, `reqPercentage`; pagination `offset`
- Example:

```
END=$(date +%s)000
# 必填：--name --cluster-name --namespace
dc insight tracing get-service-pods --name ghippo-apiserver \
  --cluster-name kpanda-global-cluster --namespace ghippo-system \
  --end-time $END --lookback 1800000 \
  --sort 'reqPercentage,desc' --page 1 --page-size 50 -o json

# 输出：.items[] 含 podName / namespace / clusterName / reqPercentage
```

### `dc insight tracing get-services`

- Summary: List APM services with rate / latency / error metrics
- HTTP: `GET /apis/insight.io/v1alpha1/traces/services`
- Auth: required
- Body: none
- Flags:
  - `--namespace` (query): Optional.
  - `--extension-filters` (query): Support extension search
  - `--end-time` (query, int64): end_time is the ending time of the time series query range.
  - `--lookback` (query, int64): 回退时长 ms
  - `--span-kinds` (query): spanKinds is the list of span kinds to include (logical OR) in the resulting metrics aggregation.
  - `--page` (query, default `1`, int32): Page is current page.
  - `--page-size` (query, default `20`, int32): Size is the data number shown per page.
  - `--sort` (query): sorts determines the data list order.
  - `--cluster` (query): cluster
  - `--cluster-name` (query): clusterName
- Output: list path `items`; columns `namespace`, `errorRate`, `repLatency`, `reqRate`, `serviceName`; pagination `offset`
- Example:

```
END=$(date +%s)000
# 默认全 namespace；可加 --namespace 过滤
dc insight tracing get-services \
  --cluster-name kpanda-global-cluster \
  --end-time $END --lookback 1800000 \
  --span-kinds SPAN_KIND_SERVER --sort 'reqRate,desc' \
  --page 1 --page-size 50 -o json

# 输出：.items[] 含 namespace / serviceName / errorRate / repLatency / reqRate
```

### `dc insight tracing get-slow-sql-spans`

- Summary: List individual slow-SQL spans (drill-down from statement-top-k)
- HTTP: `POST /apis/insight.io/v1alpha1/traces/slow-sql/clusters/{clusterName}/spans`
- Auth: required
- Body: required
- Flags:
  - `--cluster-name` (path, required): Required.
- Output: list path `items`; columns `duration`, `sourcePod`, `spanId`, `startTime`, `status`, `traceId`
- Example:

```
# sort 支持：startTimeMillis,desc | startTimeMillis,asc | duration,desc | duration,asc
echo '{
  "namespace": "ghippo-system",
  "startTime": "2026-05-21T07:00:00.000Z",
  "endTime":   "2026-05-21T08:00:00.000Z",
  "sort":      "duration,desc",
  "page":      1,
  "pageSize":  50,
  "clauses": [
    {"field":"db.statement","operation":"CONTAIN","stringValue":"SELECT"},
    {"field":"duration","operation":"GT","floatValue":1000}
  ]
}' | dc insight tracing get-slow-sql-spans \
      --cluster-name kpanda-global-cluster --file - -o json

# 输出：.items[] 含 duration / sourcePod / spanId / startTime / status / traceId
```

### `dc insight tracing get-tag-values`

- Summary: List values seen for a given tag key
- HTTP: `GET /apis/insight.io/v1alpha1/traces/tags/{name}/values`
- Auth: required
- Body: none
- Flags:
  - `--name` (path, required): Required. not default
  - `--cluster` (query): Required. not default
  - `--namespace` (query): Required. not default
  - `--service-names` (query): Optional. not default
  - `--limit` (query, int32): Optional. Default = 1000.
  - `--search` (query): Optional not default
  - `--start` (query): e.g. 2022-06-24T08:00:47.850Z
  - `--end` (query): e.g. 2022-06-24T08:00:47.850Z
- Output: list path `values`; pagination `cursor`
- Example:

```
# 必填：--name (tag key) --cluster --namespace
dc insight tracing get-tag-values --name http.status_code \
  --cluster kpanda-global-cluster --namespace ghippo-system \
  --service-names ghippo-apiserver --limit 100 -o json

# 输出：.values[]
```

### `dc insight tracing get-tags`

- Summary: List span tag keys discovered for a service / namespace
- HTTP: `GET /apis/insight.io/v1alpha1/traces/tags`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): Required. not default
  - `--namespace` (query): Required. not default
  - `--service-names` (query): Optional. not default
  - `--limit` (query, int32): Optional. Default = 1000.
  - `--search` (query): Optional. not default
  - `--start` (query): e.g. 2022-06-24T08:00:47.850Z
  - `--end` (query): e.g. 2022-06-24T08:00:47.850Z
- Output: list path `tags`; pagination `cursor`
- Example:

```
# 必填：--cluster --namespace；--start / --end 默认 [now-15m, now]
dc insight tracing get-tags \
  --cluster kpanda-global-cluster --namespace ghippo-system \
  --service-names ghippo-apiserver --limit 500 \
  --start 2026-05-21T07:00:00Z --end 2026-05-21T08:00:00Z -o json

# 输出：.tags[]
```

### `dc insight tracing list-service-names`

- Summary: List service names known to the tracing backend
- HTTP: `GET /apis/insight.io/v1alpha1/traces/service-names`
- Auth: required
- Body: none
- Flags:
  - `--cluster` (query): cluster
  - `--cluster-name` (query): clusterName
  - `--namespace` (query): namespace
  - `--max-size` (query, int32): Optional. Default = 1000.
  - `--start` (query): e.g. 2022-06-24T08:00:47.850Z
  - `--end` (query): e.g. 2022-06-24T08:00:47.850Z
- Output: list path `services`
- Example:

```
# ⚠️ --namespace 必填，缺失返回 HTTP 400
dc insight tracing list-service-names \
  --cluster-name kpanda-global-cluster --namespace insight-system -o json

# 输出：.services[]
```

### `dc insight tracing query-metadata`

- Summary: List slow-SQL metadata (DB address / system / statement) for a cluster
- HTTP: `POST /apis/insight.io/v1alpha1/traces/slow-sql/clusters/{clusterName}/type/{type}/metadata`
- Auth: required
- Body: required
- Flags:
  - `--cluster-name` (path, required): Required.
  - `--type` (path, required, one of: DATABASE_ADDRESS|DATABASE_SYSTEM|SQL_STATEMENT): type
- Output: list path `items`
- Example:

```
# --type 必填，枚举：DATABASE_ADDRESS | DATABASE_SYSTEM | SQL_STATEMENT
echo '{
  "namespace": "ghippo-system",
  "startTime": "2026-05-21T07:00:00.000Z",
  "endTime":   "2026-05-21T08:00:00.000Z",
  "limit": 100,
  "clauses": [
    {"field":"db.system","operation":"EQUAL","stringValue":"mysql"}
  ]
}' | dc insight tracing query-metadata \
      --cluster-name kpanda-global-cluster --type SQL_STATEMENT --file - -o json

# 输出：.items[]
```

### `dc insight tracing query-operations`

- Summary: List operations (endpoints) for a service in a cluster
- HTTP: `GET /apis/insight.io/v1alpha1/traces/clusters/{clusterName}/operations`
- Auth: required
- Body: none
- Flags:
  - `--cluster-name` (path, required): Required.
  - `--namespace` (query): Required.
  - `--service-name` (query): Required.
  - `--max-size` (query, int32): Optional. Default = 1000.
  - `--start` (query): e.g. 2022-06-24T08:00:47.850Z
  - `--end` (query): e.g. 2022-06-24T08:00:47.850Z
- Output: list path `operations`
- Example:

```
# 必填：--cluster-name --namespace --service-name
dc insight tracing query-operations \
  --cluster-name kpanda-global-cluster --namespace ghippo-system \
  --service-name ghippo-apiserver --max-size 200 -o json

# 输出：.operations[]
```

### `dc insight tracing query-span-histogram`

- Summary: Bucket span counts over time (normal / error / total)
- HTTP: `POST /apis/insight.io/v1alpha1/jaeger/v2/spans/histogram`
- Auth: required
- Body: required
- Flags: none
- Output: list path `countItems`; columns `error`, `normal`, `timestamp`, `total`
- Example:

```
# ⚠️ start/end 必须 RFC3339；传 unix ms 会导致分桶数异常（实测 60001 桶）
echo '{
  "clusterName": "kpanda-global-cluster",
  "namespace":   "ghippo-system",
  "serviceName": ["ghippo-apiserver"],
  "start": "2026-05-21T07:00:00.000Z",
  "end":   "2026-05-21T08:00:00.000Z",
  "interval": "1m",
  "onlyErrorSpans": false
}' | dc insight tracing query-span-histogram --file - -o json

# 输出：
#   .countItems[]     { timestamp(ms), normal, error, total }
#   .durationItems[]  { timestamp(ms), p75Duration, p95Duration, p99Duration, avgDuration (ns) }
```

### `dc insight tracing query-spans`

- Summary: Query spans with rich filters (tags, error-only, sort, pagination)
- HTTP: `POST /apis/insight.io/v1alpha1/jaeger/v2/spans`
- Auth: required
- Body: required
- Flags: none
- Output: list path `items`; columns `duration`, `method`, `operationName`, `protocol`, `serviceName`, `spanId`
- Example:

```
# ⚠️ POST body 中 start / end 必须是 RFC3339(Nano) 字符串，不是 unix ms
# sort 支持：startTime,desc | startTime,asc | duration,desc | duration,asc（默认 startTime,desc）
echo '{
  "clusterName": "kpanda-global-cluster",
  "namespace":   "ghippo-system",
  "serviceName": ["ghippo-apiserver"],
  "operationName": ["GET /api/v1/orders"],
  "start": "2026-05-21T07:00:00.000Z",
  "end":   "2026-05-21T08:00:00.000Z",
  "durationMin":   "200ms",
  "onlyErrorSpans": true,
  "sort":     "duration,desc",
  "page":     1,
  "pageSize": 50,
  "tags": [
    {"key":"http.status_code","operation":"EQUAL","value":"500"}
  ]
}' | dc insight tracing query-spans --file - -o json

# 字段说明：
#   clusterName / cluster        二选一
#   namespace                    必填
#   serviceName / operationName  字符串数组
#   durationMin/durationMax      go duration: ns/us/ms/s/m/h
#   tags[].operation             FilterOperator
#                                CONTAIN/NOT_CONTAIN/EQUAL/NOT_EQUAL/REGEX_PATTERN/
#                                LT/LE/GT/GE/EQ/NE
#   onlyErrorSpans               仅返回错误 span
#   spanKinds                    可选，默认 [SPAN_KIND_SERVER, SPAN_KIND_CLIENT]
# 输出：.items[] 含 duration / method / operationName / protocol / serviceName / spanId
```

### `dc insight tracing statement-histogram`

- Summary: Histogram of SQL statement durations (cluster scoped, slow-SQL)
- HTTP: `POST /apis/insight.io/v1alpha1/traces/slow-sql/clusters/{clusterName}/statement/histogram`
- Auth: required
- Body: required
- Flags:
  - `--cluster-name` (path, required): Required.
- Output: list path `duration`; columns `timestamp`, `value`
- Example:

```
# sort 支持（proto canonical，逗号分隔，默认 request_count,desc）：
#   request_count,desc | request_count,asc
#   avg_duration,desc  | avg_duration,asc
#   error_requests,desc| error_requests,asc
#   error_rate,desc    | error_rate,asc
#   @timestamp,desc    | @timestamp,asc
echo '{
  "namespace": "ghippo-system",
  "startTime": "2026-05-21T07:00:00.000Z",
  "endTime":   "2026-05-21T08:00:00.000Z",
  "interval":  "1m",
  "topN":      10,
  "sort":      "avg_duration,desc",
  "clauses": [
    {"field":"db.system","operation":"EQUAL","stringValue":"mysql"}
  ]
}' | dc insight tracing statement-histogram \
      --cluster-name kpanda-global-cluster --file - -o json

# 输出（按时间桶的 BucketHistogram 数组）：
#   .total       调用次数
#   .duration    平均耗时（ns）
#   .errors      错误次数
#   .errorRate   错误率
#   .sourcePods  调用容器组
```

### `dc insight tracing statement-top-k`

- Summary: Top-K slowest SQL statements aggregated by source service
- HTTP: `POST /apis/insight.io/v1alpha1/traces/slow-sql/clusters/{clusterName}/statement/topk`
- Auth: required
- Body: required
- Flags:
  - `--cluster-name` (path, required): Required.
- Output: list path `items`; columns `address`, `avgDuration`, `errorRate`, `sourceCluster`, `sourceNamespace`, `sourceService`
- Example:

```
echo '{
  "namespace": "ghippo-system",
  "startTime": "2026-05-21T07:00:00.000Z",
  "endTime":   "2026-05-21T08:00:00.000Z",
  "topN":      20,
  "sort":      "avg_duration,desc"
}' | dc insight tracing statement-top-k \
      --cluster-name kpanda-global-cluster --file - -o json

# 输出：.items[] 含 address / system / sourceCluster / sourceNamespace /
#       sourceService / statement / totalCount / avgDuration(ns) / errorRate
```

## User

### `dc insight user list-users`

- Summary: List Insight users (Insight-side user view, not ghippo)
- HTTP: `GET /apis/insight.io/v1alpha1/users`
- Auth: required
- Body: none
- Flags:
  - `--search` (query): 搜索关键字
  - `--page-size` (query, default `20`, int32): 每页条数
  - `--page` (query, default `1`, int32): 当前页
- Output: list path `items`; columns `name`, `id`, `enabled`; pagination `offset`
- Example:

```
dc insight user list-users
# Fuzzy search by name + paged JSON output
dc insight user list-users --search alice --page 1 --page-size 50 -o json
```