273 lines
17 KiB
PHP
273 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* HeaderSelector
|
|
* PHP version 7.4
|
|
*
|
|
* @category Class
|
|
* @package OpenAPI\Client
|
|
* @author OpenAPI Generator team
|
|
* @link https://openapi-generator.tech
|
|
*/
|
|
|
|
/**
|
|
* Block Storage API
|
|
*
|
|
* Scaleway Block Storage provides network-attached storage that can be plugged in and out of cloud products such as Instances like a virtual hard-drive. Block Storage devices are independent from the local storage of Instances, and the fact that they are accessed over a network connection makes it easy to move them between Instances in the same Availability Zone. (switchcolumn) <Message type=\"important\"> This page includes the API reference documentation for all Block Storage Low Latency offers. If you wish to use the Basic Block Storage offers, refer to the [Instances API documentation page](/api/instance/#path-volume-types-list-volume-types). </Message> (switchcolumn) ## Quickstart 1. Configure your environment variables. <Message type=\"note\"> This is an optional step that seeks to simplify your usage of the Block Storage 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). </Message> ```bash export SCW_SECRET_KEY=\"<API secret key>\" export SCW_DEFAULT_ZONE=\"<Scaleway Availability Zone>\" export SCW_PROJECT_ID=\"<Scaleway Project ID>\" ``` <Message type=\"important\"> Make sure that the Availability Zone (AZ) is the same as the one of your Instance. Block volumes can only be attached to Instances in the same AZ. </Message> 2. Edit the POST request payload you will use to create your Block volume. Replace the parameters in the following example: ```json '{ \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\", \"name\": \"my-volume\", \"perf_iops\": \"5000\", \"tags\": [\"donnerstag\"], \"from_empty\": { \"size\": \"30000000000\"} }' ``` | Parameter | Description | | :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `project_id` | **REQUIRED** The ID of the Project you want to create your Block volume in. To find your Project ID you can **[list the projects](/api/account#path-projects-list-all-projects-of-an-organization)** or consult the **[Scaleway console](https://console.scaleway.com/project/settings)**. | | `name` | **REQUIRED** Name of the volume | | `perf_iops` | **REQUIRED** The maximum IO/s expected. This amount is a shared limit between write and read operations, it will be determined by your usage. You must specify either `5000`, or `15000`. | | `tags` | The list of tags `[\"tag1\", \"tag2\", ...]` that will be associated with the Database Instance. Tags can be appended to the query of the [List Database Instances](#path-database-instances-list-database-instances) call to show results for only the Database Instances using a specific tag. You can also combine tags to list Database Instances that posess all the appended tags. | | `from_empty` | When you create a brand new volume, as opposed to creating a volume from a snapshot, you must specifiy its size. | | `size` | Volume size. The value should be expressed in bytes. For example 30GB is expressed as 30000000000 | 3. Create a Block volume by running the following command. Make sure you include the payload you edited in the previous step. ```bash curl -X POST \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ \"Content-Type: application/json\" \\ https://api.scaleway.com/block/v1alpha1/zone/$SCW_DEFAULT_ZONE/volumes \\ -d '{ \"project_id\": \"'\"$SCW_PROJECT_ID\"'\", \"name\": \"my-volume\", \"perf_iops\": \"5000\", \"tags\": [\"donnerstag\"], \"from_empty\": { \"size\": \"30000000000\"} }' ``` An output similar to the following displays : ```json '{ \"id\": \"e337a374-f19a-4b58-a45d-75076f75fbc5\", \"name\": \"my-volume\", \"type\": \"sbs_5k\", \"size\": 30000000000, \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\", \"created_at\": \"2023-09-28T15:48:59.105240Z\", \"updated_at\": \"2023-09-28T15:48:59.105240Z\", \"references\": [], \"parent_snapshot_id\": None, \"status\": \"creating\", \"tags\": [], \"specs\": {\"perf_iops\": 5000, \"class\": \"sbs\"}, \"zone\": \"fr-par-1\" }' ``` <Message type=\"note\"> Make sure to save the `id` of your volume, as it will be required in the next step. </Message> 4. Attach your volume to your Instance using the Instance API [Update an Instance](/api/instance/#path-instances-update-an-instance) call. <Message type=\"note\"> Make sure the Block volume is created and ready before attaching it to the Instance. </Message> <Message type=\"important\"> Make sure you include all your Instance's existing volumes in the payload, as the update can only be done to all or none of the volumes. The payload should include a minimum of one key (`\"0\"`) with a value equivalent to the setting parameters for the volume. Additional keys for additional volumes should increment by 1 each time. For example, the second volume is `\"1\"`, the third `\"2\"`, and so on. </Message> ```bash curl -X PATCH \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ \"Content-Type: application/json\" \\ https://api.scaleway.com/instance/v1/zone/$SCW_DEFAULT_ZONE/servers/$INSTANCE_ID \\ -d '{ \"volumes\": { \"0\": { \"boot\": false, \"id\": \"571c8a17-ba68-4c1d-b137-bbd5bc7af104\", \"volume_type\": \"System volume\" } \"1\": { \"boot\": false, \"id\": \"e337a374-f19a-4b58-a45d-75076f75fbc5\", \"volume_type\": \"sbs_volume\" } }' ``` Your Block volume is ready to be used with your Instance. Refer to the [How to mount and use your Block volume](https://www.scaleway.com/en/docs/storage/block/how-to/mount-and-use-volume/) documentation page to do so. (switchcolumn) <Message type=\"requirement\"> To perform the following steps, you must first ensure that: - you have an account and are logged into the [Scaleway console](https://console.scaleway.com/organization) - 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) - you have [created an Instance](/instance/#path-instances-create-an-instance). </Message> (switchcolumn) ## Going further For further information and assitance for Scaleway Block Storage, check out the following resources: - [Basic Block Storage Documentation](https://www.scaleway.com/en/docs/storage/block/) - [#block channel in the Scaleway Slack Community](scaleway-community.slack.com) - [How to open a support ticket](https://www.scaleway.com/en/docs/console/my-account/how-to/open-a-support-ticket/).
|
|
*
|
|
* The version of the OpenAPI document: v1alpha1
|
|
* 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;
|
|
|
|
/**
|
|
* HeaderSelector Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package OpenAPI\Client
|
|
* @author OpenAPI Generator team
|
|
* @link https://openapi-generator.tech
|
|
*/
|
|
class HeaderSelector
|
|
{
|
|
/**
|
|
* @param string[] $accept
|
|
* @param string $contentType
|
|
* @param bool $isMultipart
|
|
* @return string[]
|
|
*/
|
|
public function selectHeaders(array $accept, string $contentType, bool $isMultipart): array
|
|
{
|
|
$headers = [];
|
|
|
|
$accept = $this->selectAcceptHeader($accept);
|
|
if ($accept !== null) {
|
|
$headers['Accept'] = $accept;
|
|
}
|
|
|
|
if (!$isMultipart) {
|
|
if($contentType === '') {
|
|
$contentType = 'application/json';
|
|
}
|
|
|
|
$headers['Content-Type'] = $contentType;
|
|
}
|
|
|
|
return $headers;
|
|
}
|
|
|
|
/**
|
|
* Return the header 'Accept' based on an array of Accept provided.
|
|
*
|
|
* @param string[] $accept Array of header
|
|
*
|
|
* @return null|string Accept (e.g. application/json)
|
|
*/
|
|
private function selectAcceptHeader(array $accept): ?string
|
|
{
|
|
# filter out empty entries
|
|
$accept = array_filter($accept);
|
|
|
|
if (count($accept) === 0) {
|
|
return null;
|
|
}
|
|
|
|
# If there's only one Accept header, just use it
|
|
if (count($accept) === 1) {
|
|
return reset($accept);
|
|
}
|
|
|
|
# If none of the available Accept headers is of type "json", then just use all them
|
|
$headersWithJson = $this->selectJsonMimeList($accept);
|
|
if (count($headersWithJson) === 0) {
|
|
return implode(',', $accept);
|
|
}
|
|
|
|
# If we got here, then we need add quality values (weight), as described in IETF RFC 9110, Items 12.4.2/12.5.1,
|
|
# to give the highest priority to json-like headers - recalculating the existing ones, if needed
|
|
return $this->getAcceptHeaderWithAdjustedWeight($accept, $headersWithJson);
|
|
}
|
|
|
|
/**
|
|
* Detects whether a string contains a valid JSON mime type
|
|
*
|
|
* @param string $searchString
|
|
* @return bool
|
|
*/
|
|
public function isJsonMime(string $searchString): bool
|
|
{
|
|
return preg_match('~^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)~', $searchString) === 1;
|
|
}
|
|
|
|
/**
|
|
* Select all items from a list containing a JSON mime type
|
|
*
|
|
* @param array $mimeList
|
|
* @return array
|
|
*/
|
|
private function selectJsonMimeList(array $mimeList): array {
|
|
$jsonMimeList = [];
|
|
foreach ($mimeList as $mime) {
|
|
if($this->isJsonMime($mime)) {
|
|
$jsonMimeList[] = $mime;
|
|
}
|
|
}
|
|
return $jsonMimeList;
|
|
}
|
|
|
|
|
|
/**
|
|
* Create an Accept header string from the given "Accept" headers array, recalculating all weights
|
|
*
|
|
* @param string[] $accept Array of Accept Headers
|
|
* @param string[] $headersWithJson Array of Accept Headers of type "json"
|
|
*
|
|
* @return string "Accept" Header (e.g. "application/json, text/html; q=0.9")
|
|
*/
|
|
private function getAcceptHeaderWithAdjustedWeight(array $accept, array $headersWithJson): string
|
|
{
|
|
$processedHeaders = [
|
|
'withApplicationJson' => [],
|
|
'withJson' => [],
|
|
'withoutJson' => [],
|
|
];
|
|
|
|
foreach ($accept as $header) {
|
|
|
|
$headerData = $this->getHeaderAndWeight($header);
|
|
|
|
if (stripos($headerData['header'], 'application/json') === 0) {
|
|
$processedHeaders['withApplicationJson'][] = $headerData;
|
|
} elseif (in_array($header, $headersWithJson, true)) {
|
|
$processedHeaders['withJson'][] = $headerData;
|
|
} else {
|
|
$processedHeaders['withoutJson'][] = $headerData;
|
|
}
|
|
}
|
|
|
|
$acceptHeaders = [];
|
|
$currentWeight = 1000;
|
|
|
|
$hasMoreThan28Headers = count($accept) > 28;
|
|
|
|
foreach($processedHeaders as $headers) {
|
|
if (count($headers) > 0) {
|
|
$acceptHeaders[] = $this->adjustWeight($headers, $currentWeight, $hasMoreThan28Headers);
|
|
}
|
|
}
|
|
|
|
$acceptHeaders = array_merge(...$acceptHeaders);
|
|
|
|
return implode(',', $acceptHeaders);
|
|
}
|
|
|
|
/**
|
|
* Given an Accept header, returns an associative array splitting the header and its weight
|
|
*
|
|
* @param string $header "Accept" Header
|
|
*
|
|
* @return array with the header and its weight
|
|
*/
|
|
private function getHeaderAndWeight(string $header): array
|
|
{
|
|
# matches headers with weight, splitting the header and the weight in $outputArray
|
|
if (preg_match('/(.*);\s*q=(1(?:\.0+)?|0\.\d+)$/', $header, $outputArray) === 1) {
|
|
$headerData = [
|
|
'header' => $outputArray[1],
|
|
'weight' => (int)($outputArray[2] * 1000),
|
|
];
|
|
} else {
|
|
$headerData = [
|
|
'header' => trim($header),
|
|
'weight' => 1000,
|
|
];
|
|
}
|
|
|
|
return $headerData;
|
|
}
|
|
|
|
/**
|
|
* @param array[] $headers
|
|
* @param float $currentWeight
|
|
* @param bool $hasMoreThan28Headers
|
|
* @return string[] array of adjusted "Accept" headers
|
|
*/
|
|
private function adjustWeight(array $headers, float &$currentWeight, bool $hasMoreThan28Headers): array
|
|
{
|
|
usort($headers, function (array $a, array $b) {
|
|
return $b['weight'] - $a['weight'];
|
|
});
|
|
|
|
$acceptHeaders = [];
|
|
foreach ($headers as $index => $header) {
|
|
if($index > 0 && $headers[$index - 1]['weight'] > $header['weight'])
|
|
{
|
|
$currentWeight = $this->getNextWeight($currentWeight, $hasMoreThan28Headers);
|
|
}
|
|
|
|
$weight = $currentWeight;
|
|
|
|
$acceptHeaders[] = $this->buildAcceptHeader($header['header'], $weight);
|
|
}
|
|
|
|
$currentWeight = $this->getNextWeight($currentWeight, $hasMoreThan28Headers);
|
|
|
|
return $acceptHeaders;
|
|
}
|
|
|
|
/**
|
|
* @param string $header
|
|
* @param int $weight
|
|
* @return string
|
|
*/
|
|
private function buildAcceptHeader(string $header, int $weight): string
|
|
{
|
|
if($weight === 1000) {
|
|
return $header;
|
|
}
|
|
|
|
return trim($header, '; ') . ';q=' . rtrim(sprintf('%0.3f', $weight / 1000), '0');
|
|
}
|
|
|
|
/**
|
|
* Calculate the next weight, based on the current one.
|
|
*
|
|
* If there are less than 28 "Accept" headers, the weights will be decreased by 1 on its highest significant digit, using the
|
|
* following formula:
|
|
*
|
|
* next weight = current weight - 10 ^ (floor(log(current weight - 1)))
|
|
*
|
|
* ( current weight minus ( 10 raised to the power of ( floor of (log to the base 10 of ( current weight minus 1 ) ) ) ) )
|
|
*
|
|
* Starting from 1000, this generates the following series:
|
|
*
|
|
* 1000, 900, 800, 700, 600, 500, 400, 300, 200, 100, 90, 80, 70, 60, 50, 40, 30, 20, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1
|
|
*
|
|
* The resulting quality codes are closer to the average "normal" usage of them (like "q=0.9", "q=0.8" and so on), but it only works
|
|
* if there is a maximum of 28 "Accept" headers. If we have more than that (which is extremely unlikely), then we fall back to a 1-by-1
|
|
* decrement rule, which will result in quality codes like "q=0.999", "q=0.998" etc.
|
|
*
|
|
* @param int $currentWeight varying from 1 to 1000 (will be divided by 1000 to build the quality value)
|
|
* @param bool $hasMoreThan28Headers
|
|
* @return int
|
|
*/
|
|
public function getNextWeight(int $currentWeight, bool $hasMoreThan28Headers): int
|
|
{
|
|
if ($currentWeight <= 1) {
|
|
return 1;
|
|
}
|
|
|
|
if ($hasMoreThan28Headers) {
|
|
return $currentWeight - 1;
|
|
}
|
|
|
|
return $currentWeight - 10 ** floor( log10($currentWeight - 1) );
|
|
}
|
|
}
|