@nexgencloud/hyperstack-sdk-typescript 1.48.0-alpha → 1.50.0-alpha
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/README.md +2 -2
- package/api.ts +237 -14
- package/dist/api.d.ts +184 -8
- package/dist/api.js +96 -14
- package/dist/esm/api.d.ts +184 -8
- package/dist/esm/api.js +96 -14
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1556,6 +1556,43 @@ export interface CommonResponseModel {
|
|
|
1556
1556
|
*/
|
|
1557
1557
|
'status'?: boolean;
|
|
1558
1558
|
}
|
|
1559
|
+
/**
|
|
1560
|
+
*
|
|
1561
|
+
* @export
|
|
1562
|
+
* @interface CompatibleFlavor
|
|
1563
|
+
*/
|
|
1564
|
+
export interface CompatibleFlavor {
|
|
1565
|
+
/**
|
|
1566
|
+
* JSON constraints object
|
|
1567
|
+
* @type {object}
|
|
1568
|
+
* @memberof CompatibleFlavor
|
|
1569
|
+
*/
|
|
1570
|
+
'constraints'?: object;
|
|
1571
|
+
/**
|
|
1572
|
+
*
|
|
1573
|
+
* @type {number}
|
|
1574
|
+
* @memberof CompatibleFlavor
|
|
1575
|
+
*/
|
|
1576
|
+
'flavor_id'?: number;
|
|
1577
|
+
/**
|
|
1578
|
+
*
|
|
1579
|
+
* @type {string}
|
|
1580
|
+
* @memberof CompatibleFlavor
|
|
1581
|
+
*/
|
|
1582
|
+
'flavor_name'?: string;
|
|
1583
|
+
/**
|
|
1584
|
+
* Either \'hard\' or \'soft\'
|
|
1585
|
+
* @type {string}
|
|
1586
|
+
* @memberof CompatibleFlavor
|
|
1587
|
+
*/
|
|
1588
|
+
'link_type'?: string;
|
|
1589
|
+
/**
|
|
1590
|
+
*
|
|
1591
|
+
* @type {string}
|
|
1592
|
+
* @memberof CompatibleFlavor
|
|
1593
|
+
*/
|
|
1594
|
+
'reason'?: string;
|
|
1595
|
+
}
|
|
1559
1596
|
/**
|
|
1560
1597
|
*
|
|
1561
1598
|
* @export
|
|
@@ -3687,6 +3724,31 @@ export interface FlavorObjectFields {
|
|
|
3687
3724
|
*/
|
|
3688
3725
|
'ram'?: number;
|
|
3689
3726
|
}
|
|
3727
|
+
/**
|
|
3728
|
+
*
|
|
3729
|
+
* @export
|
|
3730
|
+
* @interface FlavorRestrictions
|
|
3731
|
+
*/
|
|
3732
|
+
export interface FlavorRestrictions {
|
|
3733
|
+
/**
|
|
3734
|
+
* List of compatible flavors with their link metadata
|
|
3735
|
+
* @type {Array<CompatibleFlavor>}
|
|
3736
|
+
* @memberof FlavorRestrictions
|
|
3737
|
+
*/
|
|
3738
|
+
'compatible_flavors'?: Array<CompatibleFlavor>;
|
|
3739
|
+
/**
|
|
3740
|
+
* Whether the image has any flavor restrictions
|
|
3741
|
+
* @type {boolean}
|
|
3742
|
+
* @memberof FlavorRestrictions
|
|
3743
|
+
*/
|
|
3744
|
+
'has_flavor_restrictions'?: boolean;
|
|
3745
|
+
/**
|
|
3746
|
+
* Either \'hard\', \'soft\', or null if no restrictions
|
|
3747
|
+
* @type {string}
|
|
3748
|
+
* @memberof FlavorRestrictions
|
|
3749
|
+
*/
|
|
3750
|
+
'restriction_type'?: string;
|
|
3751
|
+
}
|
|
3690
3752
|
/**
|
|
3691
3753
|
*
|
|
3692
3754
|
* @export
|
|
@@ -4137,6 +4199,12 @@ export interface ImageFields {
|
|
|
4137
4199
|
* @memberof ImageFields
|
|
4138
4200
|
*/
|
|
4139
4201
|
'display_size'?: string;
|
|
4202
|
+
/**
|
|
4203
|
+
* Flavor compatibility restrictions for this image
|
|
4204
|
+
* @type {FlavorRestrictions}
|
|
4205
|
+
* @memberof ImageFields
|
|
4206
|
+
*/
|
|
4207
|
+
'flavor_restrictions'?: FlavorRestrictions;
|
|
4140
4208
|
/**
|
|
4141
4209
|
*
|
|
4142
4210
|
* @type {number}
|
|
@@ -9383,6 +9451,55 @@ export interface UsersInfoListResponse {
|
|
|
9383
9451
|
*/
|
|
9384
9452
|
'users_info'?: UsersInfoFields;
|
|
9385
9453
|
}
|
|
9454
|
+
/**
|
|
9455
|
+
*
|
|
9456
|
+
* @export
|
|
9457
|
+
* @interface VMQuota
|
|
9458
|
+
*/
|
|
9459
|
+
export interface VMQuota {
|
|
9460
|
+
/**
|
|
9461
|
+
*
|
|
9462
|
+
* @type {number}
|
|
9463
|
+
* @memberof VMQuota
|
|
9464
|
+
*/
|
|
9465
|
+
'available_vms'?: number;
|
|
9466
|
+
/**
|
|
9467
|
+
*
|
|
9468
|
+
* @type {string}
|
|
9469
|
+
* @memberof VMQuota
|
|
9470
|
+
*/
|
|
9471
|
+
'cidr'?: string;
|
|
9472
|
+
/**
|
|
9473
|
+
*
|
|
9474
|
+
* @type {number}
|
|
9475
|
+
* @memberof VMQuota
|
|
9476
|
+
*/
|
|
9477
|
+
'current_vms'?: number;
|
|
9478
|
+
/**
|
|
9479
|
+
*
|
|
9480
|
+
* @type {number}
|
|
9481
|
+
* @memberof VMQuota
|
|
9482
|
+
*/
|
|
9483
|
+
'max_vms'?: number;
|
|
9484
|
+
/**
|
|
9485
|
+
*
|
|
9486
|
+
* @type {string}
|
|
9487
|
+
* @memberof VMQuota
|
|
9488
|
+
*/
|
|
9489
|
+
'message'?: string;
|
|
9490
|
+
/**
|
|
9491
|
+
*
|
|
9492
|
+
* @type {number}
|
|
9493
|
+
* @memberof VMQuota
|
|
9494
|
+
*/
|
|
9495
|
+
'percentage_used'?: number;
|
|
9496
|
+
/**
|
|
9497
|
+
*
|
|
9498
|
+
* @type {boolean}
|
|
9499
|
+
* @memberof VMQuota
|
|
9500
|
+
*/
|
|
9501
|
+
'status'?: boolean;
|
|
9502
|
+
}
|
|
9386
9503
|
/**
|
|
9387
9504
|
*
|
|
9388
9505
|
* @export
|
|
@@ -9825,6 +9942,24 @@ export interface Voucher {
|
|
|
9825
9942
|
* @memberof Voucher
|
|
9826
9943
|
*/
|
|
9827
9944
|
'id': number;
|
|
9945
|
+
/**
|
|
9946
|
+
* Max redemption count for a General Voucher
|
|
9947
|
+
* @type {number}
|
|
9948
|
+
* @memberof Voucher
|
|
9949
|
+
*/
|
|
9950
|
+
'max_redemption_count'?: number;
|
|
9951
|
+
/**
|
|
9952
|
+
* Current redemption count for a General Voucher
|
|
9953
|
+
* @type {number}
|
|
9954
|
+
* @memberof Voucher
|
|
9955
|
+
*/
|
|
9956
|
+
'redemption_count'?: number;
|
|
9957
|
+
/**
|
|
9958
|
+
* Remaining redemptions
|
|
9959
|
+
* @type {number}
|
|
9960
|
+
* @memberof Voucher
|
|
9961
|
+
*/
|
|
9962
|
+
'remaining_redemptions'?: number;
|
|
9828
9963
|
/**
|
|
9829
9964
|
* Voucher status
|
|
9830
9965
|
* @type {string}
|
|
@@ -13926,6 +14061,14 @@ export declare const EnvironmentApiAxiosParamCreator: (configuration?: Configura
|
|
|
13926
14061
|
* @throws {RequiredError}
|
|
13927
14062
|
*/
|
|
13928
14063
|
getEnvironment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14064
|
+
/**
|
|
14065
|
+
* Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
|
|
14066
|
+
* @summary Get environment VM quota
|
|
14067
|
+
* @param {number} id
|
|
14068
|
+
* @param {*} [options] Override http request option.
|
|
14069
|
+
* @throws {RequiredError}
|
|
14070
|
+
*/
|
|
14071
|
+
getEnvironmentVMQuota: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13929
14072
|
/**
|
|
13930
14073
|
* Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
|
|
13931
14074
|
* @summary List environments
|
|
@@ -13983,6 +14126,14 @@ export declare const EnvironmentApiFp: (configuration?: Configuration) => {
|
|
|
13983
14126
|
* @throws {RequiredError}
|
|
13984
14127
|
*/
|
|
13985
14128
|
getEnvironment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Environment>>;
|
|
14129
|
+
/**
|
|
14130
|
+
* Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
|
|
14131
|
+
* @summary Get environment VM quota
|
|
14132
|
+
* @param {number} id
|
|
14133
|
+
* @param {*} [options] Override http request option.
|
|
14134
|
+
* @throws {RequiredError}
|
|
14135
|
+
*/
|
|
14136
|
+
getEnvironmentVMQuota(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VMQuota>>;
|
|
13986
14137
|
/**
|
|
13987
14138
|
* Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
|
|
13988
14139
|
* @summary List environments
|
|
@@ -14040,6 +14191,14 @@ export declare const EnvironmentApiFactory: (configuration?: Configuration, base
|
|
|
14040
14191
|
* @throws {RequiredError}
|
|
14041
14192
|
*/
|
|
14042
14193
|
getEnvironment(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Environment>;
|
|
14194
|
+
/**
|
|
14195
|
+
* Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
|
|
14196
|
+
* @summary Get environment VM quota
|
|
14197
|
+
* @param {number} id
|
|
14198
|
+
* @param {*} [options] Override http request option.
|
|
14199
|
+
* @throws {RequiredError}
|
|
14200
|
+
*/
|
|
14201
|
+
getEnvironmentVMQuota(id: number, options?: RawAxiosRequestConfig): AxiosPromise<VMQuota>;
|
|
14043
14202
|
/**
|
|
14044
14203
|
* Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
|
|
14045
14204
|
* @summary List environments
|
|
@@ -14103,6 +14262,15 @@ export declare class EnvironmentApi extends BaseAPI {
|
|
|
14103
14262
|
* @memberof EnvironmentApi
|
|
14104
14263
|
*/
|
|
14105
14264
|
getEnvironment(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Environment, any, {}>>;
|
|
14265
|
+
/**
|
|
14266
|
+
* Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
|
|
14267
|
+
* @summary Get environment VM quota
|
|
14268
|
+
* @param {number} id
|
|
14269
|
+
* @param {*} [options] Override http request option.
|
|
14270
|
+
* @throws {RequiredError}
|
|
14271
|
+
* @memberof EnvironmentApi
|
|
14272
|
+
*/
|
|
14273
|
+
getEnvironmentVMQuota(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VMQuota, any, {}>>;
|
|
14106
14274
|
/**
|
|
14107
14275
|
* Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
|
|
14108
14276
|
* @summary List environments
|
|
@@ -17099,10 +17267,11 @@ export declare const VirtualMachineApiAxiosParamCreator: (configuration?: Config
|
|
|
17099
17267
|
* Check if a Virtual Machine name is available
|
|
17100
17268
|
* @summary Fetch virtual machine name availability
|
|
17101
17269
|
* @param {string} name
|
|
17270
|
+
* @param {string} [count] Nr of instances to handle (optional, default: 1)
|
|
17102
17271
|
* @param {*} [options] Override http request option.
|
|
17103
17272
|
* @throws {RequiredError}
|
|
17104
17273
|
*/
|
|
17105
|
-
checkVMNameAvailability: (name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17274
|
+
checkVMNameAvailability: (name: string, count?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17106
17275
|
/**
|
|
17107
17276
|
* Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vm-firewall-rules/add-firewall-rule-to-vm).
|
|
17108
17277
|
* @summary Add firewall rule to virtual machine
|
|
@@ -17208,10 +17377,11 @@ export declare const VirtualMachineApiAxiosParamCreator: (configuration?: Config
|
|
|
17208
17377
|
* @param {string} [search]
|
|
17209
17378
|
* @param {string} [environment]
|
|
17210
17379
|
* @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
|
|
17380
|
+
* @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
|
|
17211
17381
|
* @param {*} [options] Override http request option.
|
|
17212
17382
|
* @throws {RequiredError}
|
|
17213
17383
|
*/
|
|
17214
|
-
listVMs: (page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17384
|
+
listVMs: (page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, exactEnvironmentMatch?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17215
17385
|
/**
|
|
17216
17386
|
* Request console logs for a virtual machine
|
|
17217
17387
|
* @summary Request virtual machine logs
|
|
@@ -17282,10 +17452,11 @@ export declare const VirtualMachineApiFp: (configuration?: Configuration) => {
|
|
|
17282
17452
|
* Check if a Virtual Machine name is available
|
|
17283
17453
|
* @summary Fetch virtual machine name availability
|
|
17284
17454
|
* @param {string} name
|
|
17455
|
+
* @param {string} [count] Nr of instances to handle (optional, default: 1)
|
|
17285
17456
|
* @param {*} [options] Override http request option.
|
|
17286
17457
|
* @throws {RequiredError}
|
|
17287
17458
|
*/
|
|
17288
|
-
checkVMNameAvailability(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameAvailableModel>>;
|
|
17459
|
+
checkVMNameAvailability(name: string, count?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameAvailableModel>>;
|
|
17289
17460
|
/**
|
|
17290
17461
|
* Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vm-firewall-rules/add-firewall-rule-to-vm).
|
|
17291
17462
|
* @summary Add firewall rule to virtual machine
|
|
@@ -17391,10 +17562,11 @@ export declare const VirtualMachineApiFp: (configuration?: Configuration) => {
|
|
|
17391
17562
|
* @param {string} [search]
|
|
17392
17563
|
* @param {string} [environment]
|
|
17393
17564
|
* @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
|
|
17565
|
+
* @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
|
|
17394
17566
|
* @param {*} [options] Override http request option.
|
|
17395
17567
|
* @throws {RequiredError}
|
|
17396
17568
|
*/
|
|
17397
|
-
listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Instances>>;
|
|
17569
|
+
listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, exactEnvironmentMatch?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Instances>>;
|
|
17398
17570
|
/**
|
|
17399
17571
|
* Request console logs for a virtual machine
|
|
17400
17572
|
* @summary Request virtual machine logs
|
|
@@ -17465,10 +17637,11 @@ export declare const VirtualMachineApiFactory: (configuration?: Configuration, b
|
|
|
17465
17637
|
* Check if a Virtual Machine name is available
|
|
17466
17638
|
* @summary Fetch virtual machine name availability
|
|
17467
17639
|
* @param {string} name
|
|
17640
|
+
* @param {string} [count] Nr of instances to handle (optional, default: 1)
|
|
17468
17641
|
* @param {*} [options] Override http request option.
|
|
17469
17642
|
* @throws {RequiredError}
|
|
17470
17643
|
*/
|
|
17471
|
-
checkVMNameAvailability(name: string, options?: RawAxiosRequestConfig): AxiosPromise<NameAvailableModel>;
|
|
17644
|
+
checkVMNameAvailability(name: string, count?: string, options?: RawAxiosRequestConfig): AxiosPromise<NameAvailableModel>;
|
|
17472
17645
|
/**
|
|
17473
17646
|
* Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vm-firewall-rules/add-firewall-rule-to-vm).
|
|
17474
17647
|
* @summary Add firewall rule to virtual machine
|
|
@@ -17574,10 +17747,11 @@ export declare const VirtualMachineApiFactory: (configuration?: Configuration, b
|
|
|
17574
17747
|
* @param {string} [search]
|
|
17575
17748
|
* @param {string} [environment]
|
|
17576
17749
|
* @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
|
|
17750
|
+
* @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
|
|
17577
17751
|
* @param {*} [options] Override http request option.
|
|
17578
17752
|
* @throws {RequiredError}
|
|
17579
17753
|
*/
|
|
17580
|
-
listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, options?: RawAxiosRequestConfig): AxiosPromise<Instances>;
|
|
17754
|
+
listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, exactEnvironmentMatch?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Instances>;
|
|
17581
17755
|
/**
|
|
17582
17756
|
* Request console logs for a virtual machine
|
|
17583
17757
|
* @summary Request virtual machine logs
|
|
@@ -17652,11 +17826,12 @@ export declare class VirtualMachineApi extends BaseAPI {
|
|
|
17652
17826
|
* Check if a Virtual Machine name is available
|
|
17653
17827
|
* @summary Fetch virtual machine name availability
|
|
17654
17828
|
* @param {string} name
|
|
17829
|
+
* @param {string} [count] Nr of instances to handle (optional, default: 1)
|
|
17655
17830
|
* @param {*} [options] Override http request option.
|
|
17656
17831
|
* @throws {RequiredError}
|
|
17657
17832
|
* @memberof VirtualMachineApi
|
|
17658
17833
|
*/
|
|
17659
|
-
checkVMNameAvailability(name: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NameAvailableModel, any, {}>>;
|
|
17834
|
+
checkVMNameAvailability(name: string, count?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NameAvailableModel, any, {}>>;
|
|
17660
17835
|
/**
|
|
17661
17836
|
* Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vm-firewall-rules/add-firewall-rule-to-vm).
|
|
17662
17837
|
* @summary Add firewall rule to virtual machine
|
|
@@ -17773,11 +17948,12 @@ export declare class VirtualMachineApi extends BaseAPI {
|
|
|
17773
17948
|
* @param {string} [search]
|
|
17774
17949
|
* @param {string} [environment]
|
|
17775
17950
|
* @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
|
|
17951
|
+
* @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
|
|
17776
17952
|
* @param {*} [options] Override http request option.
|
|
17777
17953
|
* @throws {RequiredError}
|
|
17778
17954
|
* @memberof VirtualMachineApi
|
|
17779
17955
|
*/
|
|
17780
|
-
listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Instances, any, {}>>;
|
|
17956
|
+
listVMs(page?: number, pageSize?: number, search?: string, environment?: string, excludeFirewalls?: Array<number>, exactEnvironmentMatch?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Instances, any, {}>>;
|
|
17781
17957
|
/**
|
|
17782
17958
|
* Request console logs for a virtual machine
|
|
17783
17959
|
* @summary Request virtual machine logs
|
package/dist/api.js
CHANGED
|
@@ -8183,6 +8183,37 @@ const EnvironmentApiAxiosParamCreator = function (configuration) {
|
|
|
8183
8183
|
options: localVarRequestOptions,
|
|
8184
8184
|
};
|
|
8185
8185
|
}),
|
|
8186
|
+
/**
|
|
8187
|
+
* Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
|
|
8188
|
+
* @summary Get environment VM quota
|
|
8189
|
+
* @param {number} id
|
|
8190
|
+
* @param {*} [options] Override http request option.
|
|
8191
|
+
* @throws {RequiredError}
|
|
8192
|
+
*/
|
|
8193
|
+
getEnvironmentVMQuota: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
8194
|
+
// verify required parameter 'id' is not null or undefined
|
|
8195
|
+
(0, common_1.assertParamExists)('getEnvironmentVMQuota', 'id', id);
|
|
8196
|
+
const localVarPath = `/core/environments/{id}/vm-quota`
|
|
8197
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
8198
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8199
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
8200
|
+
let baseOptions;
|
|
8201
|
+
if (configuration) {
|
|
8202
|
+
baseOptions = configuration.baseOptions;
|
|
8203
|
+
}
|
|
8204
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
8205
|
+
const localVarHeaderParameter = {};
|
|
8206
|
+
const localVarQueryParameter = {};
|
|
8207
|
+
// authentication apiKey required
|
|
8208
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api_key", configuration);
|
|
8209
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
8210
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8211
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8212
|
+
return {
|
|
8213
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
8214
|
+
options: localVarRequestOptions,
|
|
8215
|
+
};
|
|
8216
|
+
}),
|
|
8186
8217
|
/**
|
|
8187
8218
|
* Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
|
|
8188
8219
|
* @summary List environments
|
|
@@ -8332,6 +8363,22 @@ const EnvironmentApiFp = function (configuration) {
|
|
|
8332
8363
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8333
8364
|
});
|
|
8334
8365
|
},
|
|
8366
|
+
/**
|
|
8367
|
+
* Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
|
|
8368
|
+
* @summary Get environment VM quota
|
|
8369
|
+
* @param {number} id
|
|
8370
|
+
* @param {*} [options] Override http request option.
|
|
8371
|
+
* @throws {RequiredError}
|
|
8372
|
+
*/
|
|
8373
|
+
getEnvironmentVMQuota(id, options) {
|
|
8374
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8375
|
+
var _a, _b, _c;
|
|
8376
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEnvironmentVMQuota(id, options);
|
|
8377
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8378
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['EnvironmentApi.getEnvironmentVMQuota']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8379
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8380
|
+
});
|
|
8381
|
+
},
|
|
8335
8382
|
/**
|
|
8336
8383
|
* Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
|
|
8337
8384
|
* @summary List environments
|
|
@@ -8417,6 +8464,16 @@ const EnvironmentApiFactory = function (configuration, basePath, axios) {
|
|
|
8417
8464
|
getEnvironment(id, options) {
|
|
8418
8465
|
return localVarFp.getEnvironment(id, options).then((request) => request(axios, basePath));
|
|
8419
8466
|
},
|
|
8467
|
+
/**
|
|
8468
|
+
* Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
|
|
8469
|
+
* @summary Get environment VM quota
|
|
8470
|
+
* @param {number} id
|
|
8471
|
+
* @param {*} [options] Override http request option.
|
|
8472
|
+
* @throws {RequiredError}
|
|
8473
|
+
*/
|
|
8474
|
+
getEnvironmentVMQuota(id, options) {
|
|
8475
|
+
return localVarFp.getEnvironmentVMQuota(id, options).then((request) => request(axios, basePath));
|
|
8476
|
+
},
|
|
8420
8477
|
/**
|
|
8421
8478
|
* Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
|
|
8422
8479
|
* @summary List environments
|
|
@@ -8494,6 +8551,17 @@ class EnvironmentApi extends base_1.BaseAPI {
|
|
|
8494
8551
|
getEnvironment(id, options) {
|
|
8495
8552
|
return (0, exports.EnvironmentApiFp)(this.configuration).getEnvironment(id, options).then((request) => request(this.axios, this.basePath));
|
|
8496
8553
|
}
|
|
8554
|
+
/**
|
|
8555
|
+
* Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.
|
|
8556
|
+
* @summary Get environment VM quota
|
|
8557
|
+
* @param {number} id
|
|
8558
|
+
* @param {*} [options] Override http request option.
|
|
8559
|
+
* @throws {RequiredError}
|
|
8560
|
+
* @memberof EnvironmentApi
|
|
8561
|
+
*/
|
|
8562
|
+
getEnvironmentVMQuota(id, options) {
|
|
8563
|
+
return (0, exports.EnvironmentApiFp)(this.configuration).getEnvironmentVMQuota(id, options).then((request) => request(this.axios, this.basePath));
|
|
8564
|
+
}
|
|
8497
8565
|
/**
|
|
8498
8566
|
* Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
|
|
8499
8567
|
* @summary List environments
|
|
@@ -14274,10 +14342,11 @@ const VirtualMachineApiAxiosParamCreator = function (configuration) {
|
|
|
14274
14342
|
* Check if a Virtual Machine name is available
|
|
14275
14343
|
* @summary Fetch virtual machine name availability
|
|
14276
14344
|
* @param {string} name
|
|
14345
|
+
* @param {string} [count] Nr of instances to handle (optional, default: 1)
|
|
14277
14346
|
* @param {*} [options] Override http request option.
|
|
14278
14347
|
* @throws {RequiredError}
|
|
14279
14348
|
*/
|
|
14280
|
-
checkVMNameAvailability: (name_1, ...args_1) => __awaiter(this, [name_1, ...args_1], void 0, function* (name, options = {}) {
|
|
14349
|
+
checkVMNameAvailability: (name_1, count_1, ...args_1) => __awaiter(this, [name_1, count_1, ...args_1], void 0, function* (name, count, options = {}) {
|
|
14281
14350
|
// verify required parameter 'name' is not null or undefined
|
|
14282
14351
|
(0, common_1.assertParamExists)('checkVMNameAvailability', 'name', name);
|
|
14283
14352
|
const localVarPath = `/core/virtual-machines/name-availability/{name}`
|
|
@@ -14293,6 +14362,9 @@ const VirtualMachineApiAxiosParamCreator = function (configuration) {
|
|
|
14293
14362
|
const localVarQueryParameter = {};
|
|
14294
14363
|
// authentication apiKey required
|
|
14295
14364
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api_key", configuration);
|
|
14365
|
+
if (count !== undefined) {
|
|
14366
|
+
localVarQueryParameter['count'] = count;
|
|
14367
|
+
}
|
|
14296
14368
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
14297
14369
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14298
14370
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -14691,10 +14763,11 @@ const VirtualMachineApiAxiosParamCreator = function (configuration) {
|
|
|
14691
14763
|
* @param {string} [search]
|
|
14692
14764
|
* @param {string} [environment]
|
|
14693
14765
|
* @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
|
|
14766
|
+
* @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
|
|
14694
14767
|
* @param {*} [options] Override http request option.
|
|
14695
14768
|
* @throws {RequiredError}
|
|
14696
14769
|
*/
|
|
14697
|
-
listVMs: (page_1, pageSize_1, search_1, environment_1, excludeFirewalls_1, ...args_1) => __awaiter(this, [page_1, pageSize_1, search_1, environment_1, excludeFirewalls_1, ...args_1], void 0, function* (page, pageSize, search, environment, excludeFirewalls, options = {}) {
|
|
14770
|
+
listVMs: (page_1, pageSize_1, search_1, environment_1, excludeFirewalls_1, exactEnvironmentMatch_1, ...args_1) => __awaiter(this, [page_1, pageSize_1, search_1, environment_1, excludeFirewalls_1, exactEnvironmentMatch_1, ...args_1], void 0, function* (page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options = {}) {
|
|
14698
14771
|
const localVarPath = `/core/virtual-machines`;
|
|
14699
14772
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14700
14773
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -14722,6 +14795,9 @@ const VirtualMachineApiAxiosParamCreator = function (configuration) {
|
|
|
14722
14795
|
if (excludeFirewalls) {
|
|
14723
14796
|
localVarQueryParameter['exclude_firewalls'] = excludeFirewalls;
|
|
14724
14797
|
}
|
|
14798
|
+
if (exactEnvironmentMatch !== undefined) {
|
|
14799
|
+
localVarQueryParameter['exact_environment_match'] = exactEnvironmentMatch;
|
|
14800
|
+
}
|
|
14725
14801
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
14726
14802
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14727
14803
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -14943,13 +15019,14 @@ const VirtualMachineApiFp = function (configuration) {
|
|
|
14943
15019
|
* Check if a Virtual Machine name is available
|
|
14944
15020
|
* @summary Fetch virtual machine name availability
|
|
14945
15021
|
* @param {string} name
|
|
15022
|
+
* @param {string} [count] Nr of instances to handle (optional, default: 1)
|
|
14946
15023
|
* @param {*} [options] Override http request option.
|
|
14947
15024
|
* @throws {RequiredError}
|
|
14948
15025
|
*/
|
|
14949
|
-
checkVMNameAvailability(name, options) {
|
|
15026
|
+
checkVMNameAvailability(name, count, options) {
|
|
14950
15027
|
return __awaiter(this, void 0, void 0, function* () {
|
|
14951
15028
|
var _a, _b, _c;
|
|
14952
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.checkVMNameAvailability(name, options);
|
|
15029
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.checkVMNameAvailability(name, count, options);
|
|
14953
15030
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14954
15031
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['VirtualMachineApi.checkVMNameAvailability']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14955
15032
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -15148,13 +15225,14 @@ const VirtualMachineApiFp = function (configuration) {
|
|
|
15148
15225
|
* @param {string} [search]
|
|
15149
15226
|
* @param {string} [environment]
|
|
15150
15227
|
* @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
|
|
15228
|
+
* @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
|
|
15151
15229
|
* @param {*} [options] Override http request option.
|
|
15152
15230
|
* @throws {RequiredError}
|
|
15153
15231
|
*/
|
|
15154
|
-
listVMs(page, pageSize, search, environment, excludeFirewalls, options) {
|
|
15232
|
+
listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options) {
|
|
15155
15233
|
return __awaiter(this, void 0, void 0, function* () {
|
|
15156
15234
|
var _a, _b, _c;
|
|
15157
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listVMs(page, pageSize, search, environment, excludeFirewalls, options);
|
|
15235
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options);
|
|
15158
15236
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15159
15237
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['VirtualMachineApi.listVMs']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15160
15238
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -15278,11 +15356,12 @@ const VirtualMachineApiFactory = function (configuration, basePath, axios) {
|
|
|
15278
15356
|
* Check if a Virtual Machine name is available
|
|
15279
15357
|
* @summary Fetch virtual machine name availability
|
|
15280
15358
|
* @param {string} name
|
|
15359
|
+
* @param {string} [count] Nr of instances to handle (optional, default: 1)
|
|
15281
15360
|
* @param {*} [options] Override http request option.
|
|
15282
15361
|
* @throws {RequiredError}
|
|
15283
15362
|
*/
|
|
15284
|
-
checkVMNameAvailability(name, options) {
|
|
15285
|
-
return localVarFp.checkVMNameAvailability(name, options).then((request) => request(axios, basePath));
|
|
15363
|
+
checkVMNameAvailability(name, count, options) {
|
|
15364
|
+
return localVarFp.checkVMNameAvailability(name, count, options).then((request) => request(axios, basePath));
|
|
15286
15365
|
},
|
|
15287
15366
|
/**
|
|
15288
15367
|
* Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vm-firewall-rules/add-firewall-rule-to-vm).
|
|
@@ -15411,11 +15490,12 @@ const VirtualMachineApiFactory = function (configuration, basePath, axios) {
|
|
|
15411
15490
|
* @param {string} [search]
|
|
15412
15491
|
* @param {string} [environment]
|
|
15413
15492
|
* @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
|
|
15493
|
+
* @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
|
|
15414
15494
|
* @param {*} [options] Override http request option.
|
|
15415
15495
|
* @throws {RequiredError}
|
|
15416
15496
|
*/
|
|
15417
|
-
listVMs(page, pageSize, search, environment, excludeFirewalls, options) {
|
|
15418
|
-
return localVarFp.listVMs(page, pageSize, search, environment, excludeFirewalls, options).then((request) => request(axios, basePath));
|
|
15497
|
+
listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options) {
|
|
15498
|
+
return localVarFp.listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options).then((request) => request(axios, basePath));
|
|
15419
15499
|
},
|
|
15420
15500
|
/**
|
|
15421
15501
|
* Request console logs for a virtual machine
|
|
@@ -15507,12 +15587,13 @@ class VirtualMachineApi extends base_1.BaseAPI {
|
|
|
15507
15587
|
* Check if a Virtual Machine name is available
|
|
15508
15588
|
* @summary Fetch virtual machine name availability
|
|
15509
15589
|
* @param {string} name
|
|
15590
|
+
* @param {string} [count] Nr of instances to handle (optional, default: 1)
|
|
15510
15591
|
* @param {*} [options] Override http request option.
|
|
15511
15592
|
* @throws {RequiredError}
|
|
15512
15593
|
* @memberof VirtualMachineApi
|
|
15513
15594
|
*/
|
|
15514
|
-
checkVMNameAvailability(name, options) {
|
|
15515
|
-
return (0, exports.VirtualMachineApiFp)(this.configuration).checkVMNameAvailability(name, options).then((request) => request(this.axios, this.basePath));
|
|
15595
|
+
checkVMNameAvailability(name, count, options) {
|
|
15596
|
+
return (0, exports.VirtualMachineApiFp)(this.configuration).checkVMNameAvailability(name, count, options).then((request) => request(this.axios, this.basePath));
|
|
15516
15597
|
}
|
|
15517
15598
|
/**
|
|
15518
15599
|
* Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vm-firewall-rules/add-firewall-rule-to-vm).
|
|
@@ -15652,12 +15733,13 @@ class VirtualMachineApi extends base_1.BaseAPI {
|
|
|
15652
15733
|
* @param {string} [search]
|
|
15653
15734
|
* @param {string} [environment]
|
|
15654
15735
|
* @param {Array<number>} [excludeFirewalls] Comma-separated list of Security Group IDs to ignore instances attached
|
|
15736
|
+
* @param {boolean} [exactEnvironmentMatch] Flag to filter environment by exact match instead of partial match
|
|
15655
15737
|
* @param {*} [options] Override http request option.
|
|
15656
15738
|
* @throws {RequiredError}
|
|
15657
15739
|
* @memberof VirtualMachineApi
|
|
15658
15740
|
*/
|
|
15659
|
-
listVMs(page, pageSize, search, environment, excludeFirewalls, options) {
|
|
15660
|
-
return (0, exports.VirtualMachineApiFp)(this.configuration).listVMs(page, pageSize, search, environment, excludeFirewalls, options).then((request) => request(this.axios, this.basePath));
|
|
15741
|
+
listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options) {
|
|
15742
|
+
return (0, exports.VirtualMachineApiFp)(this.configuration).listVMs(page, pageSize, search, environment, excludeFirewalls, exactEnvironmentMatch, options).then((request) => request(this.axios, this.basePath));
|
|
15661
15743
|
}
|
|
15662
15744
|
/**
|
|
15663
15745
|
* Request console logs for a virtual machine
|