kb-cloud-client-typescript 2.4.0-alpha.117 → 2.4.0-alpha.119

package/src/adminapi/models/apelocal-capacity-observations.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ApelocalCapacityObservation } from './apelocal-capacity-observation';
+
+/**
+ * Known-node aggregates after resource deduplication. Capacity values are in GiB and ratios are percentages using only nodes with both inputs. Independent measurements can cover different nodes. Quota, remaining quota and allocation percentage objects are omitted for unlimited or conflicting policies. Remaining quota covers only ready schedulable nodes. Physical remaining is capacity minus usage from nodes with both measurements and usage not exceeding capacity; it is not a guaranteed writable or schedulable quota. Existing summary totals remain omitted when incomplete.
+ * @export
+ * @interface ApelocalCapacityObservations
+ */
+export interface ApelocalCapacityObservations {
+    /**
+     * 
+     * @type {ApelocalCapacityObservation}
+     * @memberof ApelocalCapacityObservations
+     */
+    'physicalCapacity'?: ApelocalCapacityObservation;
+    /**
+     * 
+     * @type {ApelocalCapacityObservation}
+     * @memberof ApelocalCapacityObservations
+     */
+    'physicalUsage'?: ApelocalCapacityObservation;
+    /**
+     * 
+     * @type {ApelocalCapacityObservation}
+     * @memberof ApelocalCapacityObservations
+     */
+    'physicalRemaining'?: ApelocalCapacityObservation;
+    /**
+     * 
+     * @type {ApelocalCapacityObservation}
+     * @memberof ApelocalCapacityObservations
+     */
+    'allocatedCapacity'?: ApelocalCapacityObservation;
+    /**
+     * 
+     * @type {ApelocalCapacityObservation}
+     * @memberof ApelocalCapacityObservations
+     */
+    'allocatableCapacity'?: ApelocalCapacityObservation;
+    /**
+     * 
+     * @type {ApelocalCapacityObservation}
+     * @memberof ApelocalCapacityObservations
+     */
+    'availableCapacity'?: ApelocalCapacityObservation;
+    /**
+     * 
+     * @type {ApelocalCapacityObservation}
+     * @memberof ApelocalCapacityObservations
+     */
+    'physicalUsagePercent'?: ApelocalCapacityObservation;
+    /**
+     * 
+     * @type {ApelocalCapacityObservation}
+     * @memberof ApelocalCapacityObservations
+     */
+    'allocationPercent'?: ApelocalCapacityObservation;
+}
+

package/src/adminapi/models/apelocal-capacity-summary-mode.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Conflicting shared quotas cannot form a single logical total.
+ * @export
+ * @enum {string}
+ */
+
+export const ApelocalCapacitySummaryMode = {
+    finite: 'finite',
+    unlimited: 'unlimited',
+    conflict: 'conflict'
+} as const;
+
+export type ApelocalCapacitySummaryMode = typeof ApelocalCapacitySummaryMode[keyof typeof ApelocalCapacitySummaryMode];
+
+
+

package/src/adminapi/models/apelocal-capacity-summary.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ApelocalCapacityObservations } from './apelocal-capacity-observations';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ApelocalCapacitySummaryMode } from './apelocal-capacity-summary-mode';
+
+/**
+ * Deduplicated apelocal statistics. Does not include other storage drivers. Missing measurements are omitted, never treated as zero.
+ * @export
+ * @interface ApelocalCapacitySummary
+ */
+export interface ApelocalCapacitySummary {
+    /**
+     * 
+     * @type {ApelocalCapacityObservations}
+     * @memberof ApelocalCapacitySummary
+     */
+    'observed'?: ApelocalCapacityObservations;
+    /**
+     * 
+     * @type {ApelocalCapacitySummaryMode}
+     * @memberof ApelocalCapacitySummary
+     */
+    'capacityMode'?: ApelocalCapacitySummaryMode;
+    /**
+     * Whether all required measurements for the selected capacity mode are present.
+     * @type {boolean}
+     * @memberof ApelocalCapacitySummary
+     */
+    'complete'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApelocalCapacitySummary
+     */
+    'nodeCount'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApelocalCapacitySummary
+     */
+    'unavailableNodeCount'?: number;
+    /**
+     * Physical capacity in GiB, deduplicated by backing filesystem.
+     * @type {number}
+     * @memberof ApelocalCapacitySummary
+     */
+    'physicalCapacity'?: number | null;
+    /**
+     * Physical filesystem usage in GiB, including other files.
+     * @type {number}
+     * @memberof ApelocalCapacitySummary
+     */
+    'physicalUsage'?: number | null;
+    /**
+     * Logical total in GiB; omitted for unlimited or conflicting quotas.
+     * @type {number}
+     * @memberof ApelocalCapacitySummary
+     */
+    'allocatableCapacity'?: number | null;
+    /**
+     * CSI allocated capacity in GiB, deduplicated by backing allocation resource.
+     * @type {number}
+     * @memberof ApelocalCapacitySummary
+     */
+    'allocatedCapacity'?: number | null;
+    /**
+     * Remaining logical capacity in GiB on ready schedulable nodes only.
+     * @type {number}
+     * @memberof ApelocalCapacitySummary
+     */
+    'availableCapacity'?: number | null;
+}
+
+
+

