add: documentation
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
# Operations: nubes_mongodb
|
||||
|
||||
| Operation | Kind | Action | Subresource | ID | Params | Description |
|
||||
|---|---|---|---|---|---|---|
|
||||
| `create` | `instance` | `create` | `` | `37` | resourceInstances, resourceMemory, resourceCPU, resourceDisk, resourceRealm, needExternalAddressMaster, ipSpaceNameMaster | |
|
||||
| `create_user` | `subresource` | `create` | `user` | `198` | username, dbName, role | |
|
||||
| `delete` | `instance` | `delete` | `` | `190` | | |
|
||||
| `delete_user` | `subresource` | `delete` | `user` | `199` | username | |
|
||||
| `modify_user` | `subresource` | `modify` | `user` | `200` | username, dbName, role | |
|
||||
| `resume` | `instance` | `resume` | `` | `196` | | |
|
||||
| `suspend` | `instance` | `suspend` | `` | `194` | | |
|
||||
|
||||
## Operation: create
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `resourceInstances` | `integer > 0` | `ДА` | `` | Пример: `2` | | minvalue=1; maxvalue=7 | `487` |
|
||||
| `resourceMemory` | `integer > 0` | `ДА` | `` | Пример: `2048` | | minvalue=1000 | `588` |
|
||||
| `resourceCPU` | `integer > 0` | `ДА` | `` | Пример: `1000` | | | `589` |
|
||||
| `resourceDisk` | `integer > 0` | `ДА` | `` | Пример: `20` | | | `590` |
|
||||
| `resourceRealm` | `string` | `ДА` | `` | Выбрать платформу из списка | | func=getAvailableResourceRealms | `595` |
|
||||
| `needExternalAddressMaster` | `string` | `ДА` | `false` | Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false` | | value_list=false, true | `645` |
|
||||
| `ipSpaceNameMaster` | `string` | `НЕТ` | `` | Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1` | | | `646` |
|
||||
|
||||
## Operation: create_user
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `username` | `string` | `ДА` | `` | | | | `635` |
|
||||
| `dbName` | `string` | `ДА` | `` | | | | `636` |
|
||||
| `role` | `string` | `ДА` | `` | | | value_list=dbOwner, read, readWrite | `643` |
|
||||
|
||||
## Operation: delete
|
||||
|
||||
None.
|
||||
|
||||
## Operation: delete_user
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `username` | `string` | `ДА` | `` | | | | `644` |
|
||||
|
||||
## Operation: modify_user
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `username` | `string` | `ДА` | `` | | | | `640` |
|
||||
| `dbName` | `string` | `ДА` | `` | | | | `641` |
|
||||
| `role` | `string` | `ДА` | `` | | | value_list=dbOwner, read, readWrite | `642` |
|
||||
|
||||
## Operation: resume
|
||||
|
||||
None.
|
||||
|
||||
## Operation: suspend
|
||||
|
||||
None.
|
||||
Reference in New Issue
Block a user