472 lines
36 KiB
TypeScript
472 lines
36 KiB
TypeScript
|
/**
|
|||
|
|
* Hetzner Cloud API
|
|||
|
|
* This is the official documentation for the Hetzner Cloud API. ## Introduction The Hetzner Cloud API operates over HTTPS and uses JSON as its data format. The API is a RESTful API and utilizes HTTP methods and HTTP status codes to specify requests and responses. As an alternative to working directly with our API you may also consider to use: - Our CLI program [hcloud](https://github.com/hetznercloud/cli) - Our [library for Go](https://github.com/hetznercloud/hcloud-go) - Our [library for Python](https://github.com/hetznercloud/hcloud-python) Also you can find a [list of libraries, tools, and integrations on GitHub](https://github.com/hetznercloud/awesome-hcloud). If you are developing integrations based on our API and your product is Open Source you may be eligible for a free one time €50 (excl. VAT) credit on your account. Please contact us via the the support page on your Cloud Console and let us know the following: - The type of integration you would like to develop - Link to the GitHub repo you will use for the Project - Link to some other Open Source work you have already done (if you have done so) ## Getting Started To get started using the API you first need an API token. Sign in into the [Hetzner Cloud Console](https://console.hetzner.cloud/) choose a Project, go to `Security` → `API Tokens`, and generate a new token. Make sure to copy the token because it won’t be shown to you again. A token is bound to a Project, to interact with the API of another Project you have to create a new token inside the Project. Let’s say your new token is `LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj`. You’re now ready to do your first request against the API. To get a list of all Servers in your Project, issue the example request on the right side using [curl](https://curl.se/). Make sure to replace the token in the example command with the token you have just created. Since your Project probably does not contain any Servers yet, the example response will look like the response on the right side. We will almost always provide a resource root like `servers` inside the example response. A response can also contain a `meta` object with information like [Pagination](#pagination). **Example Request** ```bash curl -H \"Authorization: Bearer LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj\" \\ https://api.hetzner.cloud/v1/servers ``` **Example Response** ```json { \"servers\": [], \"meta\": { \"pagination\": { \"page\": 1, \"per_page\": 25, \"previous_page\": null, \"next_page\": null, \"last_page\": 1, \"total_entries\": 0 } } } ``` ## Authentication All requests to the Hetzner Cloud API must be authenticated via a API token. Include your secret API token in every request you send to the API with the `Authorization` HTTP header. To create a new API token for your Project, switch into the [Hetzner Cloud Console](https://console.hetzner.cloud/) choose a Project, go to `Security` → `API Tokens`, and generate a new token. **Example Authorization header** ```http Authorization: Bearer LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj ``` ## Errors Errors are indicated by HTTP status codes. Further, the response of the request which generated the error contains an error code, an error message, and, optionally, error details. The schema of the error details object depends on the error code. The error response contains the following keys: | Keys | Meaning | | --------- | --------------------------------------------------------------------- | | `code` | Short string indicating the type of error (machine-parsable) | | `message` | Textual description on what has gone wrong | | `details` | An object providing for details on the error (schema depends on code) | **Example response** ```json { \"error\": { \"code\": \"invalid_input\", \"message\": \"invalid input in field \'broken_field\': is too
|
|||
|
|
*
|
|||
|
|
* The version of the OpenAPI document: 1.0.0
|
|||
|
|
*
|
|||
|
|
*
|
|||
|
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|||
|
|
* https://openapi-generator.tech
|
|||
|
|
* Do not edit the class manually.
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
|
|||
|
|
import localVarRequest from 'request';
|
|||
|
|
import http from 'http';
|
|||
|
|
|
|||
|
|
/* tslint:disable:no-unused-locals */
|
|||
|
|
import { CreateVolumeRequest } from '../model/createVolumeRequest';
|
|||
|
|
import { UpdateVolumeRequest } from '../model/updateVolumeRequest';
|
|||
|
|
import { VolumesGet200Response } from '../model/volumesGet200Response';
|
|||
|
|
import { VolumesIdGet200Response } from '../model/volumesIdGet200Response';
|
|||
|
|
import { VolumesPost201Response } from '../model/volumesPost201Response';
|
|||
|
|
|
|||
|
|
import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
|
|||
|
|
import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
|
|||
|
|
|
|||
|
|
import { HttpError, RequestFile } from './apis';
|
|||
|
|
|
|||
|
|
let defaultBasePath = 'https://api.hetzner.cloud/v1';
|
|||
|
|
|
|||
|
|
// ===============================================
|
|||
|
|
// This file is autogenerated - Please do not edit
|
|||
|
|
// ===============================================
|
|||
|
|
|
|||
|
|
export enum VolumesApiApiKeys {
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
export class VolumesApi {
|
|||
|
|
protected _basePath = defaultBasePath;
|
|||
|
|
protected _defaultHeaders : any = {};
|
|||
|
|
protected _useQuerystring : boolean = false;
|
|||
|
|
|
|||
|
|
protected authentications = {
|
|||
|
|
'default': <Authentication>new VoidAuth(),
|
|||
|
|
'APIToken': new HttpBearerAuth(),
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
protected interceptors: Interceptor[] = [];
|
|||
|
|
|
|||
|
|
constructor(basePath?: string);
|
|||
|
|
constructor(basePathOrUsername: string, password?: string, basePath?: string) {
|
|||
|
|
if (password) {
|
|||
|
|
if (basePath) {
|
|||
|
|
this.basePath = basePath;
|
|||
|
|
}
|
|||
|
|
} else {
|
|||
|
|
if (basePathOrUsername) {
|
|||
|
|
this.basePath = basePathOrUsername
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set useQuerystring(value: boolean) {
|
|||
|
|
this._useQuerystring = value;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set basePath(basePath: string) {
|
|||
|
|
this._basePath = basePath;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set defaultHeaders(defaultHeaders: any) {
|
|||
|
|
this._defaultHeaders = defaultHeaders;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
get defaultHeaders() {
|
|||
|
|
return this._defaultHeaders;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
get basePath() {
|
|||
|
|
return this._basePath;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public setDefaultAuthentication(auth: Authentication) {
|
|||
|
|
this.authentications.default = auth;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public setApiKey(key: VolumesApiApiKeys, value: string) {
|
|||
|
|
(this.authentications as any)[VolumesApiApiKeys[key]].apiKey = value;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set accessToken(accessToken: string | (() => string)) {
|
|||
|
|
this.authentications.APIToken.accessToken = accessToken;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public addInterceptor(interceptor: Interceptor) {
|
|||
|
|
this.interceptors.push(interceptor);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Gets all existing Volumes that you have available.
|
|||
|
|
* @summary Get all Volumes
|
|||
|
|
* @param status Can be used multiple times. The response will only contain Volumes matching the status.
|
|||
|
|
* @param sort Can be used multiple times.
|
|||
|
|
* @param name Can be used to filter resources by their name. The response will only contain the resources matching the specified name
|
|||
|
|
* @param labelSelector Can be used to filter resources by labels. The response will only contain resources matching the label selector.
|
|||
|
|
* @param page Page to load.
|
|||
|
|
* @param perPage Items to load per page.
|
|||
|
|
*/
|
|||
|
|
public async volumesGet (status?: 'available' | 'creating', sort?: 'id' | 'id:asc' | 'id:desc' | 'name' | 'name:asc' | 'name:desc' | 'created' | 'created:asc' | 'created:desc', name?: string, labelSelector?: string, page?: number, perPage?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: VolumesGet200Response; }> {
|
|||
|
|
const localVarPath = this.basePath + '/volumes';
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
if (status !== undefined) {
|
|||
|
|
localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'available' | 'creating'");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (sort !== undefined) {
|
|||
|
|
localVarQueryParameters['sort'] = ObjectSerializer.serialize(sort, "'id' | 'id:asc' | 'id:desc' | 'name' | 'name:asc' | 'name:desc' | 'created' | 'created:asc' | 'created:desc'");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (name !== undefined) {
|
|||
|
|
localVarQueryParameters['name'] = ObjectSerializer.serialize(name, "string");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (labelSelector !== undefined) {
|
|||
|
|
localVarQueryParameters['label_selector'] = ObjectSerializer.serialize(labelSelector, "string");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (page !== undefined) {
|
|||
|
|
localVarQueryParameters['page'] = ObjectSerializer.serialize(page, "number");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (perPage !== undefined) {
|
|||
|
|
localVarQueryParameters['per_page'] = ObjectSerializer.serialize(perPage, "number");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'GET',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: VolumesGet200Response; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "VolumesGet200Response");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Deletes a volume. All Volume data is irreversibly destroyed. The Volume must not be attached to a Server and it must not have delete protection enabled.
|
|||
|
|
* @summary Delete a Volume
|
|||
|
|
* @param id ID of the Volume
|
|||
|
|
*/
|
|||
|
|
public async volumesIdDelete (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any; }> {
|
|||
|
|
const localVarPath = this.basePath + '/volumes/{id}'
|
|||
|
|
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
// verify required parameter 'id' is not null or undefined
|
|||
|
|
if (id === null || id === undefined) {
|
|||
|
|
throw new Error('Required parameter id was null or undefined when calling volumesIdDelete.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'DELETE',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body?: any; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Gets a specific Volume object.
|
|||
|
|
* @summary Get a Volume
|
|||
|
|
* @param id ID of the Volume
|
|||
|
|
*/
|
|||
|
|
public async volumesIdGet (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: VolumesIdGet200Response; }> {
|
|||
|
|
const localVarPath = this.basePath + '/volumes/{id}'
|
|||
|
|
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
// verify required parameter 'id' is not null or undefined
|
|||
|
|
if (id === null || id === undefined) {
|
|||
|
|
throw new Error('Required parameter id was null or undefined when calling volumesIdGet.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'GET',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: VolumesIdGet200Response; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "VolumesIdGet200Response");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Updates the Volume properties. Note that when updating labels, the volume’s current set of labels will be replaced with the labels provided in the request body. So, for example, if you want to add a new label, you have to provide all existing labels plus the new label in the request body.
|
|||
|
|
* @summary Update a Volume
|
|||
|
|
* @param id ID of the Volume to update
|
|||
|
|
* @param updateVolumeRequest
|
|||
|
|
*/
|
|||
|
|
public async volumesIdPut (id: number, updateVolumeRequest?: UpdateVolumeRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: VolumesIdGet200Response; }> {
|
|||
|
|
const localVarPath = this.basePath + '/volumes/{id}'
|
|||
|
|
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
// verify required parameter 'id' is not null or undefined
|
|||
|
|
if (id === null || id === undefined) {
|
|||
|
|
throw new Error('Required parameter id was null or undefined when calling volumesIdPut.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'PUT',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
body: ObjectSerializer.serialize(updateVolumeRequest, "UpdateVolumeRequest")
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: VolumesIdGet200Response; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "VolumesIdGet200Response");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Creates a new Volume attached to a Server. If you want to create a Volume that is not attached to a Server, you need to provide the `location` key instead of `server`. This can be either the ID or the name of the Location this Volume will be created in. Note that a Volume can be attached to a Server only in the same Location as the Volume itself. Specifying the Server during Volume creation will automatically attach the Volume to that Server after it has been initialized. In that case, the `next_actions` key in the response is an array which contains a single `attach_volume` action. The minimum Volume size is 10GB and the maximum size is 10TB (10240GB). A volume’s name can consist of alphanumeric characters, dashes, underscores, and dots, but has to start and end with an alphanumeric character. The total length is limited to 64 characters. Volume names must be unique per Project. #### Call specific error codes | Code | Description | |-------------------------------------|-----------------------------------------------------| | `no_space_left_in_location` | There is no volume space left in the given location |
|
|||
|
|
* @summary Create a Volume
|
|||
|
|
* @param createVolumeRequest
|
|||
|
|
*/
|
|||
|
|
public async volumesPost (createVolumeRequest?: CreateVolumeRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: VolumesPost201Response; }> {
|
|||
|
|
const localVarPath = this.basePath + '/volumes';
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'POST',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
body: ObjectSerializer.serialize(createVolumeRequest, "CreateVolumeRequest")
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: VolumesPost201Response; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "VolumesPost201Response");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
}
|