package/src/adminapi/models/apelocal-node-stats.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * apelocal-specific capacity measurements for one node. Missing measurements are omitted.
+ * @export
+ * @interface ApelocalNodeStats
+ */
+export interface ApelocalNodeStats {
+    /**
+     * Node-local backing allocation resource identity, used to deduplicate SC aliases.
+     * @type {string}
+     * @memberof ApelocalNodeStats
+     */
+    'allocationResourceID'?: string;
+    /**
+     * Node-local observed filesystem identity, used to deduplicate shared physical capacity.
+     * @type {string}
+     * @memberof ApelocalNodeStats
+     */
+    'physicalResourceID'?: string;
+    /**
+     * Observed filesystem capacity in GiB; omitted when the backing filesystem cannot be identified completely.
+     * @type {number}
+     * @memberof ApelocalNodeStats
+     */
+    'physicalCapacity'?: number | null;
+    /**
+     * Observed filesystem used bytes in GiB, including other data on the same filesystem.
+     * @type {number}
+     * @memberof ApelocalNodeStats
+     */
+    'physicalUsage'?: number | null;
+    /**
+     * CSI total allocatable capacity in GiB; omitted for unlimited capacity.
+     * @type {number}
+     * @memberof ApelocalNodeStats
+     */
+    'allocatableCapacity'?: number | null;
+    /**
+     * CSI remaining allocatable capacity in GiB; omitted for unlimited capacity.
+     * @type {number}
+     * @memberof ApelocalNodeStats
+     */
+    'availableCapacity'?: number | null;
+    /**
+     * Capacity accounted for by CSI in GiB, including shared definitions; omitted when it cannot be determined exactly.
+     * @type {number}
+     * @memberof ApelocalNodeStats
+     */
+    'allocatedCapacity'?: number | null;
+    /**
+     * Largest volume CSI can allocate on this node in GiB.
+     * @type {number}
+     * @memberof ApelocalNodeStats
+     */
+    'maximumVolumeSize'?: number | null;
+}
+

package/src/adminapi/models/apelocal-storage-class-stats.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ApelocalCapacityMode } from './apelocal-capacity-mode';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ApelocalCapacitySummary } from './apelocal-capacity-summary';
+
+/**
+ * apelocal-specific StorageClass capacity policy and measurements.
+ * @export
+ * @interface ApelocalStorageClassStats
+ */
+export interface ApelocalStorageClassStats {
+    /**
+     * 
+     * @type {ApelocalCapacitySummary}
+     * @memberof ApelocalStorageClassStats
+     */
+    'summary'?: ApelocalCapacitySummary;
+    /**
+     * Resolved apelocal HostPathDefinition name.
+     * @type {string}
+     * @memberof ApelocalStorageClassStats
+     */
+    'definitionName'?: string;
+    /**
+     * apelocal storage backend (HostDir, RawDisk or RawDiskGroup).
+     * @type {string}
+     * @memberof ApelocalStorageClassStats
+     */
+    'backendType'?: string;
+    /**
+     * 
+     * @type {ApelocalCapacityMode}
+     * @memberof ApelocalStorageClassStats
+     */
+    'capacityMode'?: ApelocalCapacityMode;
+    /**
+     * Capacity multiplier (1.2 means 120 percent).
+     * @type {number}
+     * @memberof ApelocalStorageClassStats
+     */
+    'capacityMultiplier'?: number | null;
+    /**
+     * Configured fixed capacity per node in GiB.
+     * @type {number}
+     * @memberof ApelocalStorageClassStats
+     */
+    'fixedCapacity'?: number | null;
+    /**
+     * Whether the metrics query succeeded; individual measurements can still be absent.
+     * @type {boolean}
+     * @memberof ApelocalStorageClassStats
+     */
+    'metricsAvailable'?: boolean;
+}
+
+
+

package/src/adminapi/models/index.ts

@@ -83,6 +83,13 @@ export * from './alert-strategy-mute-time-interval-times';
 export * from './alert-template';
 export * from './alert-template-list';
 export * from './alter-rule-ref';
