@nestbox-ai/admin 1.0.47 → 1.0.48
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/.openapi-generator/FILES +3 -0
- package/README.md +8 -2
- package/api.ts +291 -0
- package/dist/api.d.ts +174 -0
- package/dist/api.js +219 -0
- package/dist/esm/api.d.ts +174 -0
- package/dist/esm/api.js +219 -0
- package/docs/BenchmarkingDatapointDto.md +22 -0
- package/docs/BenchmarkingReportsDto.md +22 -0
- package/docs/MachineInstancesApi.md +177 -0
- package/docs/MachineStatusDto.md +24 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -2632,6 +2632,105 @@ export const MachineInstancesApiAxiosParamCreator = function (configuration) {
|
|
|
2632
2632
|
options: localVarRequestOptions,
|
|
2633
2633
|
};
|
|
2634
2634
|
}),
|
|
2635
|
+
/**
|
|
2636
|
+
*
|
|
2637
|
+
* @summary Retrieve CSV benchmarking datapoints for a specific machine
|
|
2638
|
+
* @param {string} projectId
|
|
2639
|
+
* @param {string} machineId
|
|
2640
|
+
* @param {*} [options] Override http request option.
|
|
2641
|
+
* @throws {RequiredError}
|
|
2642
|
+
*/
|
|
2643
|
+
machineInstancesControllerGetMachineBenchmarkingDatapoints: (projectId_1, machineId_1, ...args_1) => __awaiter(this, [projectId_1, machineId_1, ...args_1], void 0, function* (projectId, machineId, options = {}) {
|
|
2644
|
+
// verify required parameter 'projectId' is not null or undefined
|
|
2645
|
+
assertParamExists('machineInstancesControllerGetMachineBenchmarkingDatapoints', 'projectId', projectId);
|
|
2646
|
+
// verify required parameter 'machineId' is not null or undefined
|
|
2647
|
+
assertParamExists('machineInstancesControllerGetMachineBenchmarkingDatapoints', 'machineId', machineId);
|
|
2648
|
+
const localVarPath = `/projects/{projectId}/instances/machine/{machineId}/benchmarking-datapoints`
|
|
2649
|
+
.replace(`{${"projectId"}}`, encodeURIComponent(String(projectId)))
|
|
2650
|
+
.replace(`{${"machineId"}}`, encodeURIComponent(String(machineId)));
|
|
2651
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2652
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2653
|
+
let baseOptions;
|
|
2654
|
+
if (configuration) {
|
|
2655
|
+
baseOptions = configuration.baseOptions;
|
|
2656
|
+
}
|
|
2657
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2658
|
+
const localVarHeaderParameter = {};
|
|
2659
|
+
const localVarQueryParameter = {};
|
|
2660
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2661
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2662
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2663
|
+
return {
|
|
2664
|
+
url: toPathString(localVarUrlObj),
|
|
2665
|
+
options: localVarRequestOptions,
|
|
2666
|
+
};
|
|
2667
|
+
}),
|
|
2668
|
+
/**
|
|
2669
|
+
*
|
|
2670
|
+
* @summary Retrieve benchmarking reports for a specific machine
|
|
2671
|
+
* @param {string} projectId
|
|
2672
|
+
* @param {string} machineId
|
|
2673
|
+
* @param {*} [options] Override http request option.
|
|
2674
|
+
* @throws {RequiredError}
|
|
2675
|
+
*/
|
|
2676
|
+
machineInstancesControllerGetMachineBenchmarkingReports: (projectId_1, machineId_1, ...args_1) => __awaiter(this, [projectId_1, machineId_1, ...args_1], void 0, function* (projectId, machineId, options = {}) {
|
|
2677
|
+
// verify required parameter 'projectId' is not null or undefined
|
|
2678
|
+
assertParamExists('machineInstancesControllerGetMachineBenchmarkingReports', 'projectId', projectId);
|
|
2679
|
+
// verify required parameter 'machineId' is not null or undefined
|
|
2680
|
+
assertParamExists('machineInstancesControllerGetMachineBenchmarkingReports', 'machineId', machineId);
|
|
2681
|
+
const localVarPath = `/projects/{projectId}/instances/machine/{machineId}/benchmarking-reports`
|
|
2682
|
+
.replace(`{${"projectId"}}`, encodeURIComponent(String(projectId)))
|
|
2683
|
+
.replace(`{${"machineId"}}`, encodeURIComponent(String(machineId)));
|
|
2684
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2685
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2686
|
+
let baseOptions;
|
|
2687
|
+
if (configuration) {
|
|
2688
|
+
baseOptions = configuration.baseOptions;
|
|
2689
|
+
}
|
|
2690
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2691
|
+
const localVarHeaderParameter = {};
|
|
2692
|
+
const localVarQueryParameter = {};
|
|
2693
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2694
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2695
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2696
|
+
return {
|
|
2697
|
+
url: toPathString(localVarUrlObj),
|
|
2698
|
+
options: localVarRequestOptions,
|
|
2699
|
+
};
|
|
2700
|
+
}),
|
|
2701
|
+
/**
|
|
2702
|
+
*
|
|
2703
|
+
* @summary Retrieve status of a specific machine instance
|
|
2704
|
+
* @param {string} projectId
|
|
2705
|
+
* @param {string} machineId
|
|
2706
|
+
* @param {*} [options] Override http request option.
|
|
2707
|
+
* @throws {RequiredError}
|
|
2708
|
+
*/
|
|
2709
|
+
machineInstancesControllerGetMachineBootstrapStatus: (projectId_1, machineId_1, ...args_1) => __awaiter(this, [projectId_1, machineId_1, ...args_1], void 0, function* (projectId, machineId, options = {}) {
|
|
2710
|
+
// verify required parameter 'projectId' is not null or undefined
|
|
2711
|
+
assertParamExists('machineInstancesControllerGetMachineBootstrapStatus', 'projectId', projectId);
|
|
2712
|
+
// verify required parameter 'machineId' is not null or undefined
|
|
2713
|
+
assertParamExists('machineInstancesControllerGetMachineBootstrapStatus', 'machineId', machineId);
|
|
2714
|
+
const localVarPath = `/projects/{projectId}/instances/machine/{machineId}/status`
|
|
2715
|
+
.replace(`{${"projectId"}}`, encodeURIComponent(String(projectId)))
|
|
2716
|
+
.replace(`{${"machineId"}}`, encodeURIComponent(String(machineId)));
|
|
2717
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2718
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2719
|
+
let baseOptions;
|
|
2720
|
+
if (configuration) {
|
|
2721
|
+
baseOptions = configuration.baseOptions;
|
|
2722
|
+
}
|
|
2723
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2724
|
+
const localVarHeaderParameter = {};
|
|
2725
|
+
const localVarQueryParameter = {};
|
|
2726
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2727
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2728
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2729
|
+
return {
|
|
2730
|
+
url: toPathString(localVarUrlObj),
|
|
2731
|
+
options: localVarRequestOptions,
|
|
2732
|
+
};
|
|
2733
|
+
}),
|
|
2635
2734
|
/**
|
|
2636
2735
|
*
|
|
2637
2736
|
* @summary Retrieve running status of instances
|
|
@@ -2809,6 +2908,57 @@ export const MachineInstancesApiFp = function (configuration) {
|
|
|
2809
2908
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2810
2909
|
});
|
|
2811
2910
|
},
|
|
2911
|
+
/**
|
|
2912
|
+
*
|
|
2913
|
+
* @summary Retrieve CSV benchmarking datapoints for a specific machine
|
|
2914
|
+
* @param {string} projectId
|
|
2915
|
+
* @param {string} machineId
|
|
2916
|
+
* @param {*} [options] Override http request option.
|
|
2917
|
+
* @throws {RequiredError}
|
|
2918
|
+
*/
|
|
2919
|
+
machineInstancesControllerGetMachineBenchmarkingDatapoints(projectId, machineId, options) {
|
|
2920
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2921
|
+
var _a, _b, _c;
|
|
2922
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.machineInstancesControllerGetMachineBenchmarkingDatapoints(projectId, machineId, options);
|
|
2923
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2924
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MachineInstancesApi.machineInstancesControllerGetMachineBenchmarkingDatapoints']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2925
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2926
|
+
});
|
|
2927
|
+
},
|
|
2928
|
+
/**
|
|
2929
|
+
*
|
|
2930
|
+
* @summary Retrieve benchmarking reports for a specific machine
|
|
2931
|
+
* @param {string} projectId
|
|
2932
|
+
* @param {string} machineId
|
|
2933
|
+
* @param {*} [options] Override http request option.
|
|
2934
|
+
* @throws {RequiredError}
|
|
2935
|
+
*/
|
|
2936
|
+
machineInstancesControllerGetMachineBenchmarkingReports(projectId, machineId, options) {
|
|
2937
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2938
|
+
var _a, _b, _c;
|
|
2939
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.machineInstancesControllerGetMachineBenchmarkingReports(projectId, machineId, options);
|
|
2940
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2941
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MachineInstancesApi.machineInstancesControllerGetMachineBenchmarkingReports']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2942
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2943
|
+
});
|
|
2944
|
+
},
|
|
2945
|
+
/**
|
|
2946
|
+
*
|
|
2947
|
+
* @summary Retrieve status of a specific machine instance
|
|
2948
|
+
* @param {string} projectId
|
|
2949
|
+
* @param {string} machineId
|
|
2950
|
+
* @param {*} [options] Override http request option.
|
|
2951
|
+
* @throws {RequiredError}
|
|
2952
|
+
*/
|
|
2953
|
+
machineInstancesControllerGetMachineBootstrapStatus(projectId, machineId, options) {
|
|
2954
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2955
|
+
var _a, _b, _c;
|
|
2956
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.machineInstancesControllerGetMachineBootstrapStatus(projectId, machineId, options);
|
|
2957
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2958
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MachineInstancesApi.machineInstancesControllerGetMachineBootstrapStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2959
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2960
|
+
});
|
|
2961
|
+
},
|
|
2812
2962
|
/**
|
|
2813
2963
|
*
|
|
2814
2964
|
* @summary Retrieve running status of instances
|
|
@@ -2902,6 +3052,39 @@ export const MachineInstancesApiFactory = function (configuration, basePath, axi
|
|
|
2902
3052
|
machineInstancesControllerGetInstanceRunningStatus(projectId, options) {
|
|
2903
3053
|
return localVarFp.machineInstancesControllerGetInstanceRunningStatus(projectId, options).then((request) => request(axios, basePath));
|
|
2904
3054
|
},
|
|
3055
|
+
/**
|
|
3056
|
+
*
|
|
3057
|
+
* @summary Retrieve CSV benchmarking datapoints for a specific machine
|
|
3058
|
+
* @param {string} projectId
|
|
3059
|
+
* @param {string} machineId
|
|
3060
|
+
* @param {*} [options] Override http request option.
|
|
3061
|
+
* @throws {RequiredError}
|
|
3062
|
+
*/
|
|
3063
|
+
machineInstancesControllerGetMachineBenchmarkingDatapoints(projectId, machineId, options) {
|
|
3064
|
+
return localVarFp.machineInstancesControllerGetMachineBenchmarkingDatapoints(projectId, machineId, options).then((request) => request(axios, basePath));
|
|
3065
|
+
},
|
|
3066
|
+
/**
|
|
3067
|
+
*
|
|
3068
|
+
* @summary Retrieve benchmarking reports for a specific machine
|
|
3069
|
+
* @param {string} projectId
|
|
3070
|
+
* @param {string} machineId
|
|
3071
|
+
* @param {*} [options] Override http request option.
|
|
3072
|
+
* @throws {RequiredError}
|
|
3073
|
+
*/
|
|
3074
|
+
machineInstancesControllerGetMachineBenchmarkingReports(projectId, machineId, options) {
|
|
3075
|
+
return localVarFp.machineInstancesControllerGetMachineBenchmarkingReports(projectId, machineId, options).then((request) => request(axios, basePath));
|
|
3076
|
+
},
|
|
3077
|
+
/**
|
|
3078
|
+
*
|
|
3079
|
+
* @summary Retrieve status of a specific machine instance
|
|
3080
|
+
* @param {string} projectId
|
|
3081
|
+
* @param {string} machineId
|
|
3082
|
+
* @param {*} [options] Override http request option.
|
|
3083
|
+
* @throws {RequiredError}
|
|
3084
|
+
*/
|
|
3085
|
+
machineInstancesControllerGetMachineBootstrapStatus(projectId, machineId, options) {
|
|
3086
|
+
return localVarFp.machineInstancesControllerGetMachineBootstrapStatus(projectId, machineId, options).then((request) => request(axios, basePath));
|
|
3087
|
+
},
|
|
2905
3088
|
/**
|
|
2906
3089
|
*
|
|
2907
3090
|
* @summary Retrieve running status of instances
|
|
@@ -2980,6 +3163,42 @@ export class MachineInstancesApi extends BaseAPI {
|
|
|
2980
3163
|
machineInstancesControllerGetInstanceRunningStatus(projectId, options) {
|
|
2981
3164
|
return MachineInstancesApiFp(this.configuration).machineInstancesControllerGetInstanceRunningStatus(projectId, options).then((request) => request(this.axios, this.basePath));
|
|
2982
3165
|
}
|
|
3166
|
+
/**
|
|
3167
|
+
*
|
|
3168
|
+
* @summary Retrieve CSV benchmarking datapoints for a specific machine
|
|
3169
|
+
* @param {string} projectId
|
|
3170
|
+
* @param {string} machineId
|
|
3171
|
+
* @param {*} [options] Override http request option.
|
|
3172
|
+
* @throws {RequiredError}
|
|
3173
|
+
* @memberof MachineInstancesApi
|
|
3174
|
+
*/
|
|
3175
|
+
machineInstancesControllerGetMachineBenchmarkingDatapoints(projectId, machineId, options) {
|
|
3176
|
+
return MachineInstancesApiFp(this.configuration).machineInstancesControllerGetMachineBenchmarkingDatapoints(projectId, machineId, options).then((request) => request(this.axios, this.basePath));
|
|
3177
|
+
}
|
|
3178
|
+
/**
|
|
3179
|
+
*
|
|
3180
|
+
* @summary Retrieve benchmarking reports for a specific machine
|
|
3181
|
+
* @param {string} projectId
|
|
3182
|
+
* @param {string} machineId
|
|
3183
|
+
* @param {*} [options] Override http request option.
|
|
3184
|
+
* @throws {RequiredError}
|
|
3185
|
+
* @memberof MachineInstancesApi
|
|
3186
|
+
*/
|
|
3187
|
+
machineInstancesControllerGetMachineBenchmarkingReports(projectId, machineId, options) {
|
|
3188
|
+
return MachineInstancesApiFp(this.configuration).machineInstancesControllerGetMachineBenchmarkingReports(projectId, machineId, options).then((request) => request(this.axios, this.basePath));
|
|
3189
|
+
}
|
|
3190
|
+
/**
|
|
3191
|
+
*
|
|
3192
|
+
* @summary Retrieve status of a specific machine instance
|
|
3193
|
+
* @param {string} projectId
|
|
3194
|
+
* @param {string} machineId
|
|
3195
|
+
* @param {*} [options] Override http request option.
|
|
3196
|
+
* @throws {RequiredError}
|
|
3197
|
+
* @memberof MachineInstancesApi
|
|
3198
|
+
*/
|
|
3199
|
+
machineInstancesControllerGetMachineBootstrapStatus(projectId, machineId, options) {
|
|
3200
|
+
return MachineInstancesApiFp(this.configuration).machineInstancesControllerGetMachineBootstrapStatus(projectId, machineId, options).then((request) => request(this.axios, this.basePath));
|
|
3201
|
+
}
|
|
2983
3202
|
/**
|
|
2984
3203
|
*
|
|
2985
3204
|
* @summary Retrieve running status of instances
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BenchmarkingDatapointDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**lines** | **string** | Combined content of all benchmarking lines | [default to undefined]
|
|
9
|
+
**totalLines** | **number** | Total number of lines found | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BenchmarkingDatapointDto } from '@nestbox-ai/admin';
|
|
15
|
+
|
|
16
|
+
const instance: BenchmarkingDatapointDto = {
|
|
17
|
+
lines,
|
|
18
|
+
totalLines,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BenchmarkingReportsDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | **string** | Combined markdown content of all benchmarking reports | [default to undefined]
|
|
9
|
+
**totalReports** | **number** | Total number of reports found | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BenchmarkingReportsDto } from '@nestbox-ai/admin';
|
|
15
|
+
|
|
16
|
+
const instance: BenchmarkingReportsDto = {
|
|
17
|
+
content,
|
|
18
|
+
totalReports,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,6 +7,9 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**machineInstancesControllerCreateMachineInstance**](#machineinstancescontrollercreatemachineinstance) | **POST** /projects/{projectId}/instances | Create Machine Instance|
|
|
8
8
|
|[**machineInstancesControllerDeleteMachineInstance**](#machineinstancescontrollerdeletemachineinstance) | **DELETE** /projects/{projectId}/instances | Delete machine instances by ids|
|
|
9
9
|
|[**machineInstancesControllerGetInstanceRunningStatus**](#machineinstancescontrollergetinstancerunningstatus) | **GET** /projects/{projectId}/instances/status | Retrieve running status of instances|
|
|
10
|
+
|[**machineInstancesControllerGetMachineBenchmarkingDatapoints**](#machineinstancescontrollergetmachinebenchmarkingdatapoints) | **GET** /projects/{projectId}/instances/machine/{machineId}/benchmarking-datapoints | Retrieve CSV benchmarking datapoints for a specific machine|
|
|
11
|
+
|[**machineInstancesControllerGetMachineBenchmarkingReports**](#machineinstancescontrollergetmachinebenchmarkingreports) | **GET** /projects/{projectId}/instances/machine/{machineId}/benchmarking-reports | Retrieve benchmarking reports for a specific machine|
|
|
12
|
+
|[**machineInstancesControllerGetMachineBootstrapStatus**](#machineinstancescontrollergetmachinebootstrapstatus) | **GET** /projects/{projectId}/instances/machine/{machineId}/status | Retrieve status of a specific machine instance|
|
|
10
13
|
|[**machineInstancesControllerGetMachineInstanceById**](#machineinstancescontrollergetmachineinstancebyid) | **GET** /projects/{projectId}/instances/machine/{machineId} | Retrieve running status of instances|
|
|
11
14
|
|[**machineInstancesControllerGetMachineInstanceByUserId**](#machineinstancescontrollergetmachineinstancebyuserid) | **GET** /projects/{projectId}/instances | Retrieve all machine instances with count|
|
|
12
15
|
|[**machineInstancesControllerUpdateRunningStatus**](#machineinstancescontrollerupdaterunningstatus) | **PUT** /projects/{projectId}/instances/status | Update Machine Instance Running Status|
|
|
@@ -164,6 +167,180 @@ No authorization required
|
|
|
164
167
|
- **Accept**: application/json
|
|
165
168
|
|
|
166
169
|
|
|
170
|
+
### HTTP response details
|
|
171
|
+
| Status code | Description | Response headers |
|
|
172
|
+
|-------------|-------------|------------------|
|
|
173
|
+
|**200** | | - |
|
|
174
|
+
|**400** | | - |
|
|
175
|
+
|**401** | | - |
|
|
176
|
+
|**403** | | - |
|
|
177
|
+
|**404** | | - |
|
|
178
|
+
|**500** | | - |
|
|
179
|
+
|
|
180
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
181
|
+
|
|
182
|
+
# **machineInstancesControllerGetMachineBenchmarkingDatapoints**
|
|
183
|
+
> BenchmarkingDatapointDto machineInstancesControllerGetMachineBenchmarkingDatapoints()
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
import {
|
|
190
|
+
MachineInstancesApi,
|
|
191
|
+
Configuration
|
|
192
|
+
} from '@nestbox-ai/admin';
|
|
193
|
+
|
|
194
|
+
const configuration = new Configuration();
|
|
195
|
+
const apiInstance = new MachineInstancesApi(configuration);
|
|
196
|
+
|
|
197
|
+
let projectId: string; // (default to undefined)
|
|
198
|
+
let machineId: string; // (default to undefined)
|
|
199
|
+
|
|
200
|
+
const { status, data } = await apiInstance.machineInstancesControllerGetMachineBenchmarkingDatapoints(
|
|
201
|
+
projectId,
|
|
202
|
+
machineId
|
|
203
|
+
);
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
|Name | Type | Description | Notes|
|
|
209
|
+
|------------- | ------------- | ------------- | -------------|
|
|
210
|
+
| **projectId** | [**string**] | | defaults to undefined|
|
|
211
|
+
| **machineId** | [**string**] | | defaults to undefined|
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
### Return type
|
|
215
|
+
|
|
216
|
+
**BenchmarkingDatapointDto**
|
|
217
|
+
|
|
218
|
+
### Authorization
|
|
219
|
+
|
|
220
|
+
No authorization required
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: Not defined
|
|
225
|
+
- **Accept**: application/json
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
### HTTP response details
|
|
229
|
+
| Status code | Description | Response headers |
|
|
230
|
+
|-------------|-------------|------------------|
|
|
231
|
+
|**200** | | - |
|
|
232
|
+
|**400** | | - |
|
|
233
|
+
|**401** | | - |
|
|
234
|
+
|**403** | | - |
|
|
235
|
+
|**404** | | - |
|
|
236
|
+
|**500** | | - |
|
|
237
|
+
|
|
238
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
239
|
+
|
|
240
|
+
# **machineInstancesControllerGetMachineBenchmarkingReports**
|
|
241
|
+
> BenchmarkingReportsDto machineInstancesControllerGetMachineBenchmarkingReports()
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
### Example
|
|
245
|
+
|
|
246
|
+
```typescript
|
|
247
|
+
import {
|
|
248
|
+
MachineInstancesApi,
|
|
249
|
+
Configuration
|
|
250
|
+
} from '@nestbox-ai/admin';
|
|
251
|
+
|
|
252
|
+
const configuration = new Configuration();
|
|
253
|
+
const apiInstance = new MachineInstancesApi(configuration);
|
|
254
|
+
|
|
255
|
+
let projectId: string; // (default to undefined)
|
|
256
|
+
let machineId: string; // (default to undefined)
|
|
257
|
+
|
|
258
|
+
const { status, data } = await apiInstance.machineInstancesControllerGetMachineBenchmarkingReports(
|
|
259
|
+
projectId,
|
|
260
|
+
machineId
|
|
261
|
+
);
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Parameters
|
|
265
|
+
|
|
266
|
+
|Name | Type | Description | Notes|
|
|
267
|
+
|------------- | ------------- | ------------- | -------------|
|
|
268
|
+
| **projectId** | [**string**] | | defaults to undefined|
|
|
269
|
+
| **machineId** | [**string**] | | defaults to undefined|
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
### Return type
|
|
273
|
+
|
|
274
|
+
**BenchmarkingReportsDto**
|
|
275
|
+
|
|
276
|
+
### Authorization
|
|
277
|
+
|
|
278
|
+
No authorization required
|
|
279
|
+
|
|
280
|
+
### HTTP request headers
|
|
281
|
+
|
|
282
|
+
- **Content-Type**: Not defined
|
|
283
|
+
- **Accept**: application/json
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
### HTTP response details
|
|
287
|
+
| Status code | Description | Response headers |
|
|
288
|
+
|-------------|-------------|------------------|
|
|
289
|
+
|**200** | | - |
|
|
290
|
+
|**400** | | - |
|
|
291
|
+
|**401** | | - |
|
|
292
|
+
|**403** | | - |
|
|
293
|
+
|**404** | | - |
|
|
294
|
+
|**500** | | - |
|
|
295
|
+
|
|
296
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
297
|
+
|
|
298
|
+
# **machineInstancesControllerGetMachineBootstrapStatus**
|
|
299
|
+
> MachineStatusDto machineInstancesControllerGetMachineBootstrapStatus()
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
### Example
|
|
303
|
+
|
|
304
|
+
```typescript
|
|
305
|
+
import {
|
|
306
|
+
MachineInstancesApi,
|
|
307
|
+
Configuration
|
|
308
|
+
} from '@nestbox-ai/admin';
|
|
309
|
+
|
|
310
|
+
const configuration = new Configuration();
|
|
311
|
+
const apiInstance = new MachineInstancesApi(configuration);
|
|
312
|
+
|
|
313
|
+
let projectId: string; // (default to undefined)
|
|
314
|
+
let machineId: string; // (default to undefined)
|
|
315
|
+
|
|
316
|
+
const { status, data } = await apiInstance.machineInstancesControllerGetMachineBootstrapStatus(
|
|
317
|
+
projectId,
|
|
318
|
+
machineId
|
|
319
|
+
);
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
### Parameters
|
|
323
|
+
|
|
324
|
+
|Name | Type | Description | Notes|
|
|
325
|
+
|------------- | ------------- | ------------- | -------------|
|
|
326
|
+
| **projectId** | [**string**] | | defaults to undefined|
|
|
327
|
+
| **machineId** | [**string**] | | defaults to undefined|
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### Return type
|
|
331
|
+
|
|
332
|
+
**MachineStatusDto**
|
|
333
|
+
|
|
334
|
+
### Authorization
|
|
335
|
+
|
|
336
|
+
No authorization required
|
|
337
|
+
|
|
338
|
+
### HTTP request headers
|
|
339
|
+
|
|
340
|
+
- **Content-Type**: Not defined
|
|
341
|
+
- **Accept**: application/json
|
|
342
|
+
|
|
343
|
+
|
|
167
344
|
### HTTP response details
|
|
168
345
|
| Status code | Description | Response headers |
|
|
169
346
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MachineStatusDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | Current status of the machine instance | [default to undefined]
|
|
9
|
+
**logs** | **string** | Logs from the machine instance execution | [default to undefined]
|
|
10
|
+
**timeStamp** | **string** | Timestamp of the status update | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MachineStatusDto } from '@nestbox-ai/admin';
|
|
16
|
+
|
|
17
|
+
const instance: MachineStatusDto = {
|
|
18
|
+
status,
|
|
19
|
+
logs,
|
|
20
|
+
timeStamp,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|