kb-cloud-client-typescript 2.3.56 → 2.3.58

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

@@ -0,0 +1,33 @@
+/* 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.
+ */
+
+
+
+/**
+ * CSI capacity policy; unlimited does not represent physical capacity.
+ * @export
+ * @enum {string}
+ */
+
+export const ApelocalCapacityMode = {
+    asIs: 'asIs',
+    multiplier: 'multiplier',
+    fixed: 'fixed',
+    unlimited: 'unlimited'
+} as const;
+
+export type ApelocalCapacityMode = typeof ApelocalCapacityMode[keyof typeof ApelocalCapacityMode];
+
+
+

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

@@ -0,0 +1,48 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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.
+ * @export
+ * @interface ApelocalCapacityObservation
+ */
+export interface ApelocalCapacityObservation {
+    /**
+     * 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.
+     * @type {number}
+     * @memberof ApelocalCapacityObservation
+     */
+    'value'?: number | null;
+    /**
+     * Number of nodes with all inputs for this measurement.
+     * @type {number}
+     * @memberof ApelocalCapacityObservation
+     */
+    'observedNodeCount'?: number;
+    /**
+     * Number of selected nodes relevant to this measurement; only ready schedulable nodes for remaining quota.
+     * @type {number}
+     * @memberof ApelocalCapacityObservation
+     */
+    'expectedNodeCount'?: number;
+    /**
+     * Sorted names of relevant nodes with missing or inconsistent inputs for this measurement.
+     * @type {Array<string>}
+     * @memberof ApelocalCapacityObservation
+     */
+    'missingNodes'?: Array<string>;
+}
+

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/dolphin-dbcapabilities.ts

@@ -0,0 +1,39 @@
+/* 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 { DolphinDBPrivilegeCapability } from './dolphin-dbprivilege-capability';
+
+/**
+ * 
+ * @export
+ * @interface DolphinDBCapabilities
+ */
+export interface DolphinDBCapabilities {
+    /**
+     * 
+     * @type {string}
+     * @memberof DolphinDBCapabilities
+     */
+    'engineVersion': string;
+    /**
+     * 
+     * @type {Array<DolphinDBPrivilegeCapability>}
+     * @memberof DolphinDBCapabilities
+     */
+    'privileges': Array<DolphinDBPrivilegeCapability>;
+}
+

package/src/adminapi/models/dolphin-dbgroup-create.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DolphinDBGroupCreate
+ */
+export interface DolphinDBGroupCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof DolphinDBGroupCreate
+     */
+    'name': string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DolphinDBGroupCreate
+     */
+    'members'?: Array<string>;
+}
+

package/src/adminapi/models/dolphin-dbgroup-permissions.ts

@@ -0,0 +1,39 @@
+/* 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 { DolphinDBPermissionState } from './dolphin-dbpermission-state';
+
+/**
+ * 
+ * @export
+ * @interface DolphinDBGroupPermissions
+ */
+export interface DolphinDBGroupPermissions {
+    /**
+     * 
+     * @type {string}
+     * @memberof DolphinDBGroupPermissions
+     */
+    'group': string;
+    /**
+     * 
+     * @type {Array<DolphinDBPermissionState>}
+     * @memberof DolphinDBGroupPermissions
+     */
+    'permissions': Array<DolphinDBPermissionState>;
+}
+

package/src/adminapi/models/dolphin-dbgroup.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DolphinDBGroup
+ */
+export interface DolphinDBGroup {
+    /**
+     * 
+     * @type {string}
+     * @memberof DolphinDBGroup
+     */
+    'name': string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DolphinDBGroup
+     */
+    'members': Array<string>;
+}
+

package/src/adminapi/models/dolphin-dbmembership-change.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DolphinDBMembershipChange
+ */
+export interface DolphinDBMembershipChange {
+    /**
+     * add or remove; incremental, preserves other memberships.
+     * @type {string}
+     * @memberof DolphinDBMembershipChange
+     */
+    'action': string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DolphinDBMembershipChange
+     */
+    'users': Array<string>;
+}
+

package/src/adminapi/models/dolphin-dbpassword-change.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DolphinDBPasswordChange
+ */
+export interface DolphinDBPasswordChange {
+    /**
+     * New password. Never returned in responses.
+     * @type {string}
+     * @memberof DolphinDBPasswordChange
+     */
+    'password': string;
+}
+

package/src/adminapi/models/dolphin-dbpermission-change.ts

@@ -0,0 +1,48 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DolphinDBPermissionChange
+ */
+export interface DolphinDBPermissionChange {
+    /**
+     * grant, deny or revoke. Revoke clears the direct setting; it does not deny inherited access.
+     * @type {string}
+     * @memberof DolphinDBPermissionChange
+     */
+    'action': string;
+    /**
+     * Native privilege name from capabilities.
+     * @type {string}
+     * @memberof DolphinDBPermissionChange
+     */
+    'privilege': string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DolphinDBPermissionChange
+     */
+    'objects'?: Array<string>;
+    /**
+     * Numeric quota value; only for grant of quota privileges.
+     * @type {number}
+     * @memberof DolphinDBPermissionChange
+     */
+    'value'?: number;
+}
+