add: documentation
This commit is contained in:
@@ -0,0 +1,22 @@
|
||||
# Operations: nubes_s3bucket
|
||||
|
||||
| Operation | Kind | Action | Subresource | ID | Params | Description |
|
||||
|---|---|---|---|---|---|---|
|
||||
| `create` | `instance` | `create` | `` | `51` | s3UserUid, bucketName, maxSize, readAll, listAll, corsAll, placement | |
|
||||
| `delete` | `instance` | `delete` | `` | `52` | | |
|
||||
|
||||
## Operation: create
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `s3UserUid` | `uuid` | `ДА` | `` | UID Корневой услуги S3. На основе него будет создан бакет. | | ref_svc_id=12 | `124` |
|
||||
| `bucketName` | `string` | `ДА` | `` | Имя бакета s3 | | | `125` |
|
||||
| `maxSize` | `` | `ДА` | `-1` | Максимальный размер бакета s3. Если поставить -1, будет безлимит. Размер указывается в Bytes | Максимальный размер бакета s3. Если поставить 0, будет безлимит. Размер указывается в Bytes | | `126` |
|
||||
| `readAll` | `boolean` | `ДА` | `false` | Публичный доступ на чтение позволяет любому пользователю интернета скачивать объекты из бакета. | | value_list=false, true | `127` |
|
||||
| `listAll` | `boolean` | `ДА` | `false` | Публичный доступ к листингу позволяет любому пользователю интернета получить список объектов в бакете. | | value_list=false, true | `128` |
|
||||
| `corsAll` | `boolean` | `ДА` | `false` | Публичный доступ к чтению настроек позволяет любому пользователю интернета читать конфигурации CORS | | value_list=false, true | `129` |
|
||||
| `placement` | `string` | `ДА` | `HOT` | Класс хранилища, который используется по умолчанию при загрузке объектов. Чем холоднее, тем дешевле место, но дороже обращения | | value_list=HOT, COLD | `130` |
|
||||
|
||||
## Operation: delete
|
||||
|
||||
None.
|
||||
Reference in New Issue
Block a user