add: documentation
This commit is contained in:
@@ -0,0 +1,38 @@
|
||||
# Operations: nubes_akhq
|
||||
|
||||
| Operation | Kind | Action | Subresource | ID | Params | Description |
|
||||
|---|---|---|---|---|---|---|
|
||||
| `create` | `instance` | `create` | `` | `175` | resourceRealm, resourceMemory, resourceCPU, domain, resourceInstances, kafkaUid | |
|
||||
| `delete` | `instance` | `delete` | `` | `176` | | |
|
||||
| `modify` | `instance` | `modify` | `` | `180` | kafkaUid | |
|
||||
| `resume` | `instance` | `resume` | `` | `178` | | |
|
||||
| `suspend` | `instance` | `suspend` | `` | `177` | | |
|
||||
|
||||
## Operation: create
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `resourceRealm` | `string` | `ДА` | `` | Выбрать платформу из списка | | func=getAvailableResourceRealms | `550` |
|
||||
| `resourceMemory` | `integer > 0` | `ДА` | `512` | Пример: `1024` | | minvalue=512 | `551` |
|
||||
| `resourceCPU` | `integer > 0` | `ДА` | `500` | Пример: `1000` | | minvalue=500 | `552` |
|
||||
| `domain` | `string` | `ДА` | `` | Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm | | regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$ | `553` |
|
||||
| `resourceInstances` | `integer > 0` | `ДА` | `1` | | | minvalue=1 | `554` |
|
||||
| `kafkaUid` | `uuid` | `ДА` | `` | Выбрать кластер из списка | | ref_svc_id=116 | `555` |
|
||||
|
||||
## Operation: delete
|
||||
|
||||
None.
|
||||
|
||||
## Operation: modify
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `kafkaUid` | `uuid` | `ДА` | `` | Выбрать кластер из списка | | ref_svc_id=116 | `565` |
|
||||
|
||||
## Operation: resume
|
||||
|
||||
None.
|
||||
|
||||
## Operation: suspend
|
||||
|
||||
None.
|
||||
Reference in New Issue
Block a user