Skip to content

Commit f0514b2

Browse files
SamyOubouazizRoRoJ
andauthored
chore(gen): content review MTA-6277 (#5288)
* chore(gen): content review MTA-6277 * chore(gen): updaéte * chore(gen): updaéte * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * Update pages/block-storage/api-cli/identifying-volume-snapshot-api.mdx Co-authored-by: Rowena Jones <[email protected]> * Update pages/block-storage/api-cli/identifying-volume-snapshot-api.mdx Co-authored-by: Rowena Jones <[email protected]> * Update pages/object-storage/api-cli/manage-bucket-permissions-ip.mdx Co-authored-by: Rowena Jones <[email protected]> --------- Co-authored-by: Rowena Jones <[email protected]>
1 parent cea16fe commit f0514b2

35 files changed

+109
-143
lines changed

pages/block-storage/api-cli/identifying-volume-snapshot-api.mdx

Lines changed: 41 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Identifying the API managing Block Storage volumes and snapshots
33
description: Learn how to determine which API (Instance or Block Storage) manages your volumes and snapshots on Scaleway using CLI and API commands.
44
dates:
5-
validation: 2025-01-13
5+
validation: 2025-07-31
66
posted: 2025-01-13
77
---
88
import Requirements from '@macros/iam/requirements.mdx'
@@ -34,7 +34,10 @@ Open a terminal and run the following command to list your volumes managed by th
3434
-H "X-Auth-Token: $SCW_SECRET_KEY" \
3535
"https://api.scaleway.com/instance/v1/zones/{zone}/volumes"
3636
```
37-
Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Instance API. Note that the `volume_type` field is set to `b_ssd`, meaning the volumes were created via the Instance API.
37+
38+
Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Instance API.
39+
40+
The `volume_type` field is set to `b_ssd`, meaning the volumes were created via the Instance API.
3841

3942
```
4043
{
@@ -74,24 +77,6 @@ Below is an example of the output that should display if you have created volume
7477
"modification_date": "2024-01-30T13:11:15.554809+00:00",
7578
"tags": [],
7679
"zone": "fr-par-1"
77-
},
78-
{
79-
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
80-
"name": "System volume",
81-
"volume_type": "b_ssd",
82-
"export_uri": null,
83-
"organization": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
84-
"project": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
85-
"server": {
86-
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
87-
"name": "scw-optimistic-wilbur"
88-
},
89-
"size": 10000000000,
90-
"state": "available",
91-
"creation_date": "2023-11-14T12:59:42.932912+00:00",
92-
"modification_date": "2023-11-14T12:59:42.932912+00:00",
93-
"tags": [],
94-
"zone": "fr-par-1"
9580
}
9681
]
9782
}
@@ -107,7 +92,9 @@ Open a terminal and run the following command to list your volumes managed by th
10792
"https://api.scaleway.com/block/v1alpha1/zones/{zone}/volumes"
10893
```
10994

110-
Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Block Storage API. Note that the `volume_type` field is set to either `sbs_15k` or `sbs_5k`, meaning the volumes were created via the Block Storage API.
95+
Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Block Storage API.
96+
97+
The `volume_type` field is set to either `sbs_15k` or `sbs_5k`, meaning the volumes were created via the Block Storage API.
11198

11299
```
113100
{
@@ -135,21 +122,9 @@ Below is an example of the output that should display if you have created volume
135122
"class": "sbs"
136123
},
137124
"zone": "fr-par-1"
138-
},
139-
{
140-
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
141-
"name": "volume-interesting-keller",
142-
"type": "sbs_5k",
143-
"size": 25000000000,
144-
"status": "available",
145-
"specs": {
146-
"perf_iops": 5000,
147-
"class": "sbs"
148-
},
149-
"zone": "fr-par-1"
150125
}
151126
],
152-
"total_count": 3
127+
"total_count": 2
153128
}
154129
```
155130

@@ -164,7 +139,8 @@ Open a terminal and run the following command to list all snapshots created via
164139
-H "X-Auth-Token: $SCW_SECRET_KEY" \
165140
"https://api.scaleway.com/instance/v1/zones/{zone}/snapshots"
166141
```
167-
An output similar to the following should display:
142+
143+
An output similar to the following displays:
168144

169145
```
170146
{
@@ -198,7 +174,7 @@ Open a terminal and run the following command to list all snapshots created via
198174
"https://api.scaleway.com/block/v1alpha1/zones/{zone}/snapshots"
199175
```
200176

201-
An output similar to the following should display:
177+
An output similar to the following displays:
202178

