From 95ee9ae4cf2815c0a83dd0725e0ba24f3c8555cc Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Wed, 28 May 2025 11:06:04 +0200 Subject: [PATCH 1/3] docs(ins): update snapshot documentation --- .../managing-instance-snapshot-via-cli.mdx | 26 +++-- .../snapshot-import-export-feature.mdx | 109 +++++++++--------- .../how-to/create-image-from-snapshot.mdx | 23 +++- .../how-to/snapshot-import-export-feature.mdx | 6 +- 4 files changed, 90 insertions(+), 74 deletions(-) diff --git a/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx b/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx index bf27780f0c..78566f1fea 100644 --- a/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx +++ b/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to manage Scaleway Instance snapshots with the CLI (v2) tags: manage instance snapshot cli cli-v2 dates: - validation: 2025-04-22 + validation: 2025-05-28 posted: 2022-09-24 categories: - compute @@ -38,15 +38,11 @@ The following arguments and flags are available to customize your command: ```sh ARGS: + [volume-id] UUID of the volume to snapshot [name=] Name of the snapshot - [volume-id] UUID of the volume - [tags.{index}] The tags of the snapshot [project-id] Project ID to use. If none is passed the default project ID will be used - [bucket] Bucket name for snapshot imports - [key] Object key for snapshot imports - [size] Imported snapshot size, must be a multiple of 512 - [organization-id] Organization ID to use. If none is passed the default organization ID will be used - [zone=fr-par-1] Zone to target. If none is passed will use the default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1) + [tags.{index}] List of tags assigned to the snapshot + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for create @@ -82,11 +78,21 @@ Run the following command to create a named snapshot from the given volume ID. R scw block snapshot create name=foobar volume-id=11111111-1111-1111-1111-111111111111 ``` +## Exporting a QCOW file to an Object Storage bucket from an Instance snapshot + +Run the following command to export an Instance snapshot as a QCOW2 file to an existing Object Storage bucket in the same geographical region as the snapshot. + +``` +scw block snapshot export-to-object-storage zone=fr-par-1 snapshot-id=11111111-1111-1111-1111-111111111111 bucket= key= +``` + ## Importing a QCOW file from an Object Storage bucket as Instance snapshot -Run the following command to import a QCOW file as an Instance snapshot. Replace the bucket name `my-bucket` with the name of your Object Storage bucket and the file name `qcow2-file-name.qcow2` with the name of your QCOW file. +Run the following command to import a QCOW file as an Instance snapshot. Replace the snapshot name `my-imported-snapshot` with the name of the snapshot to create, the bucket name `my-bucket` with the name of your Object Storage bucket and the file name `my-qcow2-file-name.qcow2` with the name of your QCOW file. +Specify the size of the imoported snapshot with the `size=10GB` flag. + ``` -scw block snapshot create zone=fr-par-1 name=my-imported-snapshot volume-type=b_ssd bucket=my-bucket key=my-qcow2-file-name.qcow +scw block snapshot import-from-object-storage zone=fr-par-1 name= bucket= key= size=10GB ``` diff --git a/pages/instances/api-cli/snapshot-import-export-feature.mdx b/pages/instances/api-cli/snapshot-import-export-feature.mdx index 5f07468619..788f9ddc26 100644 --- a/pages/instances/api-cli/snapshot-import-export-feature.mdx +++ b/pages/instances/api-cli/snapshot-import-export-feature.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to import/export Instance snapshots using the Scaleway API tags: snapshot import export api instance dates: - validation: 2025-03-03 + validation: 2025-05-28 posted: 2021-07-25 categories: - compute @@ -43,30 +43,39 @@ More information on the QCOW2 file format, and how to use it can be found in the For example, using curl: ```sh - curl -X POST https://api.scaleway.com/instance/v1/zones/fr-par-1/snapshots//export \ - -H "X-Auth-Token: " \ - -H "Content-Type: application/json" \ - --data '{"bucket": "my-bucket", "key": "my-exported-snapshot.qcow2"}' - ``` - The following information is required to run the command above: - - The Availability Zone of the snapshot (here: `fr-par-1`) + curl -X POST \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + -H "Content-Type: application/json" \ + -d '{"bucket":"","key":""}' \ + "https://api.scaleway.com/block/v1/zones//snapshots//export-to-object-storage" + ``` + The following information is required to run the command above: + - The Availability Zone of the snapshot (for example: `fr-par-1`) - The secret key of your API key pair (``) - - The snapshot ID (``) + - The snapshot ID (``) - The name of the Object Storage bucket to store the snapshot (which has to exist in the same Scaleway region as the snapshot) - A key (can be any acceptable key/object name for Scaleway Object Storage (suffixing qcow2 images with `.qcow2`)) The API returns an output as in the following example: ```json { - "task": { - "id": "", - "description": "export_snapshot", - "status": "pending", - "href_from": "/snapshots//export", - "href_result": "https://s3.fr-par.scw.cloud/my-bucket/my-exported-snapshot.qcow2", - "started_at": "2022-07-25T15:23:49.278630+00:00", - "terminated_at": null - } + "id": "939d0c67-2f82-4bd6-a9d0-94dd36c6d888", + "name": ">", + "parent_volume": { + "id": "9e17baf7-1316-490b-964f-dd76ac7f5e93", + "name": "", + "type": "sbs_5k", + "status": "in_use" + }, + "size": 10000000000, + "project_id": "c1d1dab1-7e1a-4744-b0fd-d5a80ede56e4", + "created_at": "2025-05-28T08:07:22.599534Z", + "updated_at": "2025-05-28T08:07:22.599534Z", + "references": [], + "status": "exporting", + "tags": [], + "class": "sbs", + "zone": "fr-par-1" } ``` @@ -83,62 +92,50 @@ Call the `import` snapshot API endpoint to initiate the snapshot import. For example, using curl: ```sh -curl -X POST https://api.scaleway.com/instance/v1/zones/fr-par-2/snapshots/ \ --H "X-Auth-Token: " -H "Content-Type: application/json" \ ---data '{"bucket": "my-bucket", "key": "my-exported-snapshot.qcow2", "volume_type": "b_ssd", "project": "", "name": "my-imported-snapshot"}' +curl -X POST \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "bucket": "", + "key": "", + "name": "", + "project_id": "", + "size": "" + }' \ + "https://api.scaleway.com/block/v1/zones/fr-par-1/snapshots/import-from-object-storage" ``` The following information is required to run the command above: - - The Availability Zone of the snapshot (here: `fr-par-2`) - - The secret key of your API key pair (``) + - The Availability Zone of the snapshot (here: `fr-par-1`) - The name of the Object Storage bucket holding the snapshot (which has to exist in the same Scaleway region as the snapshot) - The object name of the QCOW2 image - - - The snapshot's volume type (It can be `l_ssd` or `b_ssd`.) - - A Scaleway Project UUID - The name of the newly created snapshot (used to identify the snapshot in the Console) - - **Optional**: A size parameter. If missing, the size of the created snapshot is defaulted to the QCOW2's volume size. + - A Scaleway Project UUID + - **Optional**: A size parameter in bytes. If missing, the size of the created snapshot is defaulted to the QCOW2's volume size. The API returns an output as in the following example: ```json { -"snapshot": { - "id": "", - "name": "my-imported-snapshot", - "volume_type": "b_ssd", - "creation_date": "2022-07-25T15:27:48.654782+00:00", - "modification_date": "2022-07-25T15:27:48.654782+00:00", - "organization": "", - "project": "", + "id": "033d6442-784b-4301-bfaa-0892973c296f", + "name": "", + "parent_volume": null, "size": 10737418240, - "state": "importing", - "base_volume": null, + "project_id": "844e1e32-6280-42e2-aa96-45d3af1a1aea", + "created_at": "2025-05-28T08:35:53.199253Z", + "updated_at": "2025-05-28T08:35:53.199253Z", + "references": [], + "status": "creating", "tags": [], - "zone": "fr-par-2", - "error_details": null -}, -"task": { - "id": "", - "description": "import_snapshot", - "status": "pending", - "href_from": "/snapshots/", - "href_result": "snapshots/", - "started_at": "2022-07-25T15:27:48.797883+00:00", - "terminated_at": null -} + "class": "sbs", + "zone": "fr-par-1" } ``` -Once the snapshot has been imported, it becomes available in the list of snapshots in the `fr-par-2` AZ: +Once the snapshot has been imported, it becomes available in the list of snapshots in the `fr-par-1` AZ. - The Instance snapshot will be created as soon as the API call returns, but the import action will take several minutes to complete. In the meantime, the snapshot will be in the `importing` state, before becoming `available` once the import is successful. - - ```sh - curl -X GET https://api.scaleway.com/instance/v1/zones/fr-par-2/snapshots/ \ - -H "X-Auth-Token: " | jq ".snapshot.state" "importing" - ``` + The Instance snapshot will be created as soon as the API call returns, but the import action will take several minutes to complete. In the meantime, the snapshot will be in the `creating` state, before becoming `available` once the import is successful. diff --git a/pages/instances/how-to/create-image-from-snapshot.mdx b/pages/instances/how-to/create-image-from-snapshot.mdx index 0fc569c0e8..73d36ed0a2 100644 --- a/pages/instances/how-to/create-image-from-snapshot.mdx +++ b/pages/instances/how-to/create-image-from-snapshot.mdx @@ -22,7 +22,7 @@ categories: ## Creating an image from a snapshot via the Scaleway console -1. Click **CPU Instances** in the **Compute** section of the side menu. The [Instances page](https://console.scaleway.com/instance/servers) displays. +1. Click **CPU & GPU Instances** in the **Compute** section of the side menu. The [Instances page](https://console.scaleway.com/instance/servers) displays. 2. Click the **Images** tab. A list of your images displays. 3. Click **+ Create image**. The image creation page displays. 4. Choose the **Availability Zone** in which you want your image to be created. @@ -50,10 +50,23 @@ scw instance image create snapshot-id="$SCW_VOLUME_ID_1" additional-volumes.0.id - Ensure the architecture (`arch`) is set to a valid value (e.g., `x86_64`). - Supported volume IDs include: - - Local Storage volumes (`l_ssd`) - - Block Storage Low Latency volumes (`sbs`) - - Block Storage legacy (`b_ssd`) volumes (deprecated). + Supported arguments for the image create commmand include: + ``` + ARGS: + [name=] Name of the image + snapshot-id UUID of the snapshot that will be used as root volume in the image + arch Architecture of the image (unknown_arch | x86_64 | arm | arm64) + [additional-volumes.{index}.id] UUID of the snapshot to add + [additional-volumes.{index}.name] Name of the additional snapshot + [additional-volumes.{index}.size] Size of the additional snapshot + [additional-volumes.{index}.volume-type] Underlying volume type of the additional snapshot (l_ssd | b_ssd | unified | scratch | sbs_volume | sbs_snapshot) + [additional-volumes.{index}.project-id] Project ID that own the additional snapshot + [project-id] Project ID to use. If none is passed the default project ID will be used + [tags.{index}] Tags of the image + [public] True to create a public image + [organization-id] Organization ID to use. If none is passed the default organization ID will be used + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3) + ``` ## Creating an image via the Scaleway API diff --git a/pages/instances/how-to/snapshot-import-export-feature.mdx b/pages/instances/how-to/snapshot-import-export-feature.mdx index 4db258e4a3..4caee2b935 100644 --- a/pages/instances/how-to/snapshot-import-export-feature.mdx +++ b/pages/instances/how-to/snapshot-import-export-feature.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to import/export snapshots of Instances using the Scaleway console. tags: snapshot, import, export, instance, availability zone, qcow2 dates: - validation: 2025-03-25 + validation: 2025-05-28 posted: 2021-07-27 categories: - compute @@ -33,7 +33,7 @@ More information on the QCOW2 file format and how to use it can be found in the For this guide, we assume you have an Instance running in the `fr-par-1` AZ, your Object Storage bucket is located in the region `fr-par`, and you want to create a new Instance in the `fr-par-2` AZ. -1. Click the [Instances section](https://console.scaleway.com/instance/servers) of the Scaleway console, then click the Instance you want to snapshot. +1. Click the [CPU & GPU Instances section](https://console.scaleway.com/instance/servers) of the Scaleway console, then click the Instance you want to snapshot. 2. The Instance overview displays. Click the **Storage** tab to display the storage resources attached to the Instance. Scroll to the **Snapshots** section of the page. 3. Click the name of the snapshot you want to export. The snapshot overview displays. 4. Click **Actions** then select **Copy to bucket**. A pop-up displays. Enter the file name for your exported snapshot copy and select the destination bucket. Then click **Copy snapshot to bucket**. @@ -45,7 +45,7 @@ For this guide, we assume you have an Instance running in the `fr-par-1` AZ, you Depending on the size of your snapshot, the export to Object Storage may take some time. It is ready once the status indicator changes to green. 2. Click next to the snapshot copy, then click **Import as snapshot**. A pop-up will appear. Enter the name of the snapshot, select the destination AZ, and choose the snapshot type. - The type can be either **Local SSD** or **Block SSD**. Click **Import file as snapshot** to import the snapshot into the destination AZ. + The type can be either **Local Storage** or **Block Storage**. Click **Import object as snapshot** to import the snapshot into the destination AZ. - Ensure that the QCOW / QCOW2 image file you want to import uses the file extension `.qcow` or `.qcow2` to avoid issues during import. - Imported snapshots must have a volume size between 1 GB and 1 TB. From 0e339b9e436a1e0e54ff163a883714f3a8041c75 Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Mon, 2 Jun 2025 10:50:07 +0200 Subject: [PATCH 2/3] feat(ins): update documentation --- .../instances/api-cli/attaching-a-volume.mdx | 110 +++++++++--------- pages/instances/api-cli/creating-a-volume.mdx | 8 +- pages/instances/api-cli/creating-backups.mdx | 18 +-- .../instances/api-cli/detaching-a-volume.mdx | 6 +- .../api-cli/increasing-volume-size.mdx | 4 +- .../how-to/snapshot-import-export-feature.mdx | 6 +- 6 files changed, 80 insertions(+), 72 deletions(-) diff --git a/pages/instances/api-cli/attaching-a-volume.mdx b/pages/instances/api-cli/attaching-a-volume.mdx index 4ecb76b2e9..acf4fe2856 100644 --- a/pages/instances/api-cli/attaching-a-volume.mdx +++ b/pages/instances/api-cli/attaching-a-volume.mdx @@ -1,6 +1,6 @@ --- meta: - title: Attaching a Block Storage volume via the Instance API + title: Attaching a Block Storage volume via the Block Storage API description: This page explains how to attach a Block Storage volume using the Scaleway API. content: h1: Attaching a Block Storage volume via the Instance API @@ -24,23 +24,29 @@ dates: 1. Query the current volumes of the Instance. ``` - curl -q \ - -H "X-Auth-Token: $SECRET_KEY" \ - -H 'Content-Type: application/json' \ - https://api.scaleway.com/instance/v1/zones/fr-par-1/servers/be3c50af-e8f3-4ff4-90fe-66972f06670d + curl -X GET \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + "https://api.scaleway.com/instance/v1/zones/{zone}/servers/{server_id}" + ``` + + The output displays as follows: + ``` { - "server": { - "allowed_actions": [ - ... - "volumes": { - "0": { - ... - "id": "7fe25caf-0a68-46a7-aeb9-63a278d33e2b", - "volume_type": "l_ssd", - ... - } - }, - ... + "server": { + "id": "de0f4d6a-3289-4716-97a8-d24b2a58dcd9", + "name": "scw-priceless-diffie", + "arch": "x86_64", + ... + }, + "volumes": { + "0": { + "boot": false, + "volume_type": "sbs_volume", + "id": "1469d160-bfb2-4fdd-bb5d-f8d7c1d0439d", + "zone": "pl-waw-2" + } + }, + ... } ``` @@ -48,7 +54,7 @@ dates: 2. Hot-plug the volume created earlier: ```bash curl -q \ - -H "X-Auth-Token: $SECRET_KEY" \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ -H 'Content-Type: application/json' \ -X PATCH \ -d '{ @@ -63,44 +69,34 @@ dates: } } }' \ - https://api.scaleway.com/instance/v1/zones/fr-par-1/servers/be3c50af-e8f3-4ff4-90fe-66972f06670d - { - "server": { - ... - "id": "be3c50af-e8f3-4ff4-90fe-66972f06670d", - ... - "name": "scw-blissful-engelbart", - "protected": false, - "volumes": { - "0": { - "size": 20000000000, - "state": "available", - ... - "id": "7fe25caf-0a68-46a7-aeb9-63a278d33e2b", - "volume_type": "l_ssd", - "server": { - "id": "be3c50af-e8f3-4ff4-90fe-66972f06670d", - "name": "scw-blissful-engelbart" - } - }, - "1": { - "size": 10000000000, - "state": "available", - "name": "block-volume101", - "modification_date": "2019-09-03T10:17:40.800839+00:00", - ... - "id": "b3a42fb1-e85c-46e9-b0a6-9adb62278295", - "volume_type": "sbs_volume", - "server": { - "id": "be3c50af-e8f3-4ff4-90fe-66972f06670d", - "name": "scw-blissful-engelbart" - } - } - }, - ... - } - } + https://api.scaleway.com/instance/v1/zones/{zone}/servers/{server_id} ``` + The output looks like the following example: + ``` + { + "server": { + "id": "1de0f4d6a-3289-4716-97a8-d24b2a58dcd9", + "name": "scw-priceless-diffie", + "arch": "x86_64", + ... + }, + "volumes": { + "0": { + "boot": false, + "volume_type": "sbs_volume", + "id": "7fe25caf-0a68-46a7-aeb9-63a278d33e2b", + "zone": "pl-waw-2" + }, + "1": { + "boot": false, + "volume_type": "sbs_volume", + "id": "b3a42fb1-e85c-46e9-b0a6-9adb62278295", + "zone": "pl-waw-2" + } + }, + ... + } + ``` 3. Use [SSH](/instances/how-to/connect-to-instance/) to log into your server and verify that the new disk exists: ```bash lsblk @@ -125,7 +121,7 @@ dates: ``` curl -q \ - -H "X-Auth-Token: $SECRET_KEY" \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ -H 'Content-Type: application/json' \ https://api.scaleway.com/instance/v1/zones/fr-par-1/volumes/b3a42fb1-e85c-46e9-b0a6-9adb62278295 { @@ -135,7 +131,7 @@ dates: "name": "block-volume101", ... "id": "b3a42fb1-e85c-46e9-b0a6-9adb62278295", - "volume_type": "b_ssd", + "volume_type": "sbs_volume", "server": { "id": "be3c50af-e8f3-4ff4-90fe-66972f06670d", "name": "scw-blissful-engelbart" diff --git a/pages/instances/api-cli/creating-a-volume.mdx b/pages/instances/api-cli/creating-a-volume.mdx index a8a1c5f601..320df70d74 100644 --- a/pages/instances/api-cli/creating-a-volume.mdx +++ b/pages/instances/api-cli/creating-a-volume.mdx @@ -14,6 +14,10 @@ categories: - storage --- + + Creating Block Storage volumes via the Instances API is deprected and the information below is proposed for informative purposes only. [Learn how to create a volume using the Block Storage API.](https://www.scaleway.com/en/developers/api/block/#path-volume-create-a-volume) + + - A Scaleway account logged into the [console](https://console.scaleway.com) @@ -24,7 +28,7 @@ categories: 1. Create a block volume from the API by launching the following command: ``` curl -q \ - -H "X-Auth-Token: $SECRET_KEY" \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d '{"name": "block-volume-101", "organization": "'$SCW_ORGANIZATION'", "size": 10000000000, "volume_type": "b_ssd"}' \ @@ -33,7 +37,7 @@ categories: 2. To retrieve the current status of the block volume, query the volume endpoint. ``` curl -q \ - -H "X-Auth-Token: $SECRET_KEY" \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ -H 'Content-Type: application/json' \ https://api.scaleway.com/instance/v1/zones/fr-par-1/volumes/b3a42fb1-e85c-46e9-b0a6-9adb62278295 { diff --git a/pages/instances/api-cli/creating-backups.mdx b/pages/instances/api-cli/creating-backups.mdx index 6fcb40254b..32f704f46d 100644 --- a/pages/instances/api-cli/creating-backups.mdx +++ b/pages/instances/api-cli/creating-backups.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to create backups of your Instaces using the Scaleway API tags: instance create backup scaleway-api dates: - validation: 2025-01-02 + validation: 2025-05-28 posted: 2021-05-26 categories: - compute @@ -38,12 +38,12 @@ The Backup feature is used to back up your Instance data. It creates an image of By default, the name of the image is built according to the name of the server and the date. You can specify a name for the image in the request: ```sh - scw instance server backp server-id zone=fr-par-1 name=myimagename + scw instance server backup zone=fr-par-1 name= ``` A backup request will create an image object. You can view it using: ```sh - scw instance image get image-uid zone=fr-par-1 + scw instance image get zone=fr-par-1 ``` An image contains one snapshot for each volume of the Instance. These snapshots are visible within the image response as `root_volume` and `extra_volumes` fields. @@ -78,22 +78,26 @@ The Backup feature is used to back up your Instance data. It creates an image of To delete a backup, run the following command: ```sh - scw instance image delete image-uid zone=fr-par1 + scw instance image delete zone=fr-par1 ``` It is also recommended to remove every snapshot related to the image by running the following command for each snapshot that is no longer needed: ```sh - scw instance snapshot delete snapshot-uid zone=fr-par-1 + scw block snapshot delete zone=fr-par-1 ``` Run the following call to delete the image that contains a backup: ``` - DELETE https://api.scaleway.com/instance/v1/zones//images/ + curl -X DELETE \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + "https://api.scaleway.com/instance/v1/zones/{zone}/images/{image_id}" ``` It is also recommended to remove every snapshot related to the image by running the following API call for each snapshot that is no longer needed: ``` - DELETE https://api.scaleway.com/instance/v1/zones//snapshots/ + curl -X DELETE \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + "https://api.scaleway.com/block/v1/zones/{zone}/snapshots/{snapshot_id}" ``` diff --git a/pages/instances/api-cli/detaching-a-volume.mdx b/pages/instances/api-cli/detaching-a-volume.mdx index 4b7ed98055..9f0ac05b42 100644 --- a/pages/instances/api-cli/detaching-a-volume.mdx +++ b/pages/instances/api-cli/detaching-a-volume.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to detach a Block Storage volume from an Instance using the Scaleway API. tags: detach volume block storage unlink unplug api dates: - validation: 2025-01-02 + validation: 2025-06-02 posted: 2020-01-10 categories: - block-storage @@ -23,7 +23,7 @@ To detach a block volume from a running Instance, relaunch the API call and omit ``` curl -q \ - -H "X-Auth-Token: $SECRET_KEY" \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ -H 'Content-Type: application/json' \ -X PATCH \ -d '{ @@ -31,7 +31,7 @@ curl -q \ "0": "7fe25caf-0a68-46a7-aeb9-63a278d33e2b", } }' \ - https://api.scaleway.com/instance/v1/zones/fr-par-1/servers/be3c50af-e8f3-4ff4-90fe-66972f06670d + ttps://api.scaleway.com/instance/v1/zones/{zone}/servers/{server_id} ``` diff --git a/pages/instances/api-cli/increasing-volume-size.mdx b/pages/instances/api-cli/increasing-volume-size.mdx index 18bcdf1918..fa01f8f83a 100644 --- a/pages/instances/api-cli/increasing-volume-size.mdx +++ b/pages/instances/api-cli/increasing-volume-size.mdx @@ -30,7 +30,7 @@ The Instances API allows you to interact with Block Storage volumes programmatic 1. Inspect the volume and verify its name, size, and if the type is `b_ssd` by running the following request. ``` - curl -q -H "X-Auth-Token: $SECRET_KEY" -X GET https://api.scaleway.com/instance/v1/zones//volumes/ + curl -q -H "X-Auth-Token: $SCW_SECRET_KEY" -X GET https://api.scaleway.com/instance/v1/zones//volumes/ ``` @@ -44,7 +44,7 @@ The Instances API allows you to interact with Block Storage volumes programmatic ``` 2. To modify the volume size, run the request below: ``` - curl https://api.scaleway.com/instance/v1/zones/REGION/volumes/VOLUME_ID -H "X-Auth-Token: $SECRET_KEY" -X PATCH -H 'Content-Type: application/json;charset=utf-8' --data '{ "name":"new_name", "size":26000000000 }' + curl https://api.scaleway.com/instance/v1/zones/REGION/volumes/VOLUME_ID -H "X-Auth-Token: $SCW_SECRET_KEY" -X PATCH -H 'Content-Type: application/json;charset=utf-8' --data '{ "name":"new_name", "size":26000000000 }' ``` Replace `REGION` and `VOLUME_ID` following the guidelines mentioned previously and replace the existing size value with the new one. diff --git a/pages/instances/how-to/snapshot-import-export-feature.mdx b/pages/instances/how-to/snapshot-import-export-feature.mdx index 4caee2b935..345f58d2ff 100644 --- a/pages/instances/how-to/snapshot-import-export-feature.mdx +++ b/pages/instances/how-to/snapshot-import-export-feature.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to import/export snapshots of Instances using the Scaleway console. tags: snapshot, import, export, instance, availability zone, qcow2 dates: - validation: 2025-05-28 + validation: 2025-06-02 posted: 2021-07-27 categories: - compute @@ -33,6 +33,10 @@ More information on the QCOW2 file format and how to use it can be found in the For this guide, we assume you have an Instance running in the `fr-par-1` AZ, your Object Storage bucket is located in the region `fr-par`, and you want to create a new Instance in the `fr-par-2` AZ. + + The snapshot export from the console is currently available for **Local Storage** volumes. Use the CLI or API to export a **Block Storage** volume. [Learn more about exporting Block Storage volumes using the API.](/instances/api-cli/snapshot-import-export-feature) + + 1. Click the [CPU & GPU Instances section](https://console.scaleway.com/instance/servers) of the Scaleway console, then click the Instance you want to snapshot. 2. The Instance overview displays. Click the **Storage** tab to display the storage resources attached to the Instance. Scroll to the **Snapshots** section of the page. 3. Click the name of the snapshot you want to export. The snapshot overview displays. From 809a5ec66cb5a1b3ff53124921af022622a2e458 Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Mon, 2 Jun 2025 11:01:05 +0200 Subject: [PATCH 3/3] docs(ins): update content --- pages/instances/api-cli/creating-a-volume.mdx | 2 +- pages/instances/api-cli/detaching-a-volume.mdx | 2 +- pages/instances/api-cli/increasing-volume-size.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pages/instances/api-cli/creating-a-volume.mdx b/pages/instances/api-cli/creating-a-volume.mdx index 320df70d74..1af86a63fa 100644 --- a/pages/instances/api-cli/creating-a-volume.mdx +++ b/pages/instances/api-cli/creating-a-volume.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to create a Block Storage volume using the Scaleway API. tags: block-storage block volume create storage dates: - validation: 2025-01-02 + validation: 2025-06-02 posted: 2020-01-10 categories: - block-storage diff --git a/pages/instances/api-cli/detaching-a-volume.mdx b/pages/instances/api-cli/detaching-a-volume.mdx index 9f0ac05b42..1d99748c26 100644 --- a/pages/instances/api-cli/detaching-a-volume.mdx +++ b/pages/instances/api-cli/detaching-a-volume.mdx @@ -31,7 +31,7 @@ curl -q \ "0": "7fe25caf-0a68-46a7-aeb9-63a278d33e2b", } }' \ - ttps://api.scaleway.com/instance/v1/zones/{zone}/servers/{server_id} + https://api.scaleway.com/instance/v1/zones/{zone}/servers/{server_id} ``` diff --git a/pages/instances/api-cli/increasing-volume-size.mdx b/pages/instances/api-cli/increasing-volume-size.mdx index fa01f8f83a..8ec42dc072 100644 --- a/pages/instances/api-cli/increasing-volume-size.mdx +++ b/pages/instances/api-cli/increasing-volume-size.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to increase a Block Storage volume tags: increase expand increment raise storage volume block dates: - validation: 2025-03-11 + validation: 2025-06-02 posted: 2020-01-10 categories: - block-storage