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;
/**
* IPsApi Class Doc Comment
*
* @category Class
* @package OpenAPI\Client
* @author OpenAPI Generator team
* @link https://openapi-generator.tech
*/
class IPsApi
{
/**
* @var ClientInterface
*/
protected $client;
/**
* @var Configuration
*/
protected $config;
/**
* @var HeaderSelector
*/
protected $headerSelector;
/**
* @var int Host index
*/
protected $hostIndex;
/** @var string[] $contentTypes **/
public const contentTypes = [
'createIp' => [
'application/json',
],
'deleteIp' => [
'application/json',
],
'getIp' => [
'application/json',
],
'listIps' => [
'application/json',
],
'updateIp' => [
'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 createIp
*
* Reserve a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param \OpenAPI\Client\Model\CreateIpRequest $create_ip_request create_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['createIp'] 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\ScalewayInstanceV1CreateIpResponse
*/
public function createIp($zone, $create_ip_request, string $contentType = self::contentTypes['createIp'][0])
{
list($response) = $this->createIpWithHttpInfo($zone, $create_ip_request, $contentType);
return $response;
}
/**
* Operation createIpWithHttpInfo
*
* Reserve a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param \OpenAPI\Client\Model\CreateIpRequest $create_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['createIp'] 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\ScalewayInstanceV1CreateIpResponse, HTTP status code, HTTP response headers (array of strings)
*/
public function createIpWithHttpInfo($zone, $create_ip_request, string $contentType = self::contentTypes['createIp'][0])
{
$request = $this->createIpRequest($zone, $create_ip_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\ScalewayInstanceV1CreateIpResponse' === '\SplFileObject') {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ('\OpenAPI\Client\Model\ScalewayInstanceV1CreateIpResponse' !== '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\ScalewayInstanceV1CreateIpResponse', []),
$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\ScalewayInstanceV1CreateIpResponse';
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\ScalewayInstanceV1CreateIpResponse',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation createIpAsync
*
* Reserve a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param \OpenAPI\Client\Model\CreateIpRequest $create_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['createIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function createIpAsync($zone, $create_ip_request, string $contentType = self::contentTypes['createIp'][0])
{
return $this->createIpAsyncWithHttpInfo($zone, $create_ip_request, $contentType)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation createIpAsyncWithHttpInfo
*
* Reserve a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param \OpenAPI\Client\Model\CreateIpRequest $create_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['createIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function createIpAsyncWithHttpInfo($zone, $create_ip_request, string $contentType = self::contentTypes['createIp'][0])
{
$returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1CreateIpResponse';
$request = $this->createIpRequest($zone, $create_ip_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 'createIp'
*
* @param string $zone The zone you want to target (required)
* @param \OpenAPI\Client\Model\CreateIpRequest $create_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['createIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request
*/
public function createIpRequest($zone, $create_ip_request, string $contentType = self::contentTypes['createIp'][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 createIp'
);
}
// verify the required parameter 'create_ip_request' is set
if ($create_ip_request === null || (is_array($create_ip_request) && count($create_ip_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $create_ip_request when calling createIp'
);
}
$resourcePath = '/instance/v1/zones/{zone}/ips';
$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_ip_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_ip_request));
} else {
$httpBody = $create_ip_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 deleteIp
*
* Delete a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip ID or address of the IP to delete. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteIp'] 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 deleteIp($zone, $ip, string $contentType = self::contentTypes['deleteIp'][0])
{
$this->deleteIpWithHttpInfo($zone, $ip, $contentType);
}
/**
* Operation deleteIpWithHttpInfo
*
* Delete a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip ID or address of the IP to delete. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteIp'] 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 deleteIpWithHttpInfo($zone, $ip, string $contentType = self::contentTypes['deleteIp'][0])
{
$request = $this->deleteIpRequest($zone, $ip, $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 deleteIpAsync
*
* Delete a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip ID or address of the IP to delete. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function deleteIpAsync($zone, $ip, string $contentType = self::contentTypes['deleteIp'][0])
{
return $this->deleteIpAsyncWithHttpInfo($zone, $ip, $contentType)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation deleteIpAsyncWithHttpInfo
*
* Delete a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip ID or address of the IP to delete. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function deleteIpAsyncWithHttpInfo($zone, $ip, string $contentType = self::contentTypes['deleteIp'][0])
{
$returnType = '';
$request = $this->deleteIpRequest($zone, $ip, $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 'deleteIp'
*
* @param string $zone The zone you want to target (required)
* @param string $ip ID or address of the IP to delete. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['deleteIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request
*/
public function deleteIpRequest($zone, $ip, string $contentType = self::contentTypes['deleteIp'][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 deleteIp'
);
}
// verify the required parameter 'ip' is set
if ($ip === null || (is_array($ip) && count($ip) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $ip when calling deleteIp'
);
}
$resourcePath = '/instance/v1/zones/{zone}/ips/{ip}';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($zone !== null) {
$resourcePath = str_replace(
'{' . 'zone' . '}',
ObjectSerializer::toPathValue($zone),
$resourcePath
);
}
// path params
if ($ip !== null) {
$resourcePath = str_replace(
'{' . 'ip' . '}',
ObjectSerializer::toPathValue($ip),
$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 getIp
*
* Get a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or address to get. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getIp'] 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\ScalewayInstanceV1GetIpResponse
*/
public function getIp($zone, $ip, string $contentType = self::contentTypes['getIp'][0])
{
list($response) = $this->getIpWithHttpInfo($zone, $ip, $contentType);
return $response;
}
/**
* Operation getIpWithHttpInfo
*
* Get a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or address to get. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getIp'] 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\ScalewayInstanceV1GetIpResponse, HTTP status code, HTTP response headers (array of strings)
*/
public function getIpWithHttpInfo($zone, $ip, string $contentType = self::contentTypes['getIp'][0])
{
$request = $this->getIpRequest($zone, $ip, $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\ScalewayInstanceV1GetIpResponse' === '\SplFileObject') {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ('\OpenAPI\Client\Model\ScalewayInstanceV1GetIpResponse' !== '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\ScalewayInstanceV1GetIpResponse', []),
$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\ScalewayInstanceV1GetIpResponse';
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\ScalewayInstanceV1GetIpResponse',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation getIpAsync
*
* Get a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or address to get. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function getIpAsync($zone, $ip, string $contentType = self::contentTypes['getIp'][0])
{
return $this->getIpAsyncWithHttpInfo($zone, $ip, $contentType)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation getIpAsyncWithHttpInfo
*
* Get a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or address to get. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function getIpAsyncWithHttpInfo($zone, $ip, string $contentType = self::contentTypes['getIp'][0])
{
$returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1GetIpResponse';
$request = $this->getIpRequest($zone, $ip, $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 'getIp'
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or address to get. (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['getIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request
*/
public function getIpRequest($zone, $ip, string $contentType = self::contentTypes['getIp'][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 getIp'
);
}
// verify the required parameter 'ip' is set
if ($ip === null || (is_array($ip) && count($ip) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $ip when calling getIp'
);
}
$resourcePath = '/instance/v1/zones/{zone}/ips/{ip}';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($zone !== null) {
$resourcePath = str_replace(
'{' . 'zone' . '}',
ObjectSerializer::toPathValue($zone),
$resourcePath
);
}
// path params
if ($ip !== null) {
$resourcePath = str_replace(
'{' . 'ip' . '}',
ObjectSerializer::toPathValue($ip),
$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 listIps
*
* List all flexible IPs
*
* @param string $zone The zone you want to target (required)
* @param string|null $project Project ID in which the IPs are reserved. (optional)
* @param string|null $organization Organization ID in which the IPs are reserved. (optional)
* @param string|null $tags Filter IPs with these exact tags (to filter with several tags, use commas to separate them). (optional)
* @param string|null $name Filter on the IP address (Works as a LIKE operation on the IP address). (optional)
* @param int|null $per_page A positive integer lower or equal to 100 to select the number of items to return. (optional)
* @param int|null $page A positive integer to choose the page to return. (optional)
* @param string|null $type Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6'). (optional)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['listIps'] 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\ScalewayInstanceV1ListIpsResponse
*/
public function listIps($zone, $project = null, $organization = null, $tags = null, $name = null, $per_page = null, $page = null, $type = null, string $contentType = self::contentTypes['listIps'][0])
{
list($response) = $this->listIpsWithHttpInfo($zone, $project, $organization, $tags, $name, $per_page, $page, $type, $contentType);
return $response;
}
/**
* Operation listIpsWithHttpInfo
*
* List all flexible IPs
*
* @param string $zone The zone you want to target (required)
* @param string|null $project Project ID in which the IPs are reserved. (optional)
* @param string|null $organization Organization ID in which the IPs are reserved. (optional)
* @param string|null $tags Filter IPs with these exact tags (to filter with several tags, use commas to separate them). (optional)
* @param string|null $name Filter on the IP address (Works as a LIKE operation on the IP address). (optional)
* @param int|null $per_page A positive integer lower or equal to 100 to select the number of items to return. (optional)
* @param int|null $page A positive integer to choose the page to return. (optional)
* @param string|null $type Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6'). (optional)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['listIps'] 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\ScalewayInstanceV1ListIpsResponse, HTTP status code, HTTP response headers (array of strings)
*/
public function listIpsWithHttpInfo($zone, $project = null, $organization = null, $tags = null, $name = null, $per_page = null, $page = null, $type = null, string $contentType = self::contentTypes['listIps'][0])
{
$request = $this->listIpsRequest($zone, $project, $organization, $tags, $name, $per_page, $page, $type, $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\ScalewayInstanceV1ListIpsResponse' === '\SplFileObject') {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ('\OpenAPI\Client\Model\ScalewayInstanceV1ListIpsResponse' !== '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\ScalewayInstanceV1ListIpsResponse', []),
$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\ScalewayInstanceV1ListIpsResponse';
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\ScalewayInstanceV1ListIpsResponse',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation listIpsAsync
*
* List all flexible IPs
*
* @param string $zone The zone you want to target (required)
* @param string|null $project Project ID in which the IPs are reserved. (optional)
* @param string|null $organization Organization ID in which the IPs are reserved. (optional)
* @param string|null $tags Filter IPs with these exact tags (to filter with several tags, use commas to separate them). (optional)
* @param string|null $name Filter on the IP address (Works as a LIKE operation on the IP address). (optional)
* @param int|null $per_page A positive integer lower or equal to 100 to select the number of items to return. (optional)
* @param int|null $page A positive integer to choose the page to return. (optional)
* @param string|null $type Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6'). (optional)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['listIps'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function listIpsAsync($zone, $project = null, $organization = null, $tags = null, $name = null, $per_page = null, $page = null, $type = null, string $contentType = self::contentTypes['listIps'][0])
{
return $this->listIpsAsyncWithHttpInfo($zone, $project, $organization, $tags, $name, $per_page, $page, $type, $contentType)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation listIpsAsyncWithHttpInfo
*
* List all flexible IPs
*
* @param string $zone The zone you want to target (required)
* @param string|null $project Project ID in which the IPs are reserved. (optional)
* @param string|null $organization Organization ID in which the IPs are reserved. (optional)
* @param string|null $tags Filter IPs with these exact tags (to filter with several tags, use commas to separate them). (optional)
* @param string|null $name Filter on the IP address (Works as a LIKE operation on the IP address). (optional)
* @param int|null $per_page A positive integer lower or equal to 100 to select the number of items to return. (optional)
* @param int|null $page A positive integer to choose the page to return. (optional)
* @param string|null $type Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6'). (optional)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['listIps'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function listIpsAsyncWithHttpInfo($zone, $project = null, $organization = null, $tags = null, $name = null, $per_page = null, $page = null, $type = null, string $contentType = self::contentTypes['listIps'][0])
{
$returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1ListIpsResponse';
$request = $this->listIpsRequest($zone, $project, $organization, $tags, $name, $per_page, $page, $type, $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 'listIps'
*
* @param string $zone The zone you want to target (required)
* @param string|null $project Project ID in which the IPs are reserved. (optional)
* @param string|null $organization Organization ID in which the IPs are reserved. (optional)
* @param string|null $tags Filter IPs with these exact tags (to filter with several tags, use commas to separate them). (optional)
* @param string|null $name Filter on the IP address (Works as a LIKE operation on the IP address). (optional)
* @param int|null $per_page A positive integer lower or equal to 100 to select the number of items to return. (optional)
* @param int|null $page A positive integer to choose the page to return. (optional)
* @param string|null $type Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6'). (optional)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['listIps'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request
*/
public function listIpsRequest($zone, $project = null, $organization = null, $tags = null, $name = null, $per_page = null, $page = null, $type = null, string $contentType = self::contentTypes['listIps'][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 listIps'
);
}
$resourcePath = '/instance/v1/zones/{zone}/ips';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// 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(
$organization,
'organization', // 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(
$name,
'name', // 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(
$type,
'type', // 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 updateIp
*
* Update a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or IP address. (required)
* @param \OpenAPI\Client\Model\UpdateIpRequest $update_ip_request update_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateIp'] 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\ScalewayInstanceV1UpdateIpResponse
*/
public function updateIp($zone, $ip, $update_ip_request, string $contentType = self::contentTypes['updateIp'][0])
{
list($response) = $this->updateIpWithHttpInfo($zone, $ip, $update_ip_request, $contentType);
return $response;
}
/**
* Operation updateIpWithHttpInfo
*
* Update a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or IP address. (required)
* @param \OpenAPI\Client\Model\UpdateIpRequest $update_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateIp'] 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\ScalewayInstanceV1UpdateIpResponse, HTTP status code, HTTP response headers (array of strings)
*/
public function updateIpWithHttpInfo($zone, $ip, $update_ip_request, string $contentType = self::contentTypes['updateIp'][0])
{
$request = $this->updateIpRequest($zone, $ip, $update_ip_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\ScalewayInstanceV1UpdateIpResponse' === '\SplFileObject') {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ('\OpenAPI\Client\Model\ScalewayInstanceV1UpdateIpResponse' !== '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\ScalewayInstanceV1UpdateIpResponse', []),
$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\ScalewayInstanceV1UpdateIpResponse';
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\ScalewayInstanceV1UpdateIpResponse',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation updateIpAsync
*
* Update a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or IP address. (required)
* @param \OpenAPI\Client\Model\UpdateIpRequest $update_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function updateIpAsync($zone, $ip, $update_ip_request, string $contentType = self::contentTypes['updateIp'][0])
{
return $this->updateIpAsyncWithHttpInfo($zone, $ip, $update_ip_request, $contentType)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation updateIpAsyncWithHttpInfo
*
* Update a flexible IP
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or IP address. (required)
* @param \OpenAPI\Client\Model\UpdateIpRequest $update_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function updateIpAsyncWithHttpInfo($zone, $ip, $update_ip_request, string $contentType = self::contentTypes['updateIp'][0])
{
$returnType = '\OpenAPI\Client\Model\ScalewayInstanceV1UpdateIpResponse';
$request = $this->updateIpRequest($zone, $ip, $update_ip_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 'updateIp'
*
* @param string $zone The zone you want to target (required)
* @param string $ip IP ID or IP address. (required)
* @param \OpenAPI\Client\Model\UpdateIpRequest $update_ip_request (required)
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['updateIp'] to see the possible values for this operation
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request
*/
public function updateIpRequest($zone, $ip, $update_ip_request, string $contentType = self::contentTypes['updateIp'][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 updateIp'
);
}
// verify the required parameter 'ip' is set
if ($ip === null || (is_array($ip) && count($ip) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $ip when calling updateIp'
);
}
// verify the required parameter 'update_ip_request' is set
if ($update_ip_request === null || (is_array($update_ip_request) && count($update_ip_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $update_ip_request when calling updateIp'
);
}
$resourcePath = '/instance/v1/zones/{zone}/ips/{ip}';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($zone !== null) {
$resourcePath = str_replace(
'{' . 'zone' . '}',
ObjectSerializer::toPathValue($zone),
$resourcePath
);
}
// path params
if ($ip !== null) {
$resourcePath = str_replace(
'{' . 'ip' . '}',
ObjectSerializer::toPathValue($ip),
$resourcePath
);
}
$headers = $this->headerSelector->selectHeaders(
['application/json', ],
$contentType,
$multipart
);
// for model (json/xml)
if (isset($update_ip_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_ip_request));
} else {
$httpBody = $update_ip_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;
}
}