203179
```
204180
{
@@ -221,25 +197,6 @@ An output similar to the following should display:
221197
"tags": [],
222198
"class": "sbs",
223199
"zone": "fr-par-1"
224-
},
225-
{
226-
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
227-
"name": "snap-busy-albattani",
228-
"parent_volume": {
229-
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
230-
"name": "volume-eloquent-grothendieck",
231-
"type": "sbs_5k",
232-
"status": "available"
233-
},
234-
"size": 25000000000,
235-
"project_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
236-
"created_at": "2024-12-06T10:16:18.565939Z",
237-
"updated_at": "2024-12-06T10:16:18.565939Z",
238-
"references": [],
239-
"status": "available",
240-
"tags": [],
241-
"class": "sbs",
242-
"zone": "fr-par-1"
243200
}
244201
]
245202
}
@@ -254,7 +211,9 @@ An output similar to the following should display:
254211
```bash
255212
scw instance volume list
256213
```
257-
An output similar to the following should display:
214+
215+
An output similar to the following displays:
216+
258217
```
259218
ID STATE SERVER ID
260219
b582c548-6dc0-4e77-bb93-9615b9baa380 available a4138186-f362-41b2-adc2-c46a2e1a46b7
@@ -265,12 +224,15 @@ An output similar to the following should display:
265224
7c232b97-63da-46e3-a018-399e1690b14b available ea5b27d7-268f-40fe-aff7-6943fbcac379
266225
1a506e55-0741-4afd-8fbc-bc086ace0265 available 8860802f-0337-4901-b58c-ba3975922349
267226
```
268-
2. Note the ID of the volume you want to check the type of.
269-
3. Get more information about your volume, including its type. Make sure that you replace `<volume-id>` with the ID of the volume.
227+
228+
2. Copy the ID of the volume for which you want to check the type.
229+
230+
3. Run the command below to get information about your volume, including its type. Make sure that you replace `<volume-id>` with the ID of the volume.
231+
270232
```bash
271233
scw instance volume get <volume-id>
272234
```
273-
An output similar to the following should display:
235+
An output similar to the following displays:
274236
```
275237
Volume.ID 7c232b97-63da-46e3-a018-399e1690b14b
276238
Volume.Name System volume
@@ -285,16 +247,20 @@ An output similar to the following should display:
285247
Volume.State available
286248
Volume.Zone fr-par-1
287249
```
250+
288251
4. Check the `Volume.VolumeType` field to learn if your volume is managed by the Instance API or the Block Storage API. Note that in our example, the `Volume.VolumeType` field displays `b_ssd`, meaning our volume is managed by the Instance API.
289252

290253
### Using the Scaleway Block Storage CLI
291254

292255
Open your terminal and run the following command to list all your volumes.
256+
293257
```bash
294258
scw block volume list
295259
```
260+
296261
An output similar to the following should display:
297-
```
262+
263+
```bash
298264
ID NAME TYPE SIZE
299265
7a9f3816-7bb7-44ea-a103-832b9685cdc6 volume-nifty-allen sbs_15k 25 GB
300266
cdab395b-c1b9-4a3b-a759-2add13eb2bcb volume-xenodochial-mccarthy sbs_15k 30 GB
@@ -315,18 +281,22 @@ An output similar to the following should display:
315281
```bash
316282
scw instance snapshot list
317283
```
318-
An output similar to the following should display:
284+
An output similar to the following displays:
319285
```
320286
ID NAME ORGANIZATION
321287
d4b45594-7398-481d-8299-46292e07e404 snap-magical-driscoll 0c514155-9e5e-41a2-a900-9fdf0195b563
322288
```
323289
2. Note the ID of the snapshot you want to check the type of.
290+
324291
3. Get more information about your snapshot, including its type. Make sure that you replace `<snapshot-id>` with the ID of the snapshot.
292+
325293
```bash
326294
scw instance snapshot get <snapshot-id>
327295
```
296+
328297
An output similar to the following displays:
329-
```
298+
299+
```bash
330300
Snapshot.ID d4b45594-7398-481d-8299-46292e07e404
331301
Snapshot.Name snap-magical-driscoll
332302
Snapshot.Organization 0c514155-9e5e-41a2-a900-9fdf0195b563
@@ -338,6 +308,7 @@ An output similar to the following should display:
338308
Snapshot.ModificationDate 10 months ago
339309
Snapshot.Zone fr-par-1
340310
```
311+
341312
4. Check the `Snapshot.VolumeType` field to see the type of the snapshot. Note that in the example above, the `Snapshot.VolumeType` field displays `b_ssd`, meaning our volume is managed by the Instance API.
342313

