kb-cloud-client-typescript 2.4.0-alpha.102 → 2.4.0-alpha.105
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/adminapi/api.d.ts +1 -0
- package/dist/adminapi/api.d.ts.map +1 -1
- package/dist/adminapi/api.js +1 -0
- package/dist/adminapi/api.js.map +1 -1
- package/dist/adminapi/apis/aiagent-api.d.ts +6 -6
- package/dist/adminapi/apis/aiagent-api.js +4 -4
- package/dist/adminapi/apis/alert-rule-api.d.ts +223 -0
- package/dist/adminapi/apis/alert-rule-api.d.ts.map +1 -1
- package/dist/adminapi/apis/alert-rule-api.js +241 -0
- package/dist/adminapi/apis/alert-rule-api.js.map +1 -1
- package/dist/adminapi/apis/node-alert-api.d.ts +247 -0
- package/dist/adminapi/apis/node-alert-api.d.ts.map +1 -0
- package/dist/adminapi/apis/node-alert-api.js +292 -0
- package/dist/adminapi/apis/node-alert-api.js.map +1 -0
- package/dist/adminapi/apis/opsrequest-api.d.ts +5 -5
- package/dist/adminapi/apis/opsrequest-api.js +4 -4
- package/dist/adminapi/apis/organization-api.d.ts +211 -2
- package/dist/adminapi/apis/organization-api.d.ts.map +1 -1
- package/dist/adminapi/apis/organization-api.js +245 -5
- package/dist/adminapi/apis/organization-api.js.map +1 -1
- package/dist/adminapi/apis/shared-api.d.ts +438 -7
- package/dist/adminapi/apis/shared-api.d.ts.map +1 -1
- package/dist/adminapi/apis/shared-api.js +490 -9
- package/dist/adminapi/apis/shared-api.js.map +1 -1
- package/dist/adminapi/apis/task-api.d.ts +55 -0
- package/dist/adminapi/apis/task-api.d.ts.map +1 -1
- package/dist/adminapi/apis/task-api.js +69 -0
- package/dist/adminapi/apis/task-api.js.map +1 -1
- package/dist/adminapi/models/ai-agent-turn-action-list.d.ts +12 -0
- package/dist/adminapi/models/ai-agent-turn-action-list.d.ts.map +1 -1
- package/dist/adminapi/models/alert-cluster-silence.d.ts +1 -1
- package/dist/adminapi/models/alert-cluster.d.ts +3 -3
- package/dist/adminapi/models/alert-resource-type.d.ts +22 -0
- package/dist/adminapi/models/alert-resource-type.d.ts.map +1 -0
- package/dist/adminapi/models/alert-resource-type.js +26 -0
- package/dist/adminapi/models/alert-resource-type.js.map +1 -0
- package/dist/adminapi/models/component-item-create.d.ts +8 -0
- package/dist/adminapi/models/component-item-create.d.ts.map +1 -1
- package/dist/adminapi/models/component-item.d.ts +8 -0
- package/dist/adminapi/models/component-item.d.ts.map +1 -1
- package/dist/adminapi/models/component-option.d.ts +6 -0
- package/dist/adminapi/models/component-option.d.ts.map +1 -1
- package/dist/adminapi/models/engine-option-license.d.ts +13 -0
- package/dist/adminapi/models/engine-option-license.d.ts.map +1 -1
- package/dist/adminapi/models/index.d.ts +10 -0
- package/dist/adminapi/models/index.d.ts.map +1 -1
- package/dist/adminapi/models/index.js +10 -0
- package/dist/adminapi/models/index.js.map +1 -1
- package/dist/adminapi/models/inspection-task.d.ts +2 -2
- package/dist/adminapi/models/ops-expose-type.d.ts +2 -1
- package/dist/adminapi/models/ops-expose-type.d.ts.map +1 -1
- package/dist/adminapi/models/ops-expose-type.js +3 -2
- package/dist/adminapi/models/ops-expose-type.js.map +1 -1
- package/dist/adminapi/models/ops-expose.d.ts +1 -1
- package/dist/adminapi/models/org-configuration-item.d.ts +31 -0
- package/dist/adminapi/models/org-configuration-item.d.ts.map +1 -0
- package/dist/adminapi/models/org-configuration-item.js +16 -0
- package/dist/adminapi/models/org-configuration-item.js.map +1 -0
- package/dist/adminapi/models/org-configuration-summary.d.ts +56 -0
- package/dist/adminapi/models/org-configuration-summary.d.ts.map +1 -0
- package/dist/adminapi/models/org-configuration-summary.js +16 -0
- package/dist/adminapi/models/org-configuration-summary.js.map +1 -0
- package/dist/adminapi/models/org-deletion-action.d.ts +22 -0
- package/dist/adminapi/models/org-deletion-action.d.ts.map +1 -0
- package/dist/adminapi/models/org-deletion-action.js +26 -0
- package/dist/adminapi/models/org-deletion-action.js.map +1 -0
- package/dist/adminapi/models/org-deletion-blocker.d.ts +37 -0
- package/dist/adminapi/models/org-deletion-blocker.d.ts.map +1 -0
- package/dist/adminapi/models/org-deletion-blocker.js +16 -0
- package/dist/adminapi/models/org-deletion-blocker.js.map +1 -0
- package/dist/adminapi/models/org-deletion-preview.d.ts +82 -0
- package/dist/adminapi/models/org-deletion-preview.d.ts.map +1 -0
- package/dist/adminapi/models/org-deletion-preview.js +16 -0
- package/dist/adminapi/models/org-deletion-preview.js.map +1 -0
- package/dist/adminapi/models/org-lifecycle-request.d.ts +31 -0
- package/dist/adminapi/models/org-lifecycle-request.d.ts.map +1 -0
- package/dist/adminapi/models/org-lifecycle-request.js +16 -0
- package/dist/adminapi/models/org-lifecycle-request.js.map +1 -0
- package/dist/adminapi/models/org-purge-result.d.ts +37 -0
- package/dist/adminapi/models/org-purge-result.d.ts.map +1 -0
- package/dist/adminapi/models/org-purge-result.js +16 -0
- package/dist/adminapi/models/org-purge-result.js.map +1 -0
- package/dist/adminapi/models/org-retained-resource.d.ts +37 -0
- package/dist/adminapi/models/org-retained-resource.d.ts.map +1 -0
- package/dist/adminapi/models/org-retained-resource.js +16 -0
- package/dist/adminapi/models/org-retained-resource.js.map +1 -0
- package/dist/adminapi/models/org-status.d.ts +25 -0
- package/dist/adminapi/models/org-status.d.ts.map +1 -0
- package/dist/adminapi/models/org-status.js +29 -0
- package/dist/adminapi/models/org-status.js.map +1 -0
- package/dist/adminapi/models/org.d.ts +25 -0
- package/dist/adminapi/models/org.d.ts.map +1 -1
- package/dist/adminapi/models/organization-item.d.ts +31 -0
- package/dist/adminapi/models/organization-item.d.ts.map +1 -1
- package/dist/adminapi/models/restore-create.d.ts +1 -1
- package/dist/adminapi/models/task-status.d.ts +1 -0
- package/dist/adminapi/models/task-status.d.ts.map +1 -1
- package/dist/adminapi/models/task-status.js +2 -1
- package/dist/adminapi/models/task-status.js.map +1 -1
- package/dist/internalapi/apis/environment-api.d.ts +63 -0
- package/dist/internalapi/apis/environment-api.d.ts.map +1 -1
- package/dist/internalapi/apis/environment-api.js +72 -0
- package/dist/internalapi/apis/environment-api.js.map +1 -1
- package/dist/internalapi/apis/recycle-bin-cluster-api.d.ts +15 -7
- package/dist/internalapi/apis/recycle-bin-cluster-api.d.ts.map +1 -1
- package/dist/internalapi/apis/recycle-bin-cluster-api.js +18 -11
- package/dist/internalapi/apis/recycle-bin-cluster-api.js.map +1 -1
- package/dist/internalapi/models/component-item.d.ts +8 -0
- package/dist/internalapi/models/component-item.d.ts.map +1 -1
- package/dist/openapi/apis/aiagent-api.d.ts +6 -6
- package/dist/openapi/apis/aiagent-api.js +4 -4
- package/dist/openapi/apis/alert-rule-api.d.ts +223 -0
- package/dist/openapi/apis/alert-rule-api.d.ts.map +1 -1
- package/dist/openapi/apis/alert-rule-api.js +241 -0
- package/dist/openapi/apis/alert-rule-api.js.map +1 -1
- package/dist/openapi/apis/opsrequest-api.d.ts +5 -5
- package/dist/openapi/apis/opsrequest-api.js +4 -4
- package/dist/openapi/apis/organization-api.d.ts +211 -2
- package/dist/openapi/apis/organization-api.d.ts.map +1 -1
- package/dist/openapi/apis/organization-api.js +245 -5
- package/dist/openapi/apis/organization-api.js.map +1 -1
- package/dist/openapi/apis/shared-api.d.ts +438 -7
- package/dist/openapi/apis/shared-api.d.ts.map +1 -1
- package/dist/openapi/apis/shared-api.js +490 -9
- package/dist/openapi/apis/shared-api.js.map +1 -1
- package/dist/openapi/apis/task-api.d.ts +63 -0
- package/dist/openapi/apis/task-api.d.ts.map +1 -1
- package/dist/openapi/apis/task-api.js +74 -0
- package/dist/openapi/apis/task-api.js.map +1 -1
- package/dist/openapi/models/ai-agent-turn-action-list.d.ts +12 -0
- package/dist/openapi/models/ai-agent-turn-action-list.d.ts.map +1 -1
- package/dist/openapi/models/alert-cluster-silence.d.ts +1 -1
- package/dist/openapi/models/alert-cluster.d.ts +3 -3
- package/dist/openapi/models/alert-resource-type.d.ts +22 -0
- package/dist/openapi/models/alert-resource-type.d.ts.map +1 -0
- package/dist/openapi/models/alert-resource-type.js +26 -0
- package/dist/openapi/models/alert-resource-type.js.map +1 -0
- package/dist/openapi/models/component-item-create.d.ts +8 -0
- package/dist/openapi/models/component-item-create.d.ts.map +1 -1
- package/dist/openapi/models/component-item.d.ts +8 -0
- package/dist/openapi/models/component-item.d.ts.map +1 -1
- package/dist/openapi/models/component-option.d.ts +6 -0
- package/dist/openapi/models/component-option.d.ts.map +1 -1
- package/dist/openapi/models/engine-option-license.d.ts +13 -0
- package/dist/openapi/models/engine-option-license.d.ts.map +1 -1
- package/dist/openapi/models/index.d.ts +10 -0
- package/dist/openapi/models/index.d.ts.map +1 -1
- package/dist/openapi/models/index.js +10 -0
- package/dist/openapi/models/index.js.map +1 -1
- package/dist/openapi/models/inspection-task.d.ts +2 -2
- package/dist/openapi/models/ops-expose-type.d.ts +2 -1
- package/dist/openapi/models/ops-expose-type.d.ts.map +1 -1
- package/dist/openapi/models/ops-expose-type.js +3 -2
- package/dist/openapi/models/ops-expose-type.js.map +1 -1
- package/dist/openapi/models/ops-expose.d.ts +1 -1
- package/dist/openapi/models/org-configuration-item.d.ts +31 -0
- package/dist/openapi/models/org-configuration-item.d.ts.map +1 -0
- package/dist/openapi/models/org-configuration-item.js +16 -0
- package/dist/openapi/models/org-configuration-item.js.map +1 -0
- package/dist/openapi/models/org-configuration-summary.d.ts +56 -0
- package/dist/openapi/models/org-configuration-summary.d.ts.map +1 -0
- package/dist/openapi/models/org-configuration-summary.js +16 -0
- package/dist/openapi/models/org-configuration-summary.js.map +1 -0
- package/dist/openapi/models/org-deletion-action.d.ts +22 -0
- package/dist/openapi/models/org-deletion-action.d.ts.map +1 -0
- package/dist/openapi/models/org-deletion-action.js +26 -0
- package/dist/openapi/models/org-deletion-action.js.map +1 -0
- package/dist/openapi/models/org-deletion-blocker.d.ts +37 -0
- package/dist/openapi/models/org-deletion-blocker.d.ts.map +1 -0
- package/dist/openapi/models/org-deletion-blocker.js +16 -0
- package/dist/openapi/models/org-deletion-blocker.js.map +1 -0
- package/dist/openapi/models/org-deletion-preview.d.ts +82 -0
- package/dist/openapi/models/org-deletion-preview.d.ts.map +1 -0
- package/dist/openapi/models/org-deletion-preview.js +16 -0
- package/dist/openapi/models/org-deletion-preview.js.map +1 -0
- package/dist/openapi/models/org-lifecycle-request.d.ts +31 -0
- package/dist/openapi/models/org-lifecycle-request.d.ts.map +1 -0
- package/dist/openapi/models/org-lifecycle-request.js +16 -0
- package/dist/openapi/models/org-lifecycle-request.js.map +1 -0
- package/dist/openapi/models/org-purge-result.d.ts +37 -0
- package/dist/openapi/models/org-purge-result.d.ts.map +1 -0
- package/dist/openapi/models/org-purge-result.js +16 -0
- package/dist/openapi/models/org-purge-result.js.map +1 -0
- package/dist/openapi/models/org-retained-resource.d.ts +37 -0
- package/dist/openapi/models/org-retained-resource.d.ts.map +1 -0
- package/dist/openapi/models/org-retained-resource.js +16 -0
- package/dist/openapi/models/org-retained-resource.js.map +1 -0
- package/dist/openapi/models/org-status.d.ts +25 -0
- package/dist/openapi/models/org-status.d.ts.map +1 -0
- package/dist/openapi/models/org-status.js +29 -0
- package/dist/openapi/models/org-status.js.map +1 -0
- package/dist/openapi/models/org.d.ts +25 -0
- package/dist/openapi/models/org.d.ts.map +1 -1
- package/dist/openapi/models/restore-create.d.ts +1 -1
- package/dist/openapi/models/task-status.d.ts +1 -0
- package/dist/openapi/models/task-status.d.ts.map +1 -1
- package/dist/openapi/models/task-status.js +2 -1
- package/dist/openapi/models/task-status.js.map +1 -1
- package/dist/openapi/models/user-org.d.ts +25 -0
- package/dist/openapi/models/user-org.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/adminapi/.openapi-generator/FILES +11 -0
- package/src/adminapi/api.ts +1 -0
- package/src/adminapi/apis/aiagent-api.ts +6 -6
- package/src/adminapi/apis/alert-rule-api.ts +388 -0
- package/src/adminapi/apis/node-alert-api.ts +424 -0
- package/src/adminapi/apis/opsrequest-api.ts +5 -5
- package/src/adminapi/apis/organization-api.ts +386 -5
- package/src/adminapi/apis/shared-api.ts +908 -141
- package/src/adminapi/apis/task-api.ts +100 -0
- package/src/adminapi/models/ai-agent-turn-action-list.ts +12 -0
- package/src/adminapi/models/alert-cluster-silence.ts +1 -1
- package/src/adminapi/models/alert-cluster.ts +3 -3
- package/src/adminapi/models/alert-resource-type.ts +31 -0
- package/src/adminapi/models/component-item-create.ts +6 -0
- package/src/adminapi/models/component-item.ts +6 -0
- package/src/adminapi/models/component-option.ts +6 -0
- package/src/adminapi/models/engine-option-license.ts +15 -0
- package/src/adminapi/models/index.ts +10 -0
- package/src/adminapi/models/inspection-task.ts +2 -2
- package/src/adminapi/models/ops-expose-type.ts +3 -2
- package/src/adminapi/models/ops-expose.ts +1 -1
- package/src/adminapi/models/org-configuration-item.ts +36 -0
- package/src/adminapi/models/org-configuration-summary.ts +63 -0
- package/src/adminapi/models/org-deletion-action.ts +31 -0
- package/src/adminapi/models/org-deletion-blocker.ts +42 -0
- package/src/adminapi/models/org-deletion-preview.ts +93 -0
- package/src/adminapi/models/org-lifecycle-request.ts +36 -0
- package/src/adminapi/models/org-purge-result.ts +42 -0
- package/src/adminapi/models/org-retained-resource.ts +42 -0
- package/src/adminapi/models/org-status.ts +34 -0
- package/src/adminapi/models/org.ts +29 -0
- package/src/adminapi/models/organization-item.ts +35 -0
- package/src/adminapi/models/restore-create.ts +1 -1
- package/src/adminapi/models/task-status.ts +2 -1
- package/src/adminapi.yaml +732 -139
- package/src/internalapi/apis/environment-api.ts +110 -0
- package/src/internalapi/apis/recycle-bin-cluster-api.ts +29 -14
- package/src/internalapi/models/component-item.ts +6 -0
- package/src/internalapi.yaml +38 -3
- package/src/openapi/.openapi-generator/FILES +10 -0
- package/src/openapi/apis/aiagent-api.ts +6 -6
- package/src/openapi/apis/alert-rule-api.ts +388 -0
- package/src/openapi/apis/opsrequest-api.ts +5 -5
- package/src/openapi/apis/organization-api.ts +386 -5
- package/src/openapi/apis/shared-api.ts +908 -141
- package/src/openapi/apis/task-api.ts +112 -0
- package/src/openapi/models/ai-agent-turn-action-list.ts +12 -0
- package/src/openapi/models/alert-cluster-silence.ts +1 -1
- package/src/openapi/models/alert-cluster.ts +3 -3
- package/src/openapi/models/alert-resource-type.ts +31 -0
- package/src/openapi/models/component-item-create.ts +6 -0
- package/src/openapi/models/component-item.ts +6 -0
- package/src/openapi/models/component-option.ts +6 -0
- package/src/openapi/models/engine-option-license.ts +15 -0
- package/src/openapi/models/index.ts +10 -0
- package/src/openapi/models/inspection-task.ts +2 -2
- package/src/openapi/models/ops-expose-type.ts +3 -2
- package/src/openapi/models/ops-expose.ts +1 -1
- package/src/openapi/models/org-configuration-item.ts +36 -0
- package/src/openapi/models/org-configuration-summary.ts +63 -0
- package/src/openapi/models/org-deletion-action.ts +31 -0
- package/src/openapi/models/org-deletion-blocker.ts +42 -0
- package/src/openapi/models/org-deletion-preview.ts +93 -0
- package/src/openapi/models/org-lifecycle-request.ts +36 -0
- package/src/openapi/models/org-purge-result.ts +42 -0
- package/src/openapi/models/org-retained-resource.ts +42 -0
- package/src/openapi/models/org-status.ts +34 -0
- package/src/openapi/models/org.ts +29 -0
- package/src/openapi/models/restore-create.ts +1 -1
- package/src/openapi/models/task-status.ts +2 -1
- package/src/openapi/models/user-org.ts +29 -0
- package/src/openapi.yaml +503 -9
package/src/adminapi.yaml
CHANGED
|
@@ -1663,6 +1663,107 @@ paths:
|
|
|
1663
1663
|
tags:
|
|
1664
1664
|
- organization
|
|
1665
1665
|
x-codegen-request-body-name: body
|
|
1666
|
+
/admin/v1/organizations/{orgName}/deletionPreview:
|
|
1667
|
+
get:
|
|
1668
|
+
summary: Preview organization deletion or purge
|
|
1669
|
+
operationId: previewOrgDeletion
|
|
1670
|
+
tags:
|
|
1671
|
+
- organization
|
|
1672
|
+
- shared
|
|
1673
|
+
parameters:
|
|
1674
|
+
- name: orgName
|
|
1675
|
+
in: path
|
|
1676
|
+
required: true
|
|
1677
|
+
schema:
|
|
1678
|
+
type: string
|
|
1679
|
+
- name: orgID
|
|
1680
|
+
in: query
|
|
1681
|
+
required: true
|
|
1682
|
+
schema:
|
|
1683
|
+
type: string
|
|
1684
|
+
pattern: ^[1-9][0-9]*$
|
|
1685
|
+
- name: action
|
|
1686
|
+
in: query
|
|
1687
|
+
required: true
|
|
1688
|
+
schema:
|
|
1689
|
+
$ref: '#/components/schemas/orgDeletionAction'
|
|
1690
|
+
responses:
|
|
1691
|
+
'200':
|
|
1692
|
+
description: Read-only preview; actual mutations revalidate all conditions
|
|
1693
|
+
content:
|
|
1694
|
+
application/json:
|
|
1695
|
+
schema:
|
|
1696
|
+
$ref: '#/components/schemas/orgDeletionPreview'
|
|
1697
|
+
'400':
|
|
1698
|
+
$ref: '#/components/responses/400'
|
|
1699
|
+
'403':
|
|
1700
|
+
$ref: '#/components/responses/403'
|
|
1701
|
+
'409':
|
|
1702
|
+
$ref: '#/components/responses/409'
|
|
1703
|
+
/admin/v1/organizations/{orgName}/restoreOrganization:
|
|
1704
|
+
post:
|
|
1705
|
+
summary: Restore organization
|
|
1706
|
+
operationId: restoreOrg
|
|
1707
|
+
tags:
|
|
1708
|
+
- organization
|
|
1709
|
+
- shared
|
|
1710
|
+
parameters:
|
|
1711
|
+
- in: path
|
|
1712
|
+
name: orgName
|
|
1713
|
+
required: true
|
|
1714
|
+
schema:
|
|
1715
|
+
type: string
|
|
1716
|
+
requestBody:
|
|
1717
|
+
required: true
|
|
1718
|
+
content:
|
|
1719
|
+
application/json:
|
|
1720
|
+
schema:
|
|
1721
|
+
$ref: '#/components/schemas/orgLifecycleRequest'
|
|
1722
|
+
responses:
|
|
1723
|
+
'200':
|
|
1724
|
+
description: OK
|
|
1725
|
+
content:
|
|
1726
|
+
application/json:
|
|
1727
|
+
schema:
|
|
1728
|
+
$ref: '#/components/schemas/org'
|
|
1729
|
+
'400':
|
|
1730
|
+
$ref: '#/components/responses/400'
|
|
1731
|
+
'403':
|
|
1732
|
+
$ref: '#/components/responses/403'
|
|
1733
|
+
'409':
|
|
1734
|
+
$ref: '#/components/responses/409'
|
|
1735
|
+
/admin/v1/organizations/{orgName}/purge:
|
|
1736
|
+
post:
|
|
1737
|
+
summary: Purge organization
|
|
1738
|
+
operationId: purgeOrg
|
|
1739
|
+
tags:
|
|
1740
|
+
- organization
|
|
1741
|
+
- shared
|
|
1742
|
+
parameters:
|
|
1743
|
+
- in: path
|
|
1744
|
+
name: orgName
|
|
1745
|
+
required: true
|
|
1746
|
+
schema:
|
|
1747
|
+
type: string
|
|
1748
|
+
requestBody:
|
|
1749
|
+
required: true
|
|
1750
|
+
content:
|
|
1751
|
+
application/json:
|
|
1752
|
+
schema:
|
|
1753
|
+
$ref: '#/components/schemas/orgLifecycleRequest'
|
|
1754
|
+
responses:
|
|
1755
|
+
'202':
|
|
1756
|
+
description: OK
|
|
1757
|
+
content:
|
|
1758
|
+
application/json:
|
|
1759
|
+
schema:
|
|
1760
|
+
$ref: '#/components/schemas/orgPurgeResult'
|
|
1761
|
+
'400':
|
|
1762
|
+
$ref: '#/components/responses/400'
|
|
1763
|
+
'403':
|
|
1764
|
+
$ref: '#/components/responses/403'
|
|
1765
|
+
'409':
|
|
1766
|
+
$ref: '#/components/responses/409'
|
|
1666
1767
|
/admin/v1/organizations/{orgName}:
|
|
1667
1768
|
get:
|
|
1668
1769
|
description: read the specified Org
|
|
@@ -1738,6 +1839,12 @@ paths:
|
|
|
1738
1839
|
required: true
|
|
1739
1840
|
schema:
|
|
1740
1841
|
type: string
|
|
1842
|
+
- in: query
|
|
1843
|
+
name: orgID
|
|
1844
|
+
required: true
|
|
1845
|
+
schema:
|
|
1846
|
+
type: string
|
|
1847
|
+
pattern: ^[1-9][0-9]*$
|
|
1741
1848
|
responses:
|
|
1742
1849
|
'204':
|
|
1743
1850
|
content: {}
|
|
@@ -2299,11 +2406,13 @@ paths:
|
|
|
2299
2406
|
type: string
|
|
2300
2407
|
- name: after
|
|
2301
2408
|
in: query
|
|
2409
|
+
description: Raw action cursor from the preceding response's nextCursor.
|
|
2302
2410
|
required: false
|
|
2303
2411
|
schema:
|
|
2304
2412
|
type: string
|
|
2305
2413
|
- name: limit
|
|
2306
2414
|
in: query
|
|
2415
|
+
description: Raw action page budget. The last turn is read in full before coalescing; use hasMore and nextCursor rather than the returned item count.
|
|
2307
2416
|
required: false
|
|
2308
2417
|
schema:
|
|
2309
2418
|
type: integer
|
|
@@ -10550,7 +10659,7 @@ paths:
|
|
|
10550
10659
|
/admin/v1/organizations/{orgName}/clusters/{clusterName}/expose:
|
|
10551
10660
|
post:
|
|
10552
10661
|
operationId: exposeCluster
|
|
10553
|
-
summary: Expose cluster
|
|
10662
|
+
summary: Expose cluster endpoint
|
|
10554
10663
|
parameters:
|
|
10555
10664
|
- description: name of the Org
|
|
10556
10665
|
in: path
|
|
@@ -11694,6 +11803,107 @@ paths:
|
|
|
11694
11803
|
tags:
|
|
11695
11804
|
- environment
|
|
11696
11805
|
x-codegen-request-body-name: body
|
|
11806
|
+
/admin/v1/environments/{environmentName}/nodes/{nodeName}/alert/settings:
|
|
11807
|
+
get:
|
|
11808
|
+
tags:
|
|
11809
|
+
- nodeAlert
|
|
11810
|
+
operationId: getNodeAlertSettings
|
|
11811
|
+
summary: Get alert settings for a node in an environment
|
|
11812
|
+
parameters:
|
|
11813
|
+
- name: environmentName
|
|
11814
|
+
in: path
|
|
11815
|
+
required: true
|
|
11816
|
+
schema:
|
|
11817
|
+
type: string
|
|
11818
|
+
- name: nodeName
|
|
11819
|
+
in: path
|
|
11820
|
+
required: true
|
|
11821
|
+
schema:
|
|
11822
|
+
type: string
|
|
11823
|
+
responses:
|
|
11824
|
+
'200':
|
|
11825
|
+
description: Success
|
|
11826
|
+
content:
|
|
11827
|
+
application/json:
|
|
11828
|
+
schema:
|
|
11829
|
+
$ref: '#/components/schemas/alertCluster'
|
|
11830
|
+
'400':
|
|
11831
|
+
$ref: '#/components/responses/400'
|
|
11832
|
+
'401':
|
|
11833
|
+
$ref: '#/components/responses/401'
|
|
11834
|
+
'403':
|
|
11835
|
+
$ref: '#/components/responses/403'
|
|
11836
|
+
'404':
|
|
11837
|
+
$ref: '#/components/responses/404'
|
|
11838
|
+
patch:
|
|
11839
|
+
tags:
|
|
11840
|
+
- nodeAlert
|
|
11841
|
+
operationId: patchNodeAlertSettings
|
|
11842
|
+
summary: Update supplied node alert settings; omitted fields are preserved
|
|
11843
|
+
parameters:
|
|
11844
|
+
- name: environmentName
|
|
11845
|
+
in: path
|
|
11846
|
+
required: true
|
|
11847
|
+
schema:
|
|
11848
|
+
type: string
|
|
11849
|
+
- name: nodeName
|
|
11850
|
+
in: path
|
|
11851
|
+
required: true
|
|
11852
|
+
schema:
|
|
11853
|
+
type: string
|
|
11854
|
+
requestBody:
|
|
11855
|
+
required: true
|
|
11856
|
+
content:
|
|
11857
|
+
application/json:
|
|
11858
|
+
schema:
|
|
11859
|
+
$ref: '#/components/schemas/alertCluster'
|
|
11860
|
+
responses:
|
|
11861
|
+
'200':
|
|
11862
|
+
description: Success
|
|
11863
|
+
content:
|
|
11864
|
+
application/json:
|
|
11865
|
+
schema:
|
|
11866
|
+
$ref: '#/components/schemas/alertCluster'
|
|
11867
|
+
'400':
|
|
11868
|
+
$ref: '#/components/responses/400'
|
|
11869
|
+
'401':
|
|
11870
|
+
$ref: '#/components/responses/401'
|
|
11871
|
+
'403':
|
|
11872
|
+
$ref: '#/components/responses/403'
|
|
11873
|
+
'404':
|
|
11874
|
+
$ref: '#/components/responses/404'
|
|
11875
|
+
/admin/v1/environments/{environmentName}/nodes/{nodeName}/alert/rules:
|
|
11876
|
+
get:
|
|
11877
|
+
tags:
|
|
11878
|
+
- nodeAlert
|
|
11879
|
+
operationId: listNodeAlertRules
|
|
11880
|
+
summary: List node metric and NodeDown event alert rules
|
|
11881
|
+
parameters:
|
|
11882
|
+
- name: environmentName
|
|
11883
|
+
in: path
|
|
11884
|
+
required: true
|
|
11885
|
+
schema:
|
|
11886
|
+
type: string
|
|
11887
|
+
- name: nodeName
|
|
11888
|
+
in: path
|
|
11889
|
+
required: true
|
|
11890
|
+
schema:
|
|
11891
|
+
type: string
|
|
11892
|
+
responses:
|
|
11893
|
+
'200':
|
|
11894
|
+
description: Success
|
|
11895
|
+
content:
|
|
11896
|
+
application/json:
|
|
11897
|
+
schema:
|
|
11898
|
+
$ref: '#/components/schemas/alertRuleList'
|
|
11899
|
+
'400':
|
|
11900
|
+
$ref: '#/components/responses/400'
|
|
11901
|
+
'401':
|
|
11902
|
+
$ref: '#/components/responses/401'
|
|
11903
|
+
'403':
|
|
11904
|
+
$ref: '#/components/responses/403'
|
|
11905
|
+
'404':
|
|
11906
|
+
$ref: '#/components/responses/404'
|
|
11697
11907
|
/admin/v1/environments/{environmentName}/nodes/{nodeName}:
|
|
11698
11908
|
get:
|
|
11699
11909
|
description: Get specified node info for environment
|
|
@@ -14746,6 +14956,124 @@ paths:
|
|
|
14746
14956
|
$ref: '#/components/responses/403'
|
|
14747
14957
|
'404':
|
|
14748
14958
|
$ref: '#/components/responses/404'
|
|
14959
|
+
/admin/v1/organizations/{orgName}/alerts/resource/{resourceType}/{resourceID}/rules:
|
|
14960
|
+
get:
|
|
14961
|
+
tags:
|
|
14962
|
+
- alertRule
|
|
14963
|
+
- shared
|
|
14964
|
+
operationId: listResourceAlertRules
|
|
14965
|
+
summary: List applicable alert rules for a resource
|
|
14966
|
+
parameters:
|
|
14967
|
+
- name: orgName
|
|
14968
|
+
in: path
|
|
14969
|
+
description: name of the Org
|
|
14970
|
+
required: true
|
|
14971
|
+
schema:
|
|
14972
|
+
type: string
|
|
14973
|
+
- name: resourceType
|
|
14974
|
+
in: path
|
|
14975
|
+
description: resourceType
|
|
14976
|
+
required: true
|
|
14977
|
+
schema:
|
|
14978
|
+
$ref: '#/components/schemas/alertResourceType'
|
|
14979
|
+
- name: resourceID
|
|
14980
|
+
in: path
|
|
14981
|
+
required: true
|
|
14982
|
+
schema:
|
|
14983
|
+
type: string
|
|
14984
|
+
responses:
|
|
14985
|
+
'200':
|
|
14986
|
+
description: A successful response.
|
|
14987
|
+
content:
|
|
14988
|
+
application/json:
|
|
14989
|
+
schema:
|
|
14990
|
+
$ref: '#/components/schemas/alertRuleList'
|
|
14991
|
+
'401':
|
|
14992
|
+
$ref: '#/components/responses/401'
|
|
14993
|
+
'403':
|
|
14994
|
+
$ref: '#/components/responses/403'
|
|
14995
|
+
'404':
|
|
14996
|
+
$ref: '#/components/responses/404'
|
|
14997
|
+
/admin/v1/organizations/{orgName}/alerts/resource/{resourceType}/{resourceID}:
|
|
14998
|
+
get:
|
|
14999
|
+
tags:
|
|
15000
|
+
- alertRule
|
|
15001
|
+
- shared
|
|
15002
|
+
operationId: getResourceAlertDisabled
|
|
15003
|
+
summary: Get resource alert settings
|
|
15004
|
+
parameters:
|
|
15005
|
+
- name: orgName
|
|
15006
|
+
in: path
|
|
15007
|
+
description: name of the Org
|
|
15008
|
+
required: true
|
|
15009
|
+
schema:
|
|
15010
|
+
type: string
|
|
15011
|
+
- name: resourceType
|
|
15012
|
+
in: path
|
|
15013
|
+
description: resourceType
|
|
15014
|
+
required: true
|
|
15015
|
+
schema:
|
|
15016
|
+
$ref: '#/components/schemas/alertResourceType'
|
|
15017
|
+
- name: resourceID
|
|
15018
|
+
in: path
|
|
15019
|
+
required: true
|
|
15020
|
+
schema:
|
|
15021
|
+
type: string
|
|
15022
|
+
responses:
|
|
15023
|
+
'200':
|
|
15024
|
+
description: A successful response.
|
|
15025
|
+
content:
|
|
15026
|
+
application/json:
|
|
15027
|
+
schema:
|
|
15028
|
+
$ref: '#/components/schemas/alertCluster'
|
|
15029
|
+
'401':
|
|
15030
|
+
$ref: '#/components/responses/401'
|
|
15031
|
+
'403':
|
|
15032
|
+
$ref: '#/components/responses/403'
|
|
15033
|
+
'404':
|
|
15034
|
+
$ref: '#/components/responses/404'
|
|
15035
|
+
patch:
|
|
15036
|
+
tags:
|
|
15037
|
+
- alertRule
|
|
15038
|
+
- shared
|
|
15039
|
+
operationId: setResourceAlertDisabled
|
|
15040
|
+
summary: Update resource alert settings
|
|
15041
|
+
parameters:
|
|
15042
|
+
- name: orgName
|
|
15043
|
+
in: path
|
|
15044
|
+
description: name of the Org
|
|
15045
|
+
required: true
|
|
15046
|
+
schema:
|
|
15047
|
+
type: string
|
|
15048
|
+
- name: resourceType
|
|
15049
|
+
in: path
|
|
15050
|
+
description: resourceType
|
|
15051
|
+
required: true
|
|
15052
|
+
schema:
|
|
15053
|
+
$ref: '#/components/schemas/alertResourceType'
|
|
15054
|
+
- name: resourceID
|
|
15055
|
+
in: path
|
|
15056
|
+
required: true
|
|
15057
|
+
schema:
|
|
15058
|
+
type: string
|
|
15059
|
+
requestBody:
|
|
15060
|
+
content:
|
|
15061
|
+
application/json:
|
|
15062
|
+
schema:
|
|
15063
|
+
$ref: '#/components/schemas/alertCluster'
|
|
15064
|
+
responses:
|
|
15065
|
+
'200':
|
|
15066
|
+
description: A successful response.
|
|
15067
|
+
content:
|
|
15068
|
+
application/json:
|
|
15069
|
+
schema:
|
|
15070
|
+
$ref: '#/components/schemas/alertCluster'
|
|
15071
|
+
'401':
|
|
15072
|
+
$ref: '#/components/responses/401'
|
|
15073
|
+
'403':
|
|
15074
|
+
$ref: '#/components/responses/403'
|
|
15075
|
+
'404':
|
|
15076
|
+
$ref: '#/components/responses/404'
|
|
14749
15077
|
/admin/v1/alerts/checkURL:
|
|
14750
15078
|
post:
|
|
14751
15079
|
summary: Batch check URLs connectivity
|
|
@@ -18628,6 +18956,34 @@ paths:
|
|
|
18628
18956
|
$ref: '#/components/responses/500'
|
|
18629
18957
|
tags:
|
|
18630
18958
|
- task
|
|
18959
|
+
/admin/v1/tasks/{taskId}/abort:
|
|
18960
|
+
post:
|
|
18961
|
+
summary: Force abort a task
|
|
18962
|
+
description: Forcefully abort a running task. Pending steps or OpsRequests are cancelled, running ones are aborted.
|
|
18963
|
+
operationId: abortTask
|
|
18964
|
+
parameters:
|
|
18965
|
+
- description: ID of the task
|
|
18966
|
+
in: path
|
|
18967
|
+
name: taskId
|
|
18968
|
+
required: true
|
|
18969
|
+
schema:
|
|
18970
|
+
type: string
|
|
18971
|
+
responses:
|
|
18972
|
+
'204':
|
|
18973
|
+
content: {}
|
|
18974
|
+
description: Task aborted successfully
|
|
18975
|
+
'400':
|
|
18976
|
+
$ref: '#/components/responses/400'
|
|
18977
|
+
'401':
|
|
18978
|
+
$ref: '#/components/responses/401'
|
|
18979
|
+
'403':
|
|
18980
|
+
$ref: '#/components/responses/403'
|
|
18981
|
+
'404':
|
|
18982
|
+
$ref: '#/components/responses/404'
|
|
18983
|
+
'500':
|
|
18984
|
+
$ref: '#/components/responses/500'
|
|
18985
|
+
tags:
|
|
18986
|
+
- task
|
|
18631
18987
|
/admin/v1/tasks/{taskId}/log:
|
|
18632
18988
|
get:
|
|
18633
18989
|
tags:
|
|
@@ -30580,15 +30936,44 @@ components:
|
|
|
30580
30936
|
description: The list of series items aggregated in the time range.
|
|
30581
30937
|
items:
|
|
30582
30938
|
$ref: '#/components/schemas/seriesItem'
|
|
30939
|
+
orgStatus:
|
|
30940
|
+
x-nullable: false
|
|
30941
|
+
type: string
|
|
30942
|
+
enum:
|
|
30943
|
+
- Active
|
|
30944
|
+
- DeletionLocked
|
|
30945
|
+
- Purging
|
|
30946
|
+
- PurgeFailed
|
|
30947
|
+
- Deleted
|
|
30583
30948
|
organizationItem:
|
|
30584
30949
|
description: Organization items.
|
|
30585
30950
|
type: object
|
|
30586
30951
|
required:
|
|
30952
|
+
- id
|
|
30953
|
+
- status
|
|
30954
|
+
- expiredAt
|
|
30955
|
+
- allowedActions
|
|
30587
30956
|
- name
|
|
30588
30957
|
- displayName
|
|
30589
30958
|
- clusterTotal
|
|
30590
30959
|
- createdAt
|
|
30591
30960
|
properties:
|
|
30961
|
+
id:
|
|
30962
|
+
x-nullable: false
|
|
30963
|
+
type: string
|
|
30964
|
+
status:
|
|
30965
|
+
x-nullable: false
|
|
30966
|
+
$ref: '#/components/schemas/orgStatus'
|
|
30967
|
+
expiredAt:
|
|
30968
|
+
type: string
|
|
30969
|
+
format: date-time
|
|
30970
|
+
nullable: true
|
|
30971
|
+
purgeError:
|
|
30972
|
+
type: string
|
|
30973
|
+
allowedActions:
|
|
30974
|
+
type: array
|
|
30975
|
+
items:
|
|
30976
|
+
type: string
|
|
30592
30977
|
name:
|
|
30593
30978
|
type: string
|
|
30594
30979
|
description: The name of the organization.
|
|
@@ -30638,6 +31023,19 @@ components:
|
|
|
30638
31023
|
org:
|
|
30639
31024
|
description: Org info
|
|
30640
31025
|
properties:
|
|
31026
|
+
status:
|
|
31027
|
+
x-nullable: false
|
|
31028
|
+
$ref: '#/components/schemas/orgStatus'
|
|
31029
|
+
expiredAt:
|
|
31030
|
+
type: string
|
|
31031
|
+
format: date-time
|
|
31032
|
+
nullable: true
|
|
31033
|
+
purgeError:
|
|
31034
|
+
type: string
|
|
31035
|
+
allowedActions:
|
|
31036
|
+
type: array
|
|
31037
|
+
items:
|
|
31038
|
+
type: string
|
|
30641
31039
|
createdAt:
|
|
30642
31040
|
description: |-
|
|
30643
31041
|
CreatedAt is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
|
|
@@ -30668,11 +31066,167 @@ components:
|
|
|
30668
31066
|
description: return true if the organization is enabled
|
|
30669
31067
|
type: boolean
|
|
30670
31068
|
required:
|
|
31069
|
+
- status
|
|
31070
|
+
- expiredAt
|
|
31071
|
+
- allowedActions
|
|
30671
31072
|
- createdAt
|
|
30672
31073
|
- name
|
|
30673
31074
|
- updatedAt
|
|
30674
31075
|
- enabled
|
|
30675
31076
|
type: object
|
|
31077
|
+
orgDeletionAction:
|
|
31078
|
+
type: string
|
|
31079
|
+
enum:
|
|
31080
|
+
- delete
|
|
31081
|
+
- purge
|
|
31082
|
+
orgDeletionBlocker:
|
|
31083
|
+
type: object
|
|
31084
|
+
required:
|
|
31085
|
+
- code
|
|
31086
|
+
- resourceType
|
|
31087
|
+
- count
|
|
31088
|
+
properties:
|
|
31089
|
+
code:
|
|
31090
|
+
x-nullable: false
|
|
31091
|
+
type: string
|
|
31092
|
+
resourceType:
|
|
31093
|
+
x-nullable: false
|
|
31094
|
+
type: string
|
|
31095
|
+
count:
|
|
31096
|
+
x-nullable: false
|
|
31097
|
+
type: integer
|
|
31098
|
+
format: int64
|
|
31099
|
+
orgConfigurationItem:
|
|
31100
|
+
type: object
|
|
31101
|
+
required:
|
|
31102
|
+
- id
|
|
31103
|
+
- displayName
|
|
31104
|
+
properties:
|
|
31105
|
+
id:
|
|
31106
|
+
x-nullable: false
|
|
31107
|
+
type: string
|
|
31108
|
+
displayName:
|
|
31109
|
+
x-nullable: false
|
|
31110
|
+
type: string
|
|
31111
|
+
orgConfigurationSummary:
|
|
31112
|
+
type: object
|
|
31113
|
+
required:
|
|
31114
|
+
- type
|
|
31115
|
+
- count
|
|
31116
|
+
- items
|
|
31117
|
+
- truncated
|
|
31118
|
+
- actionEffect
|
|
31119
|
+
- purgeEffect
|
|
31120
|
+
properties:
|
|
31121
|
+
type:
|
|
31122
|
+
x-nullable: false
|
|
31123
|
+
type: string
|
|
31124
|
+
count:
|
|
31125
|
+
x-nullable: false
|
|
31126
|
+
type: integer
|
|
31127
|
+
format: int64
|
|
31128
|
+
items:
|
|
31129
|
+
x-nullable: false
|
|
31130
|
+
type: array
|
|
31131
|
+
items:
|
|
31132
|
+
$ref: '#/components/schemas/orgConfigurationItem'
|
|
31133
|
+
truncated:
|
|
31134
|
+
x-nullable: false
|
|
31135
|
+
type: boolean
|
|
31136
|
+
actionEffect:
|
|
31137
|
+
x-nullable: false
|
|
31138
|
+
type: string
|
|
31139
|
+
purgeEffect:
|
|
31140
|
+
x-nullable: false
|
|
31141
|
+
type: string
|
|
31142
|
+
orgRetainedResource:
|
|
31143
|
+
type: object
|
|
31144
|
+
required:
|
|
31145
|
+
- type
|
|
31146
|
+
- count
|
|
31147
|
+
- retentionPolicy
|
|
31148
|
+
properties:
|
|
31149
|
+
type:
|
|
31150
|
+
x-nullable: false
|
|
31151
|
+
type: string
|
|
31152
|
+
count:
|
|
31153
|
+
x-nullable: false
|
|
31154
|
+
type: integer
|
|
31155
|
+
format: int64
|
|
31156
|
+
retentionPolicy:
|
|
31157
|
+
x-nullable: false
|
|
31158
|
+
type: string
|
|
31159
|
+
orgDeletionPreview:
|
|
31160
|
+
type: object
|
|
31161
|
+
required:
|
|
31162
|
+
- orgID
|
|
31163
|
+
- name
|
|
31164
|
+
- status
|
|
31165
|
+
- expiredAt
|
|
31166
|
+
- action
|
|
31167
|
+
- canProceed
|
|
31168
|
+
- blockers
|
|
31169
|
+
- configurations
|
|
31170
|
+
- retainedResources
|
|
31171
|
+
properties:
|
|
31172
|
+
orgID:
|
|
31173
|
+
x-nullable: false
|
|
31174
|
+
type: string
|
|
31175
|
+
name:
|
|
31176
|
+
x-nullable: false
|
|
31177
|
+
type: string
|
|
31178
|
+
status:
|
|
31179
|
+
x-nullable: false
|
|
31180
|
+
type: string
|
|
31181
|
+
expiredAt:
|
|
31182
|
+
type: string
|
|
31183
|
+
format: date-time
|
|
31184
|
+
nullable: true
|
|
31185
|
+
purgeError:
|
|
31186
|
+
type: string
|
|
31187
|
+
action:
|
|
31188
|
+
x-nullable: false
|
|
31189
|
+
type: string
|
|
31190
|
+
canProceed:
|
|
31191
|
+
x-nullable: false
|
|
31192
|
+
type: boolean
|
|
31193
|
+
blockers:
|
|
31194
|
+
x-nullable: false
|
|
31195
|
+
type: array
|
|
31196
|
+
items:
|
|
31197
|
+
$ref: '#/components/schemas/orgDeletionBlocker'
|
|
31198
|
+
configurations:
|
|
31199
|
+
x-nullable: false
|
|
31200
|
+
type: array
|
|
31201
|
+
items:
|
|
31202
|
+
$ref: '#/components/schemas/orgConfigurationSummary'
|
|
31203
|
+
retainedResources:
|
|
31204
|
+
x-nullable: false
|
|
31205
|
+
type: array
|
|
31206
|
+
items:
|
|
31207
|
+
$ref: '#/components/schemas/orgRetainedResource'
|
|
31208
|
+
orgLifecycleRequest:
|
|
31209
|
+
type: object
|
|
31210
|
+
required:
|
|
31211
|
+
- orgID
|
|
31212
|
+
- expectedExpiredAt
|
|
31213
|
+
properties:
|
|
31214
|
+
orgID:
|
|
31215
|
+
type: string
|
|
31216
|
+
pattern: ^[1-9][0-9]*$
|
|
31217
|
+
expectedExpiredAt:
|
|
31218
|
+
type: string
|
|
31219
|
+
format: date-time
|
|
31220
|
+
orgPurgeResult:
|
|
31221
|
+
type: object
|
|
31222
|
+
properties:
|
|
31223
|
+
orgID:
|
|
31224
|
+
type: string
|
|
31225
|
+
status:
|
|
31226
|
+
type: string
|
|
31227
|
+
expiredAt:
|
|
31228
|
+
type: string
|
|
31229
|
+
format: date-time
|
|
30676
31230
|
orgUpdate:
|
|
30677
31231
|
description: Organization update
|
|
30678
31232
|
properties:
|
|
@@ -31153,6 +31707,12 @@ components:
|
|
|
31153
31707
|
type: array
|
|
31154
31708
|
items:
|
|
31155
31709
|
$ref: '#/components/schemas/aiAgentTurnAction'
|
|
31710
|
+
nextCursor:
|
|
31711
|
+
type: string
|
|
31712
|
+
description: Raw action cursor for the next page; independent of coalesced item IDs and timestamps.
|
|
31713
|
+
hasMore:
|
|
31714
|
+
type: boolean
|
|
31715
|
+
description: Whether more actions are available. Pages finish the last turn before coalescing, so item counts must not be used to detect the final page.
|
|
31156
31716
|
aiAgentEvent:
|
|
31157
31717
|
type: object
|
|
31158
31718
|
required:
|
|
@@ -31823,6 +32383,11 @@ components:
|
|
|
31823
32383
|
required:
|
|
31824
32384
|
- component
|
|
31825
32385
|
properties:
|
|
32386
|
+
annotations:
|
|
32387
|
+
type: object
|
|
32388
|
+
additionalProperties:
|
|
32389
|
+
type: string
|
|
32390
|
+
description: User-provided component annotations, merged over chart defaults. Platform-managed keys cannot be overridden. Omitted or empty preserves defaults; empty string values are literal values, not deletions.
|
|
31826
32391
|
nodeGroup:
|
|
31827
32392
|
type: string
|
|
31828
32393
|
description: Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
|
|
@@ -32168,6 +32733,11 @@ components:
|
|
|
32168
32733
|
type: object
|
|
32169
32734
|
description: ComponentItem is the information of a component
|
|
32170
32735
|
properties:
|
|
32736
|
+
annotations:
|
|
32737
|
+
type: object
|
|
32738
|
+
additionalProperties:
|
|
32739
|
+
type: string
|
|
32740
|
+
description: User-provided component annotations. Does not include chart defaults or system-generated values.
|
|
32171
32741
|
nodeGroup:
|
|
32172
32742
|
type: string
|
|
32173
32743
|
description: Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
|
|
@@ -37381,10 +37951,11 @@ components:
|
|
|
37381
37951
|
type: object
|
|
37382
37952
|
opsExposeType:
|
|
37383
37953
|
type: string
|
|
37384
|
-
description: Specifies the type of exposure for the KubeBlocks cluster.
|
|
37954
|
+
description: Specifies the type of exposure for the KubeBlocks cluster. Internal exposure creates an internal-ro ClusterIP service and requires readonly=true; it is independent of vpc and internet exposure.
|
|
37385
37955
|
enum:
|
|
37386
37956
|
- vpc
|
|
37387
37957
|
- internet
|
|
37958
|
+
- internal
|
|
37388
37959
|
opsExposeVPCServiceType:
|
|
37389
37960
|
description: Specifies the type of service for the KubeBlocks cluster.
|
|
37390
37961
|
enum:
|
|
@@ -37401,10 +37972,12 @@ components:
|
|
|
37401
37972
|
enable:
|
|
37402
37973
|
type: boolean
|
|
37403
37974
|
readonly:
|
|
37975
|
+
description: Select the configured read-only role. Must be true for internal exposure.
|
|
37404
37976
|
type: boolean
|
|
37405
37977
|
type:
|
|
37406
37978
|
$ref: '#/components/schemas/opsExposeType'
|
|
37407
37979
|
vpcServiceType:
|
|
37980
|
+
description: Service type for vpc exposure. Omit for internal exposure, which always uses ClusterIP.
|
|
37408
37981
|
$ref: '#/components/schemas/opsExposeVPCServiceType'
|
|
37409
37982
|
portsMapping:
|
|
37410
37983
|
type: array
|
|
@@ -38808,6 +39381,142 @@ components:
|
|
|
38808
39381
|
type: array
|
|
38809
39382
|
items:
|
|
38810
39383
|
$ref: '#/components/schemas/koordinatorReservationSummaryItem'
|
|
39384
|
+
alertClusterSilenceMode:
|
|
39385
|
+
type: string
|
|
39386
|
+
enum:
|
|
39387
|
+
- once
|
|
39388
|
+
- weekly
|
|
39389
|
+
description: Required when enabled. Once uses absolute timestamps; weekly uses weekdays and local times in timeZone.
|
|
39390
|
+
alertClusterSilence:
|
|
39391
|
+
type: object
|
|
39392
|
+
required:
|
|
39393
|
+
- enabled
|
|
39394
|
+
description: Pause notifications while continuing to record alerts. Set enabled to false to cancel. Time windows include their start and exclude their end.
|
|
39395
|
+
properties:
|
|
39396
|
+
enabled:
|
|
39397
|
+
type: boolean
|
|
39398
|
+
rules:
|
|
39399
|
+
type: array
|
|
39400
|
+
maxItems: 1000
|
|
39401
|
+
description: Alert names to silence. Empty or omitted means all alerts for the resource.
|
|
39402
|
+
items:
|
|
39403
|
+
type: string
|
|
39404
|
+
minLength: 1
|
|
39405
|
+
maxLength: 255
|
|
39406
|
+
mode:
|
|
39407
|
+
$ref: '#/components/schemas/alertClusterSilenceMode'
|
|
39408
|
+
startsAt:
|
|
39409
|
+
type: string
|
|
39410
|
+
format: date-time
|
|
39411
|
+
description: Required for once. Absolute start of the silence window.
|
|
39412
|
+
endsAt:
|
|
39413
|
+
type: string
|
|
39414
|
+
format: date-time
|
|
39415
|
+
description: Required for once. Must be later than startsAt.
|
|
39416
|
+
weekdays:
|
|
39417
|
+
type: array
|
|
39418
|
+
maxItems: 7
|
|
39419
|
+
description: Required for weekly. Sunday is 0. Overnight windows belong to the weekday on which they start.
|
|
39420
|
+
items:
|
|
39421
|
+
type: integer
|
|
39422
|
+
minimum: 0
|
|
39423
|
+
maximum: 6
|
|
39424
|
+
startTime:
|
|
39425
|
+
type: string
|
|
39426
|
+
description: Required for weekly, in HH:mm format.
|
|
39427
|
+
endTime:
|
|
39428
|
+
type: string
|
|
39429
|
+
description: Required for weekly, in HH:mm format. Earlier than startTime means the following day; equal times are invalid.
|
|
39430
|
+
timeZone:
|
|
39431
|
+
type: string
|
|
39432
|
+
maxLength: 100
|
|
39433
|
+
description: Required for weekly. IANA timezone, e.g. Asia/Shanghai or UTC.
|
|
39434
|
+
alertCluster:
|
|
39435
|
+
type: object
|
|
39436
|
+
description: Resource-scoped alert settings, shared by cluster and node endpoints. PATCH updates only supplied fields. Cluster settings apply to both tenant and administrator notifications.
|
|
39437
|
+
properties:
|
|
39438
|
+
disabled:
|
|
39439
|
+
type: boolean
|
|
39440
|
+
x-nullable: true
|
|
39441
|
+
description: Disable all alerts for the resource. Existing rule and silence settings are preserved.
|
|
39442
|
+
disabledRules:
|
|
39443
|
+
type: array
|
|
39444
|
+
maxItems: 1000
|
|
39445
|
+
x-omitempty: false
|
|
39446
|
+
description: Alert names disabled only for this resource. An empty array clears all rule overrides; omission preserves them.
|
|
39447
|
+
items:
|
|
39448
|
+
type: string
|
|
39449
|
+
minLength: 1
|
|
39450
|
+
maxLength: 255
|
|
39451
|
+
silence:
|
|
39452
|
+
$ref: '#/components/schemas/alertClusterSilence'
|
|
39453
|
+
silenceActive:
|
|
39454
|
+
type: boolean
|
|
39455
|
+
readOnly: true
|
|
39456
|
+
description: Whether the configured silence window is active now, regardless of the alert master switch.
|
|
39457
|
+
alertSeverity:
|
|
39458
|
+
enum:
|
|
39459
|
+
- critical
|
|
39460
|
+
- warning
|
|
39461
|
+
- info
|
|
39462
|
+
type: string
|
|
39463
|
+
alertRule:
|
|
39464
|
+
required:
|
|
39465
|
+
- alertName
|
|
39466
|
+
- for
|
|
39467
|
+
- groupName
|
|
39468
|
+
- severity
|
|
39469
|
+
type: object
|
|
39470
|
+
properties:
|
|
39471
|
+
description:
|
|
39472
|
+
type: string
|
|
39473
|
+
summary:
|
|
39474
|
+
type: string
|
|
39475
|
+
alertName:
|
|
39476
|
+
type: string
|
|
39477
|
+
expr:
|
|
39478
|
+
type: string
|
|
39479
|
+
description: Expression. Required if metric is not provided.
|
|
39480
|
+
for:
|
|
39481
|
+
type: string
|
|
39482
|
+
groupName:
|
|
39483
|
+
type: string
|
|
39484
|
+
disabled:
|
|
39485
|
+
type: boolean
|
|
39486
|
+
default: false
|
|
39487
|
+
severity:
|
|
39488
|
+
$ref: '#/components/schemas/alertSeverity'
|
|
39489
|
+
createdAt:
|
|
39490
|
+
type: string
|
|
39491
|
+
format: date-time
|
|
39492
|
+
updatedAt:
|
|
39493
|
+
type: string
|
|
39494
|
+
format: date-time
|
|
39495
|
+
orgName:
|
|
39496
|
+
type: string
|
|
39497
|
+
description: Alert rule information. Either provide 'expr' for custom expressions, or 'metric' for predefined metrics.
|
|
39498
|
+
alertRuleGroup:
|
|
39499
|
+
type: object
|
|
39500
|
+
properties:
|
|
39501
|
+
name:
|
|
39502
|
+
type: string
|
|
39503
|
+
rules:
|
|
39504
|
+
type: array
|
|
39505
|
+
items:
|
|
39506
|
+
$ref: '#/components/schemas/alertRule'
|
|
39507
|
+
alertRuleList:
|
|
39508
|
+
required:
|
|
39509
|
+
- items
|
|
39510
|
+
type: object
|
|
39511
|
+
properties:
|
|
39512
|
+
items:
|
|
39513
|
+
type: array
|
|
39514
|
+
description: Items is the list of alert rule objects in the list
|
|
39515
|
+
items:
|
|
39516
|
+
$ref: '#/components/schemas/alertRuleGroup'
|
|
39517
|
+
pageResult:
|
|
39518
|
+
$ref: '#/components/schemas/pageResult'
|
|
39519
|
+
description: AlertRuleList is a list of alert rules
|
|
38811
39520
|
listBody:
|
|
38812
39521
|
description: Represents a list of JSON bodies.
|
|
38813
39522
|
items:
|
|
@@ -40468,7 +41177,7 @@ components:
|
|
|
40468
41177
|
cluster:
|
|
40469
41178
|
$ref: '#/components/schemas/clusterCreate'
|
|
40470
41179
|
restoreTimeStr:
|
|
40471
|
-
description:
|
|
41180
|
+
description: Target time for point-in-time recovery, only supported with a Continuous backup ID. Use an RFC3339 timestamp at whole-second precision, for example 2026-10-22T08:30:00Z or 2026-10-22T16:30:00+08:00. Timezone offsets are converted to UTC without changing the instant. Non-zero fractional seconds and UTC years outside 0000-9999 are rejected. Omit or leave empty to retain the backup method's default restore behavior.
|
|
40472
41181
|
type: string
|
|
40473
41182
|
doReadyRestoreAfterClusterRunning:
|
|
40474
41183
|
description: the recovery process in the PostReady phase will be performed after the cluster is running successfully.
|
|
@@ -40554,142 +41263,11 @@ components:
|
|
|
40554
41263
|
required:
|
|
40555
41264
|
- items
|
|
40556
41265
|
type: object
|
|
40557
|
-
|
|
40558
|
-
enum:
|
|
40559
|
-
- critical
|
|
40560
|
-
- warning
|
|
40561
|
-
- info
|
|
40562
|
-
type: string
|
|
40563
|
-
alertRule:
|
|
40564
|
-
required:
|
|
40565
|
-
- alertName
|
|
40566
|
-
- for
|
|
40567
|
-
- groupName
|
|
40568
|
-
- severity
|
|
40569
|
-
type: object
|
|
40570
|
-
properties:
|
|
40571
|
-
description:
|
|
40572
|
-
type: string
|
|
40573
|
-
summary:
|
|
40574
|
-
type: string
|
|
40575
|
-
alertName:
|
|
40576
|
-
type: string
|
|
40577
|
-
expr:
|
|
40578
|
-
type: string
|
|
40579
|
-
description: Expression. Required if metric is not provided.
|
|
40580
|
-
for:
|
|
40581
|
-
type: string
|
|
40582
|
-
groupName:
|
|
40583
|
-
type: string
|
|
40584
|
-
disabled:
|
|
40585
|
-
type: boolean
|
|
40586
|
-
default: false
|
|
40587
|
-
severity:
|
|
40588
|
-
$ref: '#/components/schemas/alertSeverity'
|
|
40589
|
-
createdAt:
|
|
40590
|
-
type: string
|
|
40591
|
-
format: date-time
|
|
40592
|
-
updatedAt:
|
|
40593
|
-
type: string
|
|
40594
|
-
format: date-time
|
|
40595
|
-
orgName:
|
|
40596
|
-
type: string
|
|
40597
|
-
description: Alert rule information. Either provide 'expr' for custom expressions, or 'metric' for predefined metrics.
|
|
40598
|
-
alertRuleGroup:
|
|
40599
|
-
type: object
|
|
40600
|
-
properties:
|
|
40601
|
-
name:
|
|
40602
|
-
type: string
|
|
40603
|
-
rules:
|
|
40604
|
-
type: array
|
|
40605
|
-
items:
|
|
40606
|
-
$ref: '#/components/schemas/alertRule'
|
|
40607
|
-
alertRuleList:
|
|
40608
|
-
required:
|
|
40609
|
-
- items
|
|
40610
|
-
type: object
|
|
40611
|
-
properties:
|
|
40612
|
-
items:
|
|
40613
|
-
type: array
|
|
40614
|
-
description: Items is the list of alert rule objects in the list
|
|
40615
|
-
items:
|
|
40616
|
-
$ref: '#/components/schemas/alertRuleGroup'
|
|
40617
|
-
pageResult:
|
|
40618
|
-
$ref: '#/components/schemas/pageResult'
|
|
40619
|
-
description: AlertRuleList is a list of alert rules
|
|
40620
|
-
alertClusterSilenceMode:
|
|
41266
|
+
alertResourceType:
|
|
40621
41267
|
type: string
|
|
40622
41268
|
enum:
|
|
40623
|
-
-
|
|
40624
|
-
-
|
|
40625
|
-
description: Required when enabled. Once uses absolute timestamps; weekly uses weekdays and local times in timeZone.
|
|
40626
|
-
alertClusterSilence:
|
|
40627
|
-
type: object
|
|
40628
|
-
required:
|
|
40629
|
-
- enabled
|
|
40630
|
-
description: Pause notifications while continuing to record alerts. Set enabled to false to cancel. Time windows include their start and exclude their end.
|
|
40631
|
-
properties:
|
|
40632
|
-
enabled:
|
|
40633
|
-
type: boolean
|
|
40634
|
-
rules:
|
|
40635
|
-
type: array
|
|
40636
|
-
maxItems: 1000
|
|
40637
|
-
description: Alert names to silence. Empty or omitted means all cluster alerts.
|
|
40638
|
-
items:
|
|
40639
|
-
type: string
|
|
40640
|
-
minLength: 1
|
|
40641
|
-
maxLength: 255
|
|
40642
|
-
mode:
|
|
40643
|
-
$ref: '#/components/schemas/alertClusterSilenceMode'
|
|
40644
|
-
startsAt:
|
|
40645
|
-
type: string
|
|
40646
|
-
format: date-time
|
|
40647
|
-
description: Required for once. Absolute start of the silence window.
|
|
40648
|
-
endsAt:
|
|
40649
|
-
type: string
|
|
40650
|
-
format: date-time
|
|
40651
|
-
description: Required for once. Must be later than startsAt.
|
|
40652
|
-
weekdays:
|
|
40653
|
-
type: array
|
|
40654
|
-
maxItems: 7
|
|
40655
|
-
description: Required for weekly. Sunday is 0. Overnight windows belong to the weekday on which they start.
|
|
40656
|
-
items:
|
|
40657
|
-
type: integer
|
|
40658
|
-
minimum: 0
|
|
40659
|
-
maximum: 6
|
|
40660
|
-
startTime:
|
|
40661
|
-
type: string
|
|
40662
|
-
description: Required for weekly, in HH:mm format.
|
|
40663
|
-
endTime:
|
|
40664
|
-
type: string
|
|
40665
|
-
description: Required for weekly, in HH:mm format. Earlier than startTime means the following day; equal times are invalid.
|
|
40666
|
-
timeZone:
|
|
40667
|
-
type: string
|
|
40668
|
-
maxLength: 100
|
|
40669
|
-
description: Required for weekly. IANA timezone, e.g. Asia/Shanghai or UTC.
|
|
40670
|
-
alertCluster:
|
|
40671
|
-
type: object
|
|
40672
|
-
description: Cluster-scoped alert settings. PATCH updates only supplied fields; settings apply to both tenant and administrator notifications.
|
|
40673
|
-
properties:
|
|
40674
|
-
disabled:
|
|
40675
|
-
type: boolean
|
|
40676
|
-
x-nullable: true
|
|
40677
|
-
description: Disable all cluster alerts. Existing rule and silence settings are preserved.
|
|
40678
|
-
disabledRules:
|
|
40679
|
-
type: array
|
|
40680
|
-
maxItems: 1000
|
|
40681
|
-
x-omitempty: false
|
|
40682
|
-
description: Alert names disabled only for this cluster. An empty array clears all rule overrides; omission preserves them.
|
|
40683
|
-
items:
|
|
40684
|
-
type: string
|
|
40685
|
-
minLength: 1
|
|
40686
|
-
maxLength: 255
|
|
40687
|
-
silence:
|
|
40688
|
-
$ref: '#/components/schemas/alertClusterSilence'
|
|
40689
|
-
silenceActive:
|
|
40690
|
-
type: boolean
|
|
40691
|
-
readOnly: true
|
|
40692
|
-
description: Whether the configured silence window is active now, regardless of the alert master switch.
|
|
41269
|
+
- cluster
|
|
41270
|
+
- channel
|
|
40693
41271
|
URLCheck:
|
|
40694
41272
|
type: object
|
|
40695
41273
|
required:
|
|
@@ -41142,6 +41720,10 @@ components:
|
|
|
41142
41720
|
description: Main component flag
|
|
41143
41721
|
type: boolean
|
|
41144
41722
|
x-nullable: false
|
|
41723
|
+
customAnnotations:
|
|
41724
|
+
type: boolean
|
|
41725
|
+
description: Whether to show the component annotations editor during cluster creation. Omitted or false hides the editor. This is a UI visibility hint and does not restrict the cluster creation API. Applies to this component in every engine mode, including sharding templates, on KubeBlocks 0.9 and 1.0.
|
|
41726
|
+
x-nullable: false
|
|
41145
41727
|
customSecret:
|
|
41146
41728
|
type: boolean
|
|
41147
41729
|
description: whether the component supports custom secret
|
|
@@ -43422,6 +44004,16 @@ components:
|
|
|
43422
44004
|
description: Allowed engine license types. Omit to retain unrestricted license types.
|
|
43423
44005
|
items:
|
|
43424
44006
|
type: string
|
|
44007
|
+
versions:
|
|
44008
|
+
type: array
|
|
44009
|
+
description: Engine versions that support license installation. Entries match an exact service version or its major version according to the main component version rule. Omit or leave empty for unrestricted versions.
|
|
44010
|
+
items:
|
|
44011
|
+
type: string
|
|
44012
|
+
networkModes:
|
|
44013
|
+
type: array
|
|
44014
|
+
description: Effective cluster network modes that support license installation. Omit or leave empty for unrestricted network modes.
|
|
44015
|
+
items:
|
|
44016
|
+
$ref: '#/components/schemas/networkMode'
|
|
43425
44017
|
files:
|
|
43426
44018
|
type: array
|
|
43427
44019
|
description: Explicit license file upload slots. Each item maps one UI upload field to the file name written into the license Secret.
|
|
@@ -44863,10 +45455,10 @@ components:
|
|
|
44863
45455
|
type: integer
|
|
44864
45456
|
format: int64
|
|
44865
45457
|
x-nullable: true
|
|
44866
|
-
description: Weighted health score from 0 to 100 over evaluable inspection items only. Unknown results and items with info importance are excluded from both the numerator and denominator. The field is omitted when no item is evaluable
|
|
45458
|
+
description: Weighted health score from 0 to 100 over evaluable inspection items only. Unknown results and items with info importance are excluded from both the numerator and denominator. The field is omitted when no item is evaluable. Doris and SelectDB also omit it when risk-check evidence is unavailable, and score correlated findings once per failure family. A present value of 0 is a valid evaluated score.
|
|
44867
45459
|
result:
|
|
44868
45460
|
type: string
|
|
44869
|
-
description: Task health conclusion derived from evaluable item states and criticality-aware score caps. Valid conclusions are red, yellow, green, and unknown. Unknown means no item is evaluable
|
|
45461
|
+
description: Task health conclusion derived from evaluable item states and criticality-aware score caps. Valid conclusions are red, yellow, green, and unknown. Unknown means no item is evaluable, or a Doris/SelectDB inspection has unavailable risk-check evidence without an observed red or yellow finding. Unavailable evidence never hides an observed red or yellow finding.
|
|
44870
45462
|
latestRunAt:
|
|
44871
45463
|
format: date-time
|
|
44872
45464
|
type: string
|
|
@@ -45631,6 +46223,7 @@ components:
|
|
|
45631
46223
|
- Failed
|
|
45632
46224
|
- Cancelling
|
|
45633
46225
|
- Cancelled
|
|
46226
|
+
- Aborted
|
|
45634
46227
|
description: Current status of the task
|
|
45635
46228
|
taskListItem:
|
|
45636
46229
|
type: object
|