+export * from './apelocal-capacity-mode';
+export * from './apelocal-capacity-observation';
+export * from './apelocal-capacity-observations';
+export * from './apelocal-capacity-summary';
+export * from './apelocal-capacity-summary-mode';
+export * from './apelocal-node-stats';
+export * from './apelocal-storage-class-stats';
 export * from './apikey';
 export * from './apikey-create';
 export * from './apikey-list';

package/src/adminapi/models/storage-class-node-stats-list.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ApelocalStorageClassStats } from './apelocal-storage-class-stats';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { StorageClassNodeStats } from './storage-class-node-stats';
@@ -23,6 +26,12 @@ import type { StorageClassNodeStats } from './storage-class-node-stats';
  * @interface StorageClassNodeStatsList
  */
 export interface StorageClassNodeStatsList {
+    /**
+     * 
+     * @type {ApelocalStorageClassStats}
+     * @memberof StorageClassNodeStatsList
+     */
+    'apelocal'?: ApelocalStorageClassStats;
     /**
      * the list of storage class node stats
      * @type {Array<StorageClassNodeStats>}

package/src/adminapi/models/storage-class-node-stats.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ApelocalNodeStats } from './apelocal-node-stats';
 
 /**
  * storageClassNodeStats is a storage class node stats.
@@ -20,6 +23,12 @@
  * @interface StorageClassNodeStats
  */
 export interface StorageClassNodeStats {
+    /**
+     * 
+     * @type {ApelocalNodeStats}
+     * @memberof StorageClassNodeStats
+     */
+    'apelocal'?: ApelocalNodeStats;
     /**
      * the name of the node
      * @type {string}

package/src/adminapi.yaml

@@ -11376,7 +11376,7 @@ paths:
     get:
       operationId: getEnvironmentResource
       summary: Get a live Kubernetes resource
-      description: Returns one named Kubernetes object, excluding metadata.managedFields. The code allowlist currently permits only apiVersion v1 with kind PersistentVolumeClaim; other valid resource types return 403 before Kubernetes access. Requires Admin environment read permission. Does not support lists, subresources or writes.
+      description: Returns one named Kubernetes object, excluding metadata.managedFields. The code allowlist permits v1 PersistentVolumeClaim, storage.k8s.io/v1 StorageClass and apelocal.csi.apecloud.com/v1alpha1 HostPathDefinition; other valid resource types return 403 before Kubernetes access. Requires Admin environment read permission. Does not support lists, subresources or writes.
       tags:
         - environment
       parameters:
@@ -11392,13 +11392,13 @@ paths:
             type: string
         - in: query
           name: apiVersion
-          description: Kubernetes API version. Currently only v1 with kind PersistentVolumeClaim is allowed.
+          description: Kubernetes API version. Must match an explicitly allowed storage resource kind.
           required: true
           schema:
             type: string
         - in: query
           name: kind
-          description: Kubernetes kind. Currently only PersistentVolumeClaim with apiVersion v1 is allowed.
+          description: Kubernetes kind. Allowed kinds are PersistentVolumeClaim, StorageClass and HostPathDefinition with their corresponding API versions.
           required: true
           schema:
             type: string
@@ -40898,9 +40898,179 @@ components:
           format: int64
           type: integer
       type: object
+    apelocalCapacityObservation:
+      description: A measurement over known nodes. Missing nodes are not treated as zero. Coverage counts nodes whose complete per-node inputs are known, not individual storage resources.
+      type: object
+      properties:
+        value:
+          type: number
+          format: double
+          x-nullable: true
+          description: Known-node sum in GiB or ratio in percent. Omitted when no inputs are known or a ratio denominator is zero. Ratios can exceed 100. Remaining quota is zero when there are selected nodes but none are ready.
+        observedNodeCount:
+          type: integer
+          x-omitempty: false
+          description: Number of nodes with all inputs for this measurement.
+        expectedNodeCount:
+          type: integer
+          x-omitempty: false
+          description: Number of selected nodes relevant to this measurement; only ready schedulable nodes for remaining quota.
+        missingNodes:
+          type: array
+          x-omitempty: false
+          items:
+            type: string
+          description: Sorted names of relevant nodes with missing or inconsistent inputs for this measurement.
+    apelocalCapacityObservations:
+      description: Known-node aggregates after resource deduplication. Capacity values are in GiB and ratios are percentages using only nodes with both inputs. Independent measurements can cover different nodes. Quota, remaining quota and allocation percentage objects are omitted for unlimited or conflicting policies. Remaining quota covers only ready schedulable nodes. Physical remaining is capacity minus usage from nodes with both measurements and usage not exceeding capacity; it is not a guaranteed writable or schedulable quota. Existing summary totals remain omitted when incomplete.
+      type: object
+      properties:
+        physicalCapacity:
+          $ref: '#/components/schemas/apelocalCapacityObservation'
+        physicalUsage:
+          $ref: '#/components/schemas/apelocalCapacityObservation'
+        physicalRemaining:
+          $ref: '#/components/schemas/apelocalCapacityObservation'
+        allocatedCapacity:
+          $ref: '#/components/schemas/apelocalCapacityObservation'
+        allocatableCapacity:
+          $ref: '#/components/schemas/apelocalCapacityObservation'
+        availableCapacity:
+          $ref: '#/components/schemas/apelocalCapacityObservation'
+        physicalUsagePercent:
+          $ref: '#/components/schemas/apelocalCapacityObservation'
+        allocationPercent:
+          $ref: '#/components/schemas/apelocalCapacityObservation'
+    apelocalCapacitySummaryMode:
+      type: string
+      enum:
+        - finite
+        - unlimited
+        - conflict
+      description: Conflicting shared quotas cannot form a single logical total.
+    apelocalCapacitySummary:
+      description: Deduplicated apelocal statistics. Does not include other storage drivers. Missing measurements are omitted, never treated as zero.
+      type: object
+      properties:
+        observed:
+          $ref: '#/components/schemas/apelocalCapacityObservations'
+        capacityMode:
+          $ref: '#/components/schemas/apelocalCapacitySummaryMode'
+        complete:
+          type: boolean
+          x-omitempty: false
+          description: Whether all required measurements for the selected capacity mode are present.
+        nodeCount:
+          type: integer
+          x-omitempty: false
+        unavailableNodeCount:
+          type: integer
+          x-omitempty: false
+        physicalCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: Physical capacity in GiB, deduplicated by backing filesystem.
+        physicalUsage:
+          type: number
+          format: double
+          x-nullable: true
+          description: Physical filesystem usage in GiB, including other files.
+        allocatableCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: Logical total in GiB; omitted for unlimited or conflicting quotas.
+        allocatedCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: CSI allocated capacity in GiB, deduplicated by backing allocation resource.
+        availableCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: Remaining logical capacity in GiB on ready schedulable nodes only.
+    apelocalCapacityMode:
+      type: string
+      enum:
+        - asIs
+        - multiplier
+        - fixed
+        - unlimited
+      description: CSI capacity policy; unlimited does not represent physical capacity.
+    apelocalStorageClassStats:
+      description: apelocal-specific StorageClass capacity policy and measurements.
+      type: object
+      properties:
+        summary:
+          $ref: '#/components/schemas/apelocalCapacitySummary'
+        definitionName:
+          type: string
+          description: Resolved apelocal HostPathDefinition name.
+        backendType:
+          type: string
+          description: apelocal storage backend (HostDir, RawDisk or RawDiskGroup).
+        capacityMode:
+          $ref: '#/components/schemas/apelocalCapacityMode'
+        capacityMultiplier:
+          type: number
+          format: double
+          x-nullable: true
+          description: Capacity multiplier (1.2 means 120 percent).
+        fixedCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: Configured fixed capacity per node in GiB.
+        metricsAvailable:
+          type: boolean
+          description: Whether the metrics query succeeded; individual measurements can still be absent.
+    apelocalNodeStats:
+      description: apelocal-specific capacity measurements for one node. Missing measurements are omitted.
+      type: object
+      properties:
+        allocationResourceID:
+          type: string
+          description: Node-local backing allocation resource identity, used to deduplicate SC aliases.
+        physicalResourceID:
+          type: string
+          description: Node-local observed filesystem identity, used to deduplicate shared physical capacity.
+        physicalCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: Observed filesystem capacity in GiB; omitted when the backing filesystem cannot be identified completely.
+        physicalUsage:
+          type: number
+          format: double
+          x-nullable: true
+          description: Observed filesystem used bytes in GiB, including other data on the same filesystem.
+        allocatableCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: CSI total allocatable capacity in GiB; omitted for unlimited capacity.
+        availableCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: CSI remaining allocatable capacity in GiB; omitted for unlimited capacity.
+        allocatedCapacity:
+          type: number
+          format: double
+          x-nullable: true
+          description: Capacity accounted for by CSI in GiB, including shared definitions; omitted when it cannot be determined exactly.
+        maximumVolumeSize:
+          type: number
+          format: double
+          x-nullable: true
+          description: Largest volume CSI can allocate on this node in GiB.
     storageClassNodeStats:
       description: storageClassNodeStats is a storage class node stats.
       properties:
+        apelocal:
+          $ref: '#/components/schemas/apelocalNodeStats'
         nodeName:
           description: the name of the node
           type: string
@@ -40933,6 +41103,8 @@ components:
     storageClassNodeStatsList:
       description: storageClassNodeStatsList is a list of storageClassNodeStats.
       properties:
+        apelocal:
+          $ref: '#/components/schemas/apelocalStorageClassStats'
         items:
           description: the list of storage class node stats
           type: array