add: documentation

2026-06-30 15:45:24 +04:00
parent 540c1f7293
commit ca276d200f
1055 changed files with 47294 additions and 0 deletions
@@ -0,0 +1,51 @@
+# Operations: nubes_s3
+
+| Operation | Kind | Action | Subresource | ID | Params | Description |
+|---|---|---|---|---|---|---|
+| `create` | `instance` | `create` | `` | `1` | resourceRealm, displayName |  |
+| `create_sub_user` | `subresource` | `create` | `sub_user` | `6` | subUserName, subUserAccess |  |
+| `delete` | `instance` | `delete` | `` | `5` |  |  |
+| `delete_sub_user` | `subresource` | `delete` | `sub_user` | `7` | subUserName |  |
+| `modify` | `instance` | `modify` | `` | `4` | maxSizeGbPerUser, maxObjectsPerBucket, maxBucketsPerUser | При первичном вызове операции услуга Trial прекращает действие |
+| `resume` | `instance` | `resume` | `` | `3` |  |  |
+| `suspend` | `instance` | `suspend` | `` | `2` |  |  |
+
+## Operation: create
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `resourceRealm` | `` | `ДА` | `` | Платформа для развертывания | кластер S3 для подключения | func=getAvailableResourceRealms | `163` |
+| `displayName` | `string` | `ДА` | `` | Человеко-читаемое имя (транслит из Elma) - передаётся имя клиента |  |  | `320` |
+
+## Operation: create_sub_user
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `subUserName` | `string` | `ДА` | `` |  |  |  | `60` |
+| `subUserAccess` | `string` | `ДА` | `` |  |  | value_list=read, write, readwrite, full | `61` |
+
+## Operation: delete
+
+None.
+
+## Operation: delete_sub_user
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `subUserName` | `string` | `ДА` | `` | subUserName. По идее услуга уже создана - должен передаваться из ЛК |  |  | `63` |
+
+## Operation: modify
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `maxSizeGbPerUser` | `integer` | `НЕТ` | `` | maxSizeGb. Передаём руками | maxSizeGb. Передаём руками | minvalue=-1; maxvalue=50000 | `50` |
+| `maxObjectsPerBucket` | `integer &gt; 0` | `НЕТ` | `` | Квота на бакет. Кол-во объектов. Передаём руками | Квота на бакет. Кол-во объектов. Передаём руками | minvalue=1; maxvalue=1e+07 | `51` |
+| `maxBucketsPerUser` | `integer &gt; 0` | `НЕТ` | `` | Квота на пользователя. Количество бакетов пользователя. Передаём руками | Квота на пользователя. Количество бакетов пользователя. Передаём руками | minvalue=1; maxvalue=1000 | `52` |
+
+## Operation: resume
+
+None.
+
+## Operation: suspend
+
+None.