To retrieve information about the different [images](#path-images) available to install on Scaleway Instances, check out our [Marketplace API](https://www.scaleway.com/en/developers/api/marketplace). (switchcolumn) ## Concepts Refer to our [dedicated concepts page](https://www.scaleway.com/en/docs/compute/instances/concepts/) to find definitions of all concepts and terminology related to Instances. (switchcolumn) (switchcolumn) ## Quickstart 1. Configure your environment variables This is an optional step that seeks to simplify your usage of the Instances API. See [Availability Zones](#availability-zones) below for help choosing an Availability Zone. You can find your Project ID in the [Scaleway console](https://console.scaleway.com/project/settings). ```bash export SCW_SECRET_KEY=\"\" export SCW_DEFAULT_ZONE=\"\" export SCW_PROJECT_ID=\"\" ``` 2. **Create an Instance**: Run the following command to create an Instance. You can customize the details in the payload (name, description, type, tags etc) to your needs: use the information below to adjust the payload as necessary. ```bash curl -X POST \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ -H \"Content-Type: application/json\" \\ \"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers\" \\ -d '{ \"name\": \"my-new-instance\", \"project\": \"'\"$SCW_PROJECT_ID\"'\", \"commercial_type\": \"GP1-S\", \"image\": \"ubuntu_noble\", \"enable_ipv6\": true, \"volumes\": { \"0\":{ \"size\": 300000000000, \"volume_type\": \"l_ssd\" } } }' ``` | Parameter | Description | Valid values | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | A name of your choice for the Instance (string) | Any string containing only alphanumeric characters, dots, spaces and dashes, e.g. `\"my-new-instance\"`. | | `project` | The Project in which the Instance should be created (string) | Any valid Scaleway Project ID (see above), e.g. `\"b4bd99e0-b389-11ed-afa1-0242ac120002\"` | | `commercial-type` | The commercial Instance type to create (string) | Any valid ID of a Scaleway commercial Instance type, e.g. `\"GP1-S\"`, `\"PRO2-M\"`. Use the [List Instance Types](#path-instance-types-list-instance-types) endpoint to get a list of all valid Instance types and their IDs. | | `image` | The image to install on the Instance, e.g. a particular OS (string) | Any Scaleway image label, e.g. `\"ubuntu_noble\"`, or any valid Scaleway image ID, e.g. `\"6fc0ade6-d6a3-4fb9-87ab-2444ac71e5c0\"` which is the ID for the `Ubuntu 24.04 Noble Numbat` image. Use the [List Instance Images](#path-images-list-instance-images) endpoint to get a list of all available images with their IDs and labels, or check out the [Scaleway Marketplace API](https://www.scaleway.com/en/developers/api/marketplace). | | `enable_ipv6` | Whether to enable IPv6 on the Instance (boolean) | `true` or `false` | | `volumes` | An object that specifies the storage volumes to attach to the Instance. For more information, see **Creating an Instance: the volumes object** in the [Technical information](#technical-information) section of this quickstart. | A (dictionary) object with a minimum of one key (`\"0\"`) whose value is another object containing the parameters `\"name\"` (a name for the volume), `\"size\"` (the size for the volume, in bytes), and `\"volume_type\"` (`\"l_ssd\"` or `\"b_ssd\"`). Additional keys for additional volumes should increment by 1 each time (the second volume would have a key of `1`.) Further parameters are available, and it is possible to attach existing volumes rather than creating a new one, or create a volume from a snapshot. | 3. **List your Instances**: run the following command to get a list of all the Instances in your account, with their details: ```bash curl -X GET \\ -H \"Content-Type: application/json\" \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ \"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers/\" ``` 4. **Delete an Instance**: run the following command to delete an Instance, specified by its Instance ID: ```bash curl -X DELETE \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ -H \"Content-Type: application/json\" \\ \"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers/\" ``` The expected successful response is empty. (switchcolumn) - You have a [Scaleway account](https://console.scaleway.com/) - You have created an [API key](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) and that the API key has sufficient [IAM permissions](https://www.scaleway.com/en/docs/identity-and-access-management/iam/reference-content/permission-sets/) to perform the actions described on this page - You have [installed `curl`](https://curl.se/download.html) (switchcolumn) ## Technical information ### Availability Zones Instances can be deployed in the following Availability Zones: | Name | API ID | |-----------|-----------------------| | Paris | `fr-par-1` `fr-par-2` `fr-par-3` | | Amsterdam | `nl-ams-1` `nl-ams-2` | | Warsaw | `pl-waw-1` `pl-waw-2` | (switchcolumn) (switchcolumn) ### Pagination Most listing requests receive a paginated response. Requests against paginated endpoints accept two `query` arguments: - `page`, a positive integer to choose which page to return. - `per_page`, an positive integer lower or equal to 100 to select the number of items to return per page. The default value is `50`. Paginated endpoints usually also accept filters to search and sort results.These filters are documented along each endpoint documentation. The `X-Total-Count` header contains the total number of items returned. (switchcolumn) (switchcolumn) ### Creating an Instance: the volumes object When [creating an Instance](#path-instances-create-an-instance) using the Scaleway API, the `volumes` object is **not strictly required**. However, the defaults vary depending on certain conditions: 1. If an image label is used: - The default will be an `sbs_volume` volume. - The size of this volume will be the OS size (typically 10GB in most cases). 2. If an image ID from the marketplace is used (or any image based on a unified snapshot): - If the Instance supports local storage: - The default will be an `l_ssd` volume. - The size of this volume will be the instance's maximum local storage capacity. - If the Instance does not support local storage: - The default will be a `b_ssd` volume. - The size of this volume will be the OS size. If you want to customize the storage configuration or add additional volumes, you will need to include the volumes object in your API request. This object should contain at least one (dictionary) object with a minimum of one key (`\"0\"`) whose value is another object containing the parameters `\"name\"` (a name for the volume), `\"size\"` (the size for the volume, in bytes), and `\"volume_type\"` (`\"sbs_volume\"`, `\"l_ssd\"` or `\"b_ssd\"`). Additional keys for additional volumes should increment by 1 each time (the second volume would have a key of `\"1\"`.) Note that volume `size` must respect the volume constraints of the Instance's `commercial_type`: for each type of Instance, a minimum amount of storage is required, and there is also a maximum that cannot be exceeded. All Instance types support Block Storage (`sbs_volume`, `b_ssd`), some also support local storage (`l_ssd`). Read more about these constraints in the [List Instance types](#path-instance-types-list-instance-types) documentation, specifically the `volume_constraints` parameter for each type listed in the response You can use the `volumes` object in different ways. The table below shows which parameters are required for each of the following use cases: | Use case | Required params | Optional params | Notes | |-------------------------|-----------------------|---------------------|----------------------------------------| | Create a volume (`l_ssd`, `b_ssd`, `sbs_volume`) from a snapshot of an image | | `volume_type`, `size`, `boot` | If the `size` parameter is not set, the size of the volume will equal the size of the corresponding snapshot of the image. The image snapshot type should be compatible with the `volume_type`. | | Create a volume (`l_ssd`, `b_ssd`) from a snapshot | `base_snapshot`, `name`, `volume_type` | `boot` | | | Create a volume of type `sbs_volume` from a snapshot | `base_snapshot`, `name`, `volume_type` | `size`, `boot` | | | Create an empty volume | `name`, `volume_type`, `size` | `boot` | | | Attach an existing volume (`l_ssd`, `b_ssd`) | `id` | `boot` | | | Attach an existing volume of type `sbs_volume` | `id`, `volume_type` | `boot` | | (switchcolumn) This information is designed to help you correctly configure the `volumes` object when using the [Create an Instance](#path-instances-create-an-instance) or [Update an Instance](#path-instances-update-an-instance) methods. (switchcolumn) ## Going further For more help using Scaleway Instances, check out the following resources: - Our [main documentation](https://www.scaleway.com/en/docs/compute/instances/) - The #instance channel on our [Slack Community](https://www.scaleway.com/en/docs/tutorials/scaleway-slack-community/) - Our [support ticketing system](https://www.scaleway.com/en/docs/console/my-account/how-to/open-a-support-ticket/). * * The version of the OpenAPI document: v1 * Generated by: https://openapi-generator.tech * Generator version: 7.11.0 */ /** * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ namespace OpenAPI\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\ConnectException; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use OpenAPI\Client\ApiException; use OpenAPI\Client\Configuration; use OpenAPI\Client\HeaderSelector; use OpenAPI\Client\ObjectSerializer; /** * SnapshotsApi Class Doc Comment * * @category Class * @package OpenAPI\Client * @author OpenAPI Generator team * @link https://openapi-generator.tech */ class SnapshotsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @var int Host index */ protected $hostIndex; /** @var string[] $contentTypes **/ public const contentTypes = [ 'createSnapshot' => [ 'application/json', ], 'deleteSnapshot' => [ 'application/json', ], 'exportSnapshot' => [ 'application/json', ], 'getSnapshot' => [ 'application/json', ], 'listSnapshots' => [ 'application/json', ], 'setSnapshot' => [ 'application/json', ], 'updateSnapshot' => [ 'application/json', ], ]; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec */ public function __construct( ?ClientInterface $client = null, ?Configuration $config = null, ?HeaderSelector $selector = null, int $hostIndex = 0 ) { $this->client = $client ?: new Client(); $this->config = $config ?: Configuration::getDefaultConfiguration(); $this->headerSelector = $selector ?: new HeaderSelector(); $this->hostIndex = $hostIndex; } /** * Set the host index * * @param int $hostIndex Host index (required) */ public function setHostIndex($hostIndex): void { $this->hostIndex = $hostIndex; } /** * Get the host index * * @return int Host index */ public function getHostIndex() { return $this->hostIndex; } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createSnapshot * * Create a snapshot from a specified volume or from a QCOW2 file * * @param string $zone The zone you want to target (required) * @param \OpenAPI\Client\Model\CreateSnapshotRequest $create_snapshot_request create_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['createSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return \OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse */ public function createSnapshot($zone, $create_snapshot_request, string $contentType = self::contentTypes['createSnapshot'][0]) { list($response) = $this->createSnapshotWithHttpInfo($zone, $create_snapshot_request, $contentType); return $response; } /** * Operation createSnapshotWithHttpInfo * * Create a snapshot from a specified volume or from a QCOW2 file * * @param string $zone The zone you want to target (required) * @param \OpenAPI\Client\Model\CreateSnapshotRequest $create_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['createSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return array of \OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse, HTTP status code, HTTP response headers (array of strings) */ public function createSnapshotWithHttpInfo($zone, $create_snapshot_request, string $contentType = self::contentTypes['createSnapshot'][0]) { $request = $this->createSnapshotRequest($zone, $create_snapshot_request, $contentType); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null ); } $statusCode = $response->getStatusCode(); switch($statusCode) { case 201: if ('\OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse' === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ('\OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, '\OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse', []), $response->getStatusCode(), $response->getHeaders() ]; } if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse'; if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createSnapshotAsync * * Create a snapshot from a specified volume or from a QCOW2 file * * @param string $zone The zone you want to target (required) * @param \OpenAPI\Client\Model\CreateSnapshotRequest $create_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['createSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createSnapshotAsync($zone, $create_snapshot_request, string $contentType = self::contentTypes['createSnapshot'][0]) { return $this->createSnapshotAsyncWithHttpInfo($zone, $create_snapshot_request, $contentType) ->then( function ($response) { return $response[0]; } ); } /** * Operation createSnapshotAsyncWithHttpInfo * * Create a snapshot from a specified volume or from a QCOW2 file * * @param string $zone The zone you want to target (required) * @param \OpenAPI\Client\Model\CreateSnapshotRequest $create_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['createSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createSnapshotAsyncWithHttpInfo($zone, $create_snapshot_request, string $contentType = self::contentTypes['createSnapshot'][0]) { $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse'; $request = $this->createSnapshotRequest($zone, $create_snapshot_request, $contentType); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } ); } /** * Create request for operation 'createSnapshot' * * @param string $zone The zone you want to target (required) * @param \OpenAPI\Client\Model\CreateSnapshotRequest $create_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['createSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ public function createSnapshotRequest($zone, $create_snapshot_request, string $contentType = self::contentTypes['createSnapshot'][0]) { // verify the required parameter 'zone' is set if ($zone === null || (is_array($zone) && count($zone) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $zone when calling createSnapshot' ); } // verify the required parameter 'create_snapshot_request' is set if ($create_snapshot_request === null || (is_array($create_snapshot_request) && count($create_snapshot_request) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $create_snapshot_request when calling createSnapshot' ); } $resourcePath = '/instance/v1/zones/{zone}/snapshots'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($zone !== null) { $resourcePath = str_replace( '{' . 'zone' . '}', ObjectSerializer::toPathValue($zone), $resourcePath ); } $headers = $this->headerSelector->selectHeaders( ['application/json', ], $contentType, $multipart ); // for model (json/xml) if (isset($create_snapshot_request)) { if (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($create_snapshot_request)); } else { $httpBody = $create_snapshot_request; } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValueItem ]; } } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) $httpBody = ObjectSerializer::buildQuery($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Auth-Token'); if ($apiKey !== null) { $headers['X-Auth-Token'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $operationHost = $this->config->getHost(); $query = ObjectSerializer::buildQuery($queryParams); return new Request( 'POST', $operationHost . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteSnapshot * * Delete a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return void */ public function deleteSnapshot($zone, $snapshot_id, string $contentType = self::contentTypes['deleteSnapshot'][0]) { $this->deleteSnapshotWithHttpInfo($zone, $snapshot_id, $contentType); } /** * Operation deleteSnapshotWithHttpInfo * * Delete a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteSnapshotWithHttpInfo($zone, $snapshot_id, string $contentType = self::contentTypes['deleteSnapshot'][0]) { $request = $this->deleteSnapshotRequest($zone, $snapshot_id, $contentType); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null ); } $statusCode = $response->getStatusCode(); return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { } throw $e; } } /** * Operation deleteSnapshotAsync * * Delete a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteSnapshotAsync($zone, $snapshot_id, string $contentType = self::contentTypes['deleteSnapshot'][0]) { return $this->deleteSnapshotAsyncWithHttpInfo($zone, $snapshot_id, $contentType) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteSnapshotAsyncWithHttpInfo * * Delete a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteSnapshotAsyncWithHttpInfo($zone, $snapshot_id, string $contentType = self::contentTypes['deleteSnapshot'][0]) { $returnType = ''; $request = $this->deleteSnapshotRequest($zone, $snapshot_id, $contentType); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } ); } /** * Create request for operation 'deleteSnapshot' * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ public function deleteSnapshotRequest($zone, $snapshot_id, string $contentType = self::contentTypes['deleteSnapshot'][0]) { // verify the required parameter 'zone' is set if ($zone === null || (is_array($zone) && count($zone) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $zone when calling deleteSnapshot' ); } // verify the required parameter 'snapshot_id' is set if ($snapshot_id === null || (is_array($snapshot_id) && count($snapshot_id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $snapshot_id when calling deleteSnapshot' ); } $resourcePath = '/instance/v1/zones/{zone}/snapshots/{snapshot_id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($zone !== null) { $resourcePath = str_replace( '{' . 'zone' . '}', ObjectSerializer::toPathValue($zone), $resourcePath ); } // path params if ($snapshot_id !== null) { $resourcePath = str_replace( '{' . 'snapshot_id' . '}', ObjectSerializer::toPathValue($snapshot_id), $resourcePath ); } $headers = $this->headerSelector->selectHeaders( [], $contentType, $multipart ); // for model (json/xml) if (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValueItem ]; } } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) $httpBody = ObjectSerializer::buildQuery($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Auth-Token'); if ($apiKey !== null) { $headers['X-Auth-Token'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $operationHost = $this->config->getHost(); $query = ObjectSerializer::buildQuery($queryParams); return new Request( 'DELETE', $operationHost . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation exportSnapshot * * Export a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id Snapshot ID. (required) * @param \OpenAPI\Client\Model\ExportSnapshotRequest $export_snapshot_request export_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['exportSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return \OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse */ public function exportSnapshot($zone, $snapshot_id, $export_snapshot_request, string $contentType = self::contentTypes['exportSnapshot'][0]) { list($response) = $this->exportSnapshotWithHttpInfo($zone, $snapshot_id, $export_snapshot_request, $contentType); return $response; } /** * Operation exportSnapshotWithHttpInfo * * Export a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id Snapshot ID. (required) * @param \OpenAPI\Client\Model\ExportSnapshotRequest $export_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['exportSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return array of \OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse, HTTP status code, HTTP response headers (array of strings) */ public function exportSnapshotWithHttpInfo($zone, $snapshot_id, $export_snapshot_request, string $contentType = self::contentTypes['exportSnapshot'][0]) { $request = $this->exportSnapshotRequest($zone, $snapshot_id, $export_snapshot_request, $contentType); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null ); } $statusCode = $response->getStatusCode(); switch($statusCode) { case 200: if ('\OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse' === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ('\OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, '\OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse', []), $response->getStatusCode(), $response->getHeaders() ]; } if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse'; if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation exportSnapshotAsync * * Export a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id Snapshot ID. (required) * @param \OpenAPI\Client\Model\ExportSnapshotRequest $export_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['exportSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function exportSnapshotAsync($zone, $snapshot_id, $export_snapshot_request, string $contentType = self::contentTypes['exportSnapshot'][0]) { return $this->exportSnapshotAsyncWithHttpInfo($zone, $snapshot_id, $export_snapshot_request, $contentType) ->then( function ($response) { return $response[0]; } ); } /** * Operation exportSnapshotAsyncWithHttpInfo * * Export a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id Snapshot ID. (required) * @param \OpenAPI\Client\Model\ExportSnapshotRequest $export_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['exportSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function exportSnapshotAsyncWithHttpInfo($zone, $snapshot_id, $export_snapshot_request, string $contentType = self::contentTypes['exportSnapshot'][0]) { $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse'; $request = $this->exportSnapshotRequest($zone, $snapshot_id, $export_snapshot_request, $contentType); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } ); } /** * Create request for operation 'exportSnapshot' * * @param string $zone The zone you want to target (required) * @param string $snapshot_id Snapshot ID. (required) * @param \OpenAPI\Client\Model\ExportSnapshotRequest $export_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['exportSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ public function exportSnapshotRequest($zone, $snapshot_id, $export_snapshot_request, string $contentType = self::contentTypes['exportSnapshot'][0]) { // verify the required parameter 'zone' is set if ($zone === null || (is_array($zone) && count($zone) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $zone when calling exportSnapshot' ); } // verify the required parameter 'snapshot_id' is set if ($snapshot_id === null || (is_array($snapshot_id) && count($snapshot_id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $snapshot_id when calling exportSnapshot' ); } // verify the required parameter 'export_snapshot_request' is set if ($export_snapshot_request === null || (is_array($export_snapshot_request) && count($export_snapshot_request) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $export_snapshot_request when calling exportSnapshot' ); } $resourcePath = '/instance/v1/zones/{zone}/snapshots/{snapshot_id}/export'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($zone !== null) { $resourcePath = str_replace( '{' . 'zone' . '}', ObjectSerializer::toPathValue($zone), $resourcePath ); } // path params if ($snapshot_id !== null) { $resourcePath = str_replace( '{' . 'snapshot_id' . '}', ObjectSerializer::toPathValue($snapshot_id), $resourcePath ); } $headers = $this->headerSelector->selectHeaders( ['application/json', ], $contentType, $multipart ); // for model (json/xml) if (isset($export_snapshot_request)) { if (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($export_snapshot_request)); } else { $httpBody = $export_snapshot_request; } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValueItem ]; } } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) $httpBody = ObjectSerializer::buildQuery($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Auth-Token'); if ($apiKey !== null) { $headers['X-Auth-Token'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $operationHost = $this->config->getHost(); $query = ObjectSerializer::buildQuery($queryParams); return new Request( 'POST', $operationHost . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSnapshot * * Get a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to get. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['getSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return \OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse */ public function getSnapshot($zone, $snapshot_id, string $contentType = self::contentTypes['getSnapshot'][0]) { list($response) = $this->getSnapshotWithHttpInfo($zone, $snapshot_id, $contentType); return $response; } /** * Operation getSnapshotWithHttpInfo * * Get a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to get. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['getSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return array of \OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse, HTTP status code, HTTP response headers (array of strings) */ public function getSnapshotWithHttpInfo($zone, $snapshot_id, string $contentType = self::contentTypes['getSnapshot'][0]) { $request = $this->getSnapshotRequest($zone, $snapshot_id, $contentType); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null ); } $statusCode = $response->getStatusCode(); switch($statusCode) { case 200: if ('\OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse' === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ('\OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, '\OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse', []), $response->getStatusCode(), $response->getHeaders() ]; } if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse'; if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSnapshotAsync * * Get a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to get. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['getSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSnapshotAsync($zone, $snapshot_id, string $contentType = self::contentTypes['getSnapshot'][0]) { return $this->getSnapshotAsyncWithHttpInfo($zone, $snapshot_id, $contentType) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSnapshotAsyncWithHttpInfo * * Get a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to get. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['getSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSnapshotAsyncWithHttpInfo($zone, $snapshot_id, string $contentType = self::contentTypes['getSnapshot'][0]) { $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse'; $request = $this->getSnapshotRequest($zone, $snapshot_id, $contentType); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } ); } /** * Create request for operation 'getSnapshot' * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot you want to get. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['getSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ public function getSnapshotRequest($zone, $snapshot_id, string $contentType = self::contentTypes['getSnapshot'][0]) { // verify the required parameter 'zone' is set if ($zone === null || (is_array($zone) && count($zone) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $zone when calling getSnapshot' ); } // verify the required parameter 'snapshot_id' is set if ($snapshot_id === null || (is_array($snapshot_id) && count($snapshot_id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $snapshot_id when calling getSnapshot' ); } $resourcePath = '/instance/v1/zones/{zone}/snapshots/{snapshot_id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($zone !== null) { $resourcePath = str_replace( '{' . 'zone' . '}', ObjectSerializer::toPathValue($zone), $resourcePath ); } // path params if ($snapshot_id !== null) { $resourcePath = str_replace( '{' . 'snapshot_id' . '}', ObjectSerializer::toPathValue($snapshot_id), $resourcePath ); } $headers = $this->headerSelector->selectHeaders( ['application/json', ], $contentType, $multipart ); // for model (json/xml) if (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValueItem ]; } } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) $httpBody = ObjectSerializer::buildQuery($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Auth-Token'); if ($apiKey !== null) { $headers['X-Auth-Token'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $operationHost = $this->config->getHost(); $query = ObjectSerializer::buildQuery($queryParams); return new Request( 'GET', $operationHost . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation listSnapshots * * List snapshots * * @param string $zone The zone you want to target (required) * @param string|null $organization List snapshots only for this Organization ID. (optional) * @param string|null $project List snapshots only for this Project ID. (optional) * @param int|null $per_page Number of snapshots returned per page (positive integer lower or equal to 100). (optional) * @param int|null $page Page to be returned. (optional) * @param string|null $name List snapshots of the requested name. (optional) * @param string|null $tags List snapshots that have the requested tag. (optional) * @param string|null $base_volume_id List snapshots originating only from this volume. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['listSnapshots'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return \OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse */ public function listSnapshots($zone, $organization = null, $project = null, $per_page = null, $page = null, $name = null, $tags = null, $base_volume_id = null, string $contentType = self::contentTypes['listSnapshots'][0]) { list($response) = $this->listSnapshotsWithHttpInfo($zone, $organization, $project, $per_page, $page, $name, $tags, $base_volume_id, $contentType); return $response; } /** * Operation listSnapshotsWithHttpInfo * * List snapshots * * @param string $zone The zone you want to target (required) * @param string|null $organization List snapshots only for this Organization ID. (optional) * @param string|null $project List snapshots only for this Project ID. (optional) * @param int|null $per_page Number of snapshots returned per page (positive integer lower or equal to 100). (optional) * @param int|null $page Page to be returned. (optional) * @param string|null $name List snapshots of the requested name. (optional) * @param string|null $tags List snapshots that have the requested tag. (optional) * @param string|null $base_volume_id List snapshots originating only from this volume. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['listSnapshots'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return array of \OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse, HTTP status code, HTTP response headers (array of strings) */ public function listSnapshotsWithHttpInfo($zone, $organization = null, $project = null, $per_page = null, $page = null, $name = null, $tags = null, $base_volume_id = null, string $contentType = self::contentTypes['listSnapshots'][0]) { $request = $this->listSnapshotsRequest($zone, $organization, $project, $per_page, $page, $name, $tags, $base_volume_id, $contentType); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null ); } $statusCode = $response->getStatusCode(); switch($statusCode) { case 200: if ('\OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse' === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ('\OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, '\OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse', []), $response->getStatusCode(), $response->getHeaders() ]; } if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse'; if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation listSnapshotsAsync * * List snapshots * * @param string $zone The zone you want to target (required) * @param string|null $organization List snapshots only for this Organization ID. (optional) * @param string|null $project List snapshots only for this Project ID. (optional) * @param int|null $per_page Number of snapshots returned per page (positive integer lower or equal to 100). (optional) * @param int|null $page Page to be returned. (optional) * @param string|null $name List snapshots of the requested name. (optional) * @param string|null $tags List snapshots that have the requested tag. (optional) * @param string|null $base_volume_id List snapshots originating only from this volume. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['listSnapshots'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function listSnapshotsAsync($zone, $organization = null, $project = null, $per_page = null, $page = null, $name = null, $tags = null, $base_volume_id = null, string $contentType = self::contentTypes['listSnapshots'][0]) { return $this->listSnapshotsAsyncWithHttpInfo($zone, $organization, $project, $per_page, $page, $name, $tags, $base_volume_id, $contentType) ->then( function ($response) { return $response[0]; } ); } /** * Operation listSnapshotsAsyncWithHttpInfo * * List snapshots * * @param string $zone The zone you want to target (required) * @param string|null $organization List snapshots only for this Organization ID. (optional) * @param string|null $project List snapshots only for this Project ID. (optional) * @param int|null $per_page Number of snapshots returned per page (positive integer lower or equal to 100). (optional) * @param int|null $page Page to be returned. (optional) * @param string|null $name List snapshots of the requested name. (optional) * @param string|null $tags List snapshots that have the requested tag. (optional) * @param string|null $base_volume_id List snapshots originating only from this volume. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['listSnapshots'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function listSnapshotsAsyncWithHttpInfo($zone, $organization = null, $project = null, $per_page = null, $page = null, $name = null, $tags = null, $base_volume_id = null, string $contentType = self::contentTypes['listSnapshots'][0]) { $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse'; $request = $this->listSnapshotsRequest($zone, $organization, $project, $per_page, $page, $name, $tags, $base_volume_id, $contentType); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } ); } /** * Create request for operation 'listSnapshots' * * @param string $zone The zone you want to target (required) * @param string|null $organization List snapshots only for this Organization ID. (optional) * @param string|null $project List snapshots only for this Project ID. (optional) * @param int|null $per_page Number of snapshots returned per page (positive integer lower or equal to 100). (optional) * @param int|null $page Page to be returned. (optional) * @param string|null $name List snapshots of the requested name. (optional) * @param string|null $tags List snapshots that have the requested tag. (optional) * @param string|null $base_volume_id List snapshots originating only from this volume. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['listSnapshots'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ public function listSnapshotsRequest($zone, $organization = null, $project = null, $per_page = null, $page = null, $name = null, $tags = null, $base_volume_id = null, string $contentType = self::contentTypes['listSnapshots'][0]) { // verify the required parameter 'zone' is set if ($zone === null || (is_array($zone) && count($zone) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $zone when calling listSnapshots' ); } $resourcePath = '/instance/v1/zones/{zone}/snapshots'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( $organization, 'organization', // param base name 'string', // openApiType 'form', // style true, // explode false // required ) ?? []); // query params $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( $project, 'project', // param base name 'string', // openApiType 'form', // style true, // explode false // required ) ?? []); // query params $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( $per_page, 'per_page', // param base name 'integer', // openApiType 'form', // style true, // explode false // required ) ?? []); // query params $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( $page, 'page', // param base name 'integer', // openApiType 'form', // style true, // explode false // required ) ?? []); // query params $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( $name, 'name', // param base name 'string', // openApiType 'form', // style true, // explode false // required ) ?? []); // query params $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( $tags, 'tags', // param base name 'string', // openApiType 'form', // style true, // explode false // required ) ?? []); // query params $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( $base_volume_id, 'base_volume_id', // param base name 'string', // openApiType 'form', // style true, // explode false // required ) ?? []); // path params if ($zone !== null) { $resourcePath = str_replace( '{' . 'zone' . '}', ObjectSerializer::toPathValue($zone), $resourcePath ); } $headers = $this->headerSelector->selectHeaders( ['application/json', ], $contentType, $multipart ); // for model (json/xml) if (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValueItem ]; } } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) $httpBody = ObjectSerializer::buildQuery($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Auth-Token'); if ($apiKey !== null) { $headers['X-Auth-Token'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $operationHost = $this->config->getHost(); $query = ObjectSerializer::buildQuery($queryParams); return new Request( 'GET', $operationHost . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation setSnapshot * * Set snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id snapshot_id (required) * @param \OpenAPI\Client\Model\SetSnapshotRequest $set_snapshot_request set_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['setSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return \OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse */ public function setSnapshot($zone, $snapshot_id, $set_snapshot_request, string $contentType = self::contentTypes['setSnapshot'][0]) { list($response) = $this->setSnapshotWithHttpInfo($zone, $snapshot_id, $set_snapshot_request, $contentType); return $response; } /** * Operation setSnapshotWithHttpInfo * * Set snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id (required) * @param \OpenAPI\Client\Model\SetSnapshotRequest $set_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['setSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return array of \OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse, HTTP status code, HTTP response headers (array of strings) */ public function setSnapshotWithHttpInfo($zone, $snapshot_id, $set_snapshot_request, string $contentType = self::contentTypes['setSnapshot'][0]) { $request = $this->setSnapshotRequest($zone, $snapshot_id, $set_snapshot_request, $contentType); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null ); } $statusCode = $response->getStatusCode(); switch($statusCode) { case 200: if ('\OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse' === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ('\OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, '\OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse', []), $response->getStatusCode(), $response->getHeaders() ]; } if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse'; if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation setSnapshotAsync * * Set snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id (required) * @param \OpenAPI\Client\Model\SetSnapshotRequest $set_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['setSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function setSnapshotAsync($zone, $snapshot_id, $set_snapshot_request, string $contentType = self::contentTypes['setSnapshot'][0]) { return $this->setSnapshotAsyncWithHttpInfo($zone, $snapshot_id, $set_snapshot_request, $contentType) ->then( function ($response) { return $response[0]; } ); } /** * Operation setSnapshotAsyncWithHttpInfo * * Set snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id (required) * @param \OpenAPI\Client\Model\SetSnapshotRequest $set_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['setSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function setSnapshotAsyncWithHttpInfo($zone, $snapshot_id, $set_snapshot_request, string $contentType = self::contentTypes['setSnapshot'][0]) { $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse'; $request = $this->setSnapshotRequest($zone, $snapshot_id, $set_snapshot_request, $contentType); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } ); } /** * Create request for operation 'setSnapshot' * * @param string $zone The zone you want to target (required) * @param string $snapshot_id (required) * @param \OpenAPI\Client\Model\SetSnapshotRequest $set_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['setSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ public function setSnapshotRequest($zone, $snapshot_id, $set_snapshot_request, string $contentType = self::contentTypes['setSnapshot'][0]) { // verify the required parameter 'zone' is set if ($zone === null || (is_array($zone) && count($zone) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $zone when calling setSnapshot' ); } // verify the required parameter 'snapshot_id' is set if ($snapshot_id === null || (is_array($snapshot_id) && count($snapshot_id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $snapshot_id when calling setSnapshot' ); } // verify the required parameter 'set_snapshot_request' is set if ($set_snapshot_request === null || (is_array($set_snapshot_request) && count($set_snapshot_request) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $set_snapshot_request when calling setSnapshot' ); } $resourcePath = '/instance/v1/zones/{zone}/snapshots/{snapshot_id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($zone !== null) { $resourcePath = str_replace( '{' . 'zone' . '}', ObjectSerializer::toPathValue($zone), $resourcePath ); } // path params if ($snapshot_id !== null) { $resourcePath = str_replace( '{' . 'snapshot_id' . '}', ObjectSerializer::toPathValue($snapshot_id), $resourcePath ); } $headers = $this->headerSelector->selectHeaders( ['application/json', ], $contentType, $multipart ); // for model (json/xml) if (isset($set_snapshot_request)) { if (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($set_snapshot_request)); } else { $httpBody = $set_snapshot_request; } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValueItem ]; } } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) $httpBody = ObjectSerializer::buildQuery($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Auth-Token'); if ($apiKey !== null) { $headers['X-Auth-Token'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $operationHost = $this->config->getHost(); $query = ObjectSerializer::buildQuery($queryParams); return new Request( 'PUT', $operationHost . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateSnapshot * * Update a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot. (UUID format) (required) * @param \OpenAPI\Client\Model\UpdateSnapshotRequest $update_snapshot_request update_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return \OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse */ public function updateSnapshot($zone, $snapshot_id, $update_snapshot_request, string $contentType = self::contentTypes['updateSnapshot'][0]) { list($response) = $this->updateSnapshotWithHttpInfo($zone, $snapshot_id, $update_snapshot_request, $contentType); return $response; } /** * Operation updateSnapshotWithHttpInfo * * Update a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot. (UUID format) (required) * @param \OpenAPI\Client\Model\UpdateSnapshotRequest $update_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateSnapshot'] to see the possible values for this operation * * @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format * @throws \InvalidArgumentException * @return array of \OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse, HTTP status code, HTTP response headers (array of strings) */ public function updateSnapshotWithHttpInfo($zone, $snapshot_id, $update_snapshot_request, string $contentType = self::contentTypes['updateSnapshot'][0]) { $request = $this->updateSnapshotRequest($zone, $snapshot_id, $update_snapshot_request, $contentType); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null ); } catch (ConnectException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null ); } $statusCode = $response->getStatusCode(); switch($statusCode) { case 200: if ('\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse' === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ('\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse' !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, '\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse', []), $response->getStatusCode(), $response->getHeaders() ]; } if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse'; if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { try { $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); } catch (\JsonException $exception) { throw new ApiException( sprintf( 'Error JSON decoding server response (%s)', $request->getUri() ), $statusCode, $response->getHeaders(), $content ); } } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateSnapshotAsync * * Update a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot. (UUID format) (required) * @param \OpenAPI\Client\Model\UpdateSnapshotRequest $update_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSnapshotAsync($zone, $snapshot_id, $update_snapshot_request, string $contentType = self::contentTypes['updateSnapshot'][0]) { return $this->updateSnapshotAsyncWithHttpInfo($zone, $snapshot_id, $update_snapshot_request, $contentType) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateSnapshotAsyncWithHttpInfo * * Update a snapshot * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot. (UUID format) (required) * @param \OpenAPI\Client\Model\UpdateSnapshotRequest $update_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSnapshotAsyncWithHttpInfo($zone, $snapshot_id, $update_snapshot_request, string $contentType = self::contentTypes['updateSnapshot'][0]) { $returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse'; $request = $this->updateSnapshotRequest($zone, $snapshot_id, $update_snapshot_request, $contentType); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { if ($returnType === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer } else { $content = (string) $response->getBody(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), (string) $response->getBody() ); } ); } /** * Create request for operation 'updateSnapshot' * * @param string $zone The zone you want to target (required) * @param string $snapshot_id UUID of the snapshot. (UUID format) (required) * @param \OpenAPI\Client\Model\UpdateSnapshotRequest $update_snapshot_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateSnapshot'] to see the possible values for this operation * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ public function updateSnapshotRequest($zone, $snapshot_id, $update_snapshot_request, string $contentType = self::contentTypes['updateSnapshot'][0]) { // verify the required parameter 'zone' is set if ($zone === null || (is_array($zone) && count($zone) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $zone when calling updateSnapshot' ); } // verify the required parameter 'snapshot_id' is set if ($snapshot_id === null || (is_array($snapshot_id) && count($snapshot_id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $snapshot_id when calling updateSnapshot' ); } // verify the required parameter 'update_snapshot_request' is set if ($update_snapshot_request === null || (is_array($update_snapshot_request) && count($update_snapshot_request) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $update_snapshot_request when calling updateSnapshot' ); } $resourcePath = '/instance/v1/zones/{zone}/snapshots/{snapshot_id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($zone !== null) { $resourcePath = str_replace( '{' . 'zone' . '}', ObjectSerializer::toPathValue($zone), $resourcePath ); } // path params if ($snapshot_id !== null) { $resourcePath = str_replace( '{' . 'snapshot_id' . '}', ObjectSerializer::toPathValue($snapshot_id), $resourcePath ); } $headers = $this->headerSelector->selectHeaders( ['application/json', ], $contentType, $multipart ); // for model (json/xml) if (isset($update_snapshot_request)) { if (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the body $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($update_snapshot_request)); } else { $httpBody = $update_snapshot_request; } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; foreach ($formParamValueItems as $formParamValueItem) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValueItem ]; } } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { # if Content-Type contains "application/json", json_encode the form parameters $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); } else { // for HTTP post (form) $httpBody = ObjectSerializer::buildQuery($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Auth-Token'); if ($apiKey !== null) { $headers['X-Auth-Token'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $operationHost = $this->config->getHost(); $query = ObjectSerializer::buildQuery($queryParams); return new Request( 'PATCH', $operationHost . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } }