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,41 @@
+# Operations: nubes_vcexternalip
+
+| Operation | Kind | Action | Subresource | ID | Params | Description |
+|---|---|---|---|---|---|---|
+| `create` | `instance` | `create` | `` | `56` | serviceUid, dnatCreate, internalPortAccess, snatCreate, internalAddrAccess, fromServiceNamespace, fromServiceCloudEdgeName, fromServiceCloudVdcName, fromServiceCloudOrgName, fromServiceCloudVmwareUrl, ipSpaceName, resourceRealm, fromServiceCloudEdgeScope, fromServiceVdcGroupName |  |
+| `delete` | `instance` | `delete` | `` | `57` |  |  |
+| `modify` | `instance` | `modify` | `` | `197` | serviceUid, ipSpaceName, dnatCreate, snatCreate, internalPortAccess, internalAddrAccess |  |
+
+## Operation: create
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `serviceUid` | `string` | `ДА` | `` |  |  |  | `140` |
+| `dnatCreate` | `boolean` | `ДА` | `true` | Необходимо создать DNAT-правило. |  |  | `141` |
+| `internalPortAccess` | `string` | `ДА` | `5432` | Порт для связки ната с адресом. Несколько значений можно передавать через пробел. Если передать all, то dnat будет на все порты. Требует dnatCreate=true<br/> |  |  | `142` |
+| `snatCreate` | `boolean` | `НЕТ` | `` | Необходимо создать SNAT-правило.<br/> |  |  | `143` |
+| `internalAddrAccess` | `string` | `ДА` | `` | Внутренний адрес для связки ната. Требует dnatCreate=true или snatCreate=true |  |  | `144` |
+| `fromServiceNamespace` | `string` | `ДА` | `` | Namespace составной услуги (для отображения правил FW) |  |  | `324` |
+| `fromServiceCloudEdgeName` | `string` | `НЕТ` | `` | Edge составной услуги (указывать, если resourceRealm связан с CloudDirector) |  |  | `325` |
+| `fromServiceCloudVdcName` | `` | `НЕТ` | `` | Vdc составной услуги (указывать, если resourceRealm связан с CloudDirector) |  |  | `326` |
+| `fromServiceCloudOrgName` | `string` | `НЕТ` | `` | Org составной услуги (указывать, если resourceRealm связан с CloudDirector) |  |  | `327` |
+| `fromServiceCloudVmwareUrl` | `string` | `НЕТ` | `` | Api-Url составной услуги (указывать, если resourceRealm связан с CloudDirector) |  |  | `328` |
+| `ipSpaceName` | `string` | `ДА` | `` | Тип ip Space (internet-ipv4-v1 / internet-antiddos-v1 / internet-no-antiddos-v1) |  |  | `336` |
+| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания |  | func=getAvailableResourceRealms | `488` |
+| `fromServiceCloudEdgeScope` | `string` | `НЕТ` | `` |  |  |  | `624` |
+| `fromServiceVdcGroupName` | `string` | `НЕТ` | `` |  |  |  | `626` |
+
+## Operation: delete
+
+None.
+
+## Operation: modify
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `serviceUid` | `string` | `ДА` | `` |  |  |  | `627` |
+| `ipSpaceName` | `string` | `ДА` | `` |  |  |  | `628` |
+| `dnatCreate` | `boolean` | `ДА` | `` |  |  |  | `629` |
+| `snatCreate` | `boolean` | `ДА` | `` |  |  |  | `630` |
+| `internalPortAccess` | `string` | `ДА` | `` |  |  |  | `631` |
+| `internalAddrAccess` | `string` | `ДА` | `` |  |  |  | `632` |