343314
### Using the Scaleway Block Storage CLI
@@ -347,19 +318,23 @@ An output similar to the following should display:
347318
```bash
348319
scw block snapshot list
349320
```
350-
An output similar to the following should display.
321+
An output similar to the following displays:
351322

352323
```
353324
ID NAME SIZE PROJECT ID
354325
7f6ab0bd-cd0d-466b-b1e3-bd309dddfcf8 snap-elated-thompson 30 GB 0c514155-9e5e-41a2-a900-9fdf0195b563
355326
92fa0096-30cf-4e7e-a1fe-2fbe73f524b9 snap-busy-albattani 25 GB e53c4255-f982-4d9d-a003-5ea43cb33707
356327
```
357-
2. Note the ID of the snapshot you want to check the type of.
358-
3. Get more information about your snapshot, including its type. Make sure that you replace `<snapshot-id>` with the ID of the snapshot.
328+
2. Note the ID of the snapshot for which you want to check the type.
329+
330+
3. Run the command below to get information about your snapshot, including its type. Make sure that you replace `<snapshot-id>` with the ID of the snapshot.
331+
359332
```bash
360333
scw block snapshot get <snapshot-id>
361334
```
362-
An output similar to the following should display:
335+
336+
An output similar to the following displays:
337+
363338
```
364339
ID 92fa0096-30cf-4e7e-a1fe-2fbe73f524b9
365340
Name snap-busy-albattani

pages/object-storage/api-cli/bucket-operations.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Understanding Object Storage bucket operations
33
description: Perform various operations on buckets in Scaleway Object Storage using the CLI.
44
tags: object storage object-storage bucket
55
dates:
6-
validation: 2025-01-15
6+
validation: 2025-07-31
77
posted: 2018-09-14
88
---
99

@@ -34,7 +34,9 @@ aws s3 mb s3://bucketname
3434
This operation allows you to delete the bucket mentioned in the command.
3535

3636
<Message type="important">
37-
Deleting a bucket will also delete all of its objects. For safety measures, the effective deletion of the bucket will start 24 hours after the deletion request. The bucket name will then be available for other customers to use.<br /><br />The billing of your resources stops as soon as you request the deletion of your resources.<br /><br />Once you do so, the bucket and its objects and versions will no longer be displayed in the console or available via the API. For this reason, we recommend you delete all objects and versions in the bucket before requesting the deletion, if you wish the bucket deletion to be effective immediately.
37+
- Deleting a bucket will also delete all of its objects. For safety measures, the effective deletion of the bucket will start 24 hours after the deletion request. The bucket name will then be available for other customers to use.
38+
39+
- The billing of your resources stops as soon as you request the deletion of your resources. Once you do so, the bucket and its objects and versions will no longer be displayed in the console or available via the API. For this reason, we recommend you delete all objects and versions in the bucket before requesting the deletion, if you wish the bucket deletion to be effective immediately.
3840
</Message>
3941

4042
<Message type="note">

pages/object-storage/api-cli/bucket-policy.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Bucket policies overview
33
description: Implement and manage bucket policies in Scaleway Object Storage.
44
tags: object-storage bucket bucket-policy s3
55
dates:
6-
validation: 2024-12-24
6+
validation: 2025-07-30
77
posted: 2021-02-17
88
---
99
import StorageBucketPolicy from '@macros/storage/bucket-policy.mdx'
@@ -439,7 +439,7 @@ Bucket policies use a JSON-based access policy language, and are composed of str
439439
- `s3:GetObjectVersionTagging`
440440
- `s3:ListMultipartUploadParts`
441441
- `s3:PutObject`
442-
- `s3:PutObjectACL`
442+
- `s3:PutObjectAcl`
443443
- `s3:PutObjectLegalHold`
444444
- `s3:PutObjectRetention`
445445
- `s3:PutObjectTagging`

pages/object-storage/api-cli/bucket-website-api.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,13 @@ title: Setting up static websites on a bucket with the API
33
description: Configure bucket websites using the API in Scaleway Object Storage.
44
tags: object storage object-storage bucket static-website api
55
dates:
6-
validation: 2025-01-15
6+
validation: 2025-07-31
77
posted: 2021-02-17
88
---
99
import Requirements from '@macros/iam/requirements.mdx'
1010

1111

12-
The bucket website feature allows you to host static websites using Scaleway [Object Storage](https://www.scaleway.com/en/object-storage/).
13-
14-
It is possible to enable and configure the bucket website feature via the [AWS-CLI](/object-storage/api-cli/object-storage-aws-cli/).
12+
The bucket website feature allows you to host static websites using Scaleway [Object Storage](https://www.scaleway.com/en/object-storage/) via the [AWS CLI](/object-storage/api-cli/object-storage-aws-cli/).
1513

1614
To enable and configure the bucket website using the Scaleway console, refer to our [dedicated documentation](/object-storage/how-to/use-bucket-website/).
1715

@@ -26,7 +24,7 @@ To enable and configure the bucket website using the Scaleway console, refer to
2624

2725
To use the bucket website feature, you need to enable it on the bucket or buckets you wish to host your website on.
2826

29-
You can use an API call or the AWS-CLI to enable it using `put-bucket-website`.
27+
You can use an API call or the AWS CLI to enable it using `put-bucket-website`.
3028

3129
### Website JSON grammar
3230

pages/object-storage/api-cli/common-operations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Understanding common Object Storage operations
33
description: Perform common operations efficiently using Scaleway Object Storage CLI.
44
tags: object storage object-storage api api-operation getservice
55
dates:
6-
validation: 2025-01-15
6+
validation: 2025-07-31
77
posted: 2018-09-13
88
---
99

pages/object-storage/api-cli/generate-aws4-auth-signature.mdx

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,21 @@ title: Generating an AWSv4 authentication signature
33
description: Generate AWS Signature Version 4 for authentication in Scaleway Object Storage.
44
tags: object-storage object storage awsv4 aws authentication
55
dates:
6-
validation: 2025-01-15
6+
validation: 2025-07-31
77
posted: 2018-07-16
88
---
99
import Requirements from '@macros/iam/requirements.mdx'
1010

11+
Requests sent to the Object Storage API require an HTTP Authorization header. Scaleway Object Storage supports [AWS v4 signature](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) protocol to add an authentication signature to API requests.
1112

12-
Requests sent to the Object Storage API require an HTTP Authorization header.
13+
When using third-party tools such as [aws-cli](https://aws.amazon.com/cli/), [s3cmd](https://s3tools.org/s3cmd), [s3fs](https://github.com/s3fs-fuse/s3fs-fuse), or [MinIO Client](https://github.com/minio/mc), signatures are automatically generated for you.
1314

1415
<Requirements />
1516

1617
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
18+
- A valid [API key](/iam/how-to/create-api-keys/)
1719

18-
<Message type="note">
19-
Currently, the [AWS v4 signature type](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) is supported.
20-
</Message>
21-
22-
When using a client library such as [aws-cli](https://aws.amazon.com/cli/), [s3cmd](https://s3tools.org/s3cmd) or [s3fs](https://github.com/s3fs-fuse/s3fs-fuse), signatures are automatically generated by the library for you.
23-
24-
To generate the signature, you need to have an access key and secret key generated in the [Credentials section](https://console.scaleway.com/project/credentials) of your management console.
25-
26-
A v4 signature consists of different parts:
20+
An AWSv4 authentication signature consists of different parts:
2721

2822
AWS4-HMAC-SHA256
2923
: Indicates AWS Signature Version 4 (AWS4) and the signing algorithm (HMAC-SHA256).

pages/object-storage/api-cli/installing-minio-client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Installing and setting up MinIO Client
33
description: Install and configure the MinIO client for Scaleway Object Storage.
44
tags: object-storage object storage minio mc minio-client
55
dates:
6-
validation: 2025-01-15
6+
validation: 2025-07-31
77
posted: 2021-08-25
88
---
99
import Requirements from '@macros/iam/requirements.mdx'

pages/object-storage/api-cli/lifecycle-rules-api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Managing the lifecycle of objects
33
description: Use the API to manage lifecycle rules in Scaleway Object Storage.
44
tags: object storage object-storage lifecycle
55
dates:
6-
validation: 2024-12-24
6+
validation: 2025-07-31
77
posted: 2019-05-14
88
---
99
import Requirements from '@macros/iam/requirements.mdx'
@@ -206,7 +206,7 @@ When using the `awscli` to perform a [multipart upload](/object-storage/api-cli/
206206

207207
You can automate the removal of incomplete multipart uploads by adding or uploading a lifecycle configuration to your bucket. The setup can be done via an API call or an [AWS-CLI](/object-storage/api-cli/object-storage-aws-cli/) command.
208208

209-
Send a [putbucketlifecycleconfiguration](/object-storage/api-cli/bucket-operations/#putbucketlifecycleconfiguration) request with the following XML payload:
209+
Send a [PutBucketLifecycleConfiguration](/object-storage/api-cli/bucket-operations/#putbucketlifecycleconfiguration) request with the following XML payload:
210210

211211
```xml no-copy
212212
<?xml version="1.0" encoding="UTF-8"?>

0 commit comments

Comments
 (0)