1.3.0
This commit is contained in:
307
README.md
307
README.md
@@ -15,6 +15,7 @@
|
||||
- [Ошибки и исключения (exceptions)](#ошибки-и-исключения-exceptions)
|
||||
- [Ошибки валидации данных](#ошибки-валидации-данных)
|
||||
- [Ошибки HTTP](#ошибки-http)
|
||||
- [Ошибка несовместимости c API](#ошибка-несовместимости-с-api)
|
||||
- [Доступный функционал](#доступный-функционал)
|
||||
- [Способы авторизации](#способы-авторизации)
|
||||
- [Функции API](#функции-api)
|
||||
@@ -34,6 +35,7 @@
|
||||
|
||||
| Версия платформы | Версия SDK |
|
||||
| --- | --- |
|
||||
| 4.4.0 | 1.3.x |
|
||||
| 4.4.0 build 963 | 1.2.x |
|
||||
| 4.3.0 | 1.1.x |
|
||||
| 4.2.0 | 1.0.x |
|
||||
@@ -119,6 +121,24 @@ dx = Dynamix(
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Задание декораторов для всех вызываемых функций</summary>
|
||||
|
||||
```python
|
||||
from dynamix_sdk import Dynamix
|
||||
|
||||
|
||||
Dynamix(
|
||||
...,
|
||||
f_decorators=[decorator_1, decorator_2],
|
||||
)
|
||||
```
|
||||
|
||||
Декораторы будут применяться к вызываемым функциям SDK в обратном порядке, то есть сначала будет применяться декоратор <code>decorator_2</code>, а потом <code>decorator_1</code>.
|
||||
|
||||
**Важно:** декораторы должны соответствовать аннотации параметра, то есть оставлять без изменений параметры и тип возвращаемого значения функции, иначе применение декораторов приведёт к некорректной работе SDK.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Настройка повторных попыток при 503</summary>
|
||||
|
||||
По умолчанию SDK при получении кода ответа 503 производит 10 повторных попыток с интервалом 5 секунд. Данное поведение можно скорректировать:
|
||||
@@ -186,6 +206,24 @@ BVSAuth(
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Игнорирование проверки совместимости с API</summary>
|
||||
|
||||
**Важно:** игнорирование проверки совместимости с API может вызвать непредвиденные ошибки в работе SDK, поэтому использование данного функционала допустимо только принимая на себя всю ответственность за возможные последствия.
|
||||
|
||||
При игнорирование выводится только сообщение с предупреждением о несовместимости.
|
||||
|
||||
```python
|
||||
from dynamix_sdk import Dynamix
|
||||
|
||||
|
||||
Dynamix(
|
||||
...,
|
||||
ignore_api_compatibility=True,
|
||||
)
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Функциональный интерфейс
|
||||
|
||||
Функциональный интерфейс предоставляет функции, соответствующие функциям API платформы.
|
||||
@@ -477,6 +515,24 @@ except RequestException as e:
|
||||
|
||||
Подробную информацию об исключениях библиотеки **Requests** можно получить в [соответствующем разделе официальной документации Requests](https://requests.readthedocs.io/en/latest/user/quickstart/#errors-and-exceptions).
|
||||
|
||||
<details><summary>Использование исключения SDK</summary>
|
||||
|
||||
Для возможности получать дополнительную информацию о функциях SDK при ошибках HTTP-запросов, в SDK есть возможность оборачивать все исключения <code>requests.exceptions.RequestException</code> в исключение <code>dynamix_sdk.exceptions.RequestException</code>:
|
||||
|
||||
```python
|
||||
class RequestException(Exception):
|
||||
orig_exception: requests.exceptions.RequestException
|
||||
func_name: str
|
||||
func_kwargs: None | dict = None
|
||||
```
|
||||
|
||||
Чтобы включить использование исключения <code>dynamix_sdk.exceptions.RequestException</code>, необходимо передать в конструкторы классов <code>Dynamix</code>, <code>DECS3OAuth</code>, <code>BVSAuth</code> параметр <code>wrap_request_exceptions=True</code>
|
||||
</details>
|
||||
|
||||
#### Ошибка несовместимости с API
|
||||
SDK производит проверку совместимости с API.
|
||||
При несовместимости будет вызвано исключение `exceptions.IncompatibleAPIError`.
|
||||
|
||||
## Доступный функционал
|
||||
|
||||
### Способы авторизации
|
||||
@@ -499,6 +555,7 @@ except RequestException as e:
|
||||
- /cloudapi/account/disable
|
||||
- /cloudapi/account/enable
|
||||
- /cloudapi/account/get
|
||||
- /cloudapi/account/getResourceConsumption
|
||||
- /cloudapi/account/list
|
||||
- /cloudapi/account/listDeleted
|
||||
- /cloudapi/account/restore
|
||||
@@ -510,6 +567,7 @@ except RequestException as e:
|
||||
<details><summary>audit</summary>
|
||||
|
||||
- /cloudapi/audit/get
|
||||
- /cloudapi/audit/list
|
||||
|
||||
</details>
|
||||
|
||||
@@ -534,7 +592,12 @@ except RequestException as e:
|
||||
- /cloudapi/bservice/groupUpdateVins
|
||||
- /cloudapi/bservice/list
|
||||
- /cloudapi/bservice/listDeleted
|
||||
- /cloudapi/bservice/migrateToZone
|
||||
- /cloudapi/bservice/restore
|
||||
- /cloudapi/bservice/snapshotCreate
|
||||
- /cloudapi/bservice/snapshotDelete
|
||||
- /cloudapi/bservice/snapshotList
|
||||
- /cloudapi/bservice/snapshotRollback
|
||||
- /cloudapi/bservice/start
|
||||
- /cloudapi/bservice/stop
|
||||
|
||||
@@ -542,6 +605,7 @@ except RequestException as e:
|
||||
|
||||
<details><summary>compute</summary>
|
||||
|
||||
- /cloudapi/compute/abort_shared_snapshot_merge
|
||||
- /cloudapi/compute/affinityLabelRemove
|
||||
- /cloudapi/compute/affinityLabelSet
|
||||
- /cloudapi/compute/affinityRelations
|
||||
@@ -551,19 +615,41 @@ except RequestException as e:
|
||||
- /cloudapi/compute/antiAffinityRuleAdd
|
||||
- /cloudapi/compute/antiAffinityRuleRemove
|
||||
- /cloudapi/compute/antiAffinityRulesClear
|
||||
- /cloudapi/compute/attachGpu
|
||||
- /cloudapi/compute/attachPciDevice
|
||||
- /cloudapi/compute/bootDiskSet
|
||||
- /cloudapi/compute/cdEject
|
||||
- /cloudapi/compute/cdInsert
|
||||
- /cloudapi/compute/changeMac
|
||||
- /cloudapi/compute/change_mtu
|
||||
- /cloudapi/compute/change_security_groups
|
||||
- /cloudapi/compute/changeIp
|
||||
- /cloudapi/compute/changeLinkState
|
||||
- /cloudapi/compute/clone
|
||||
- /cloudapi/compute/clone_abort
|
||||
- /cloudapi/compute/createTemplate
|
||||
- /cloudapi/compute/delete
|
||||
- /cloudapi/compute/deleteCustomFields
|
||||
- /cloudapi/compute/detachGpu
|
||||
- /cloudapi/compute/detachPciDevice
|
||||
- /cloudapi/compute/disable
|
||||
- /cloudapi/compute/diskAdd
|
||||
- /cloudapi/compute/diskAttach
|
||||
- /cloudapi/compute/diskDel
|
||||
- /cloudapi/compute/diskDetach
|
||||
- /cloudapi/compute/diskResize
|
||||
- /cloudapi/compute/diskMigrate
|
||||
- /cloudapi/compute/diskSwitchToReplication
|
||||
- /cloudapi/compute/enable
|
||||
- /cloudapi/compute/get
|
||||
- /cloudapi/compute/getConsoleUrl
|
||||
- /cloudapi/compute/guest_agent_disable
|
||||
- /cloudapi/compute/guest_agent_enable
|
||||
- /cloudapi/compute/guest_agent_execute
|
||||
- /cloudapi/compute/guest_agent_feature_update
|
||||
- /cloudapi/compute/list
|
||||
- /cloudapi/compute/listDeleted
|
||||
- /cloudapi/compute/migrateToZone
|
||||
- /cloudapi/compute/moveToRg
|
||||
- /cloudapi/compute/netAttach
|
||||
- /cloudapi/compute/netDetach
|
||||
- /cloudapi/compute/pause
|
||||
@@ -571,9 +657,12 @@ except RequestException as e:
|
||||
- /cloudapi/compute/pfwDel
|
||||
- /cloudapi/compute/pfwList
|
||||
- /cloudapi/compute/pinToStack
|
||||
- /cloudapi/compute/powerCycle
|
||||
- /cloudapi/compute/reboot
|
||||
- /cloudapi/compute/redeploy
|
||||
- /cloudapi/compute/reset
|
||||
- /cloudapi/compute/resize
|
||||
- /cloudapi/compute/restore
|
||||
- /cloudapi/compute/resume
|
||||
- /cloudapi/compute/setCustomFields
|
||||
- /cloudapi/compute/snapshotCreate
|
||||
@@ -594,6 +683,7 @@ except RequestException as e:
|
||||
|
||||
<details><summary>disks</summary>
|
||||
|
||||
- /cloudapi/disks/change_disk_storage_policy
|
||||
- /cloudapi/disks/create
|
||||
- /cloudapi/disks/delete
|
||||
- /cloudapi/disks/deleteDisks
|
||||
@@ -642,6 +732,7 @@ except RequestException as e:
|
||||
|
||||
<details><summary>image</summary>
|
||||
|
||||
- /cloudapi/image/change_storage_policy
|
||||
- /cloudapi/image/create
|
||||
- /cloudapi/image/createVirtual
|
||||
- /cloudapi/image/delete
|
||||
@@ -664,11 +755,24 @@ except RequestException as e:
|
||||
|
||||
- /cloudapi/k8s/create
|
||||
- /cloudapi/k8s/delete
|
||||
- /cloudapi/k8s/deleteMasterFromGroup
|
||||
- /cloudapi/k8s/deleteWorkerFromGroup
|
||||
- /cloudapi/k8s/disable
|
||||
- /cloudapi/k8s/enable
|
||||
- /cloudapi/k8s/get
|
||||
- /cloudapi/k8s/getConfig
|
||||
- /cloudapi/k8s/getNodeAnnotations
|
||||
- /cloudapi/k8s/getNodeLabels
|
||||
- /cloudapi/k8s/getNodeTaints
|
||||
- /cloudapi/k8s/list
|
||||
- /cloudapi/k8s/listDeleted
|
||||
- /cloudapi/k8s/migrateToZone
|
||||
- /cloudapi/k8s/restore
|
||||
- /cloudapi/k8s/start
|
||||
- /cloudapi/k8s/stop
|
||||
- /cloudapi/k8s/update
|
||||
- /cloudapi/k8s/updateWorkerNodesMetaData
|
||||
- /cloudapi/k8s/workerAdd
|
||||
- /cloudapi/k8s/workerReset
|
||||
- /cloudapi/k8s/workerRestart
|
||||
- /cloudapi/k8s/workersGroupAdd
|
||||
@@ -692,6 +796,7 @@ except RequestException as e:
|
||||
- /cloudapi/lb/backendServerDelete
|
||||
- /cloudapi/lb/backendServerUpdate
|
||||
- /cloudapi/lb/backendUpdate
|
||||
- /cloudapi/lb/configReset
|
||||
- /cloudapi/lb/create
|
||||
- /cloudapi/lb/delete
|
||||
- /cloudapi/lb/disable
|
||||
@@ -705,6 +810,13 @@ except RequestException as e:
|
||||
- /cloudapi/lb/list
|
||||
- /cloudapi/lb/listDeleted
|
||||
- /cloudapi/lb/makeHighlyAvailable
|
||||
- /cloudapi/lb/migrateToZone
|
||||
- /cloudapi/lb/restart
|
||||
- /cloudapi/lb/restore
|
||||
- /cloudapi/lb/start
|
||||
- /cloudapi/lb/stop
|
||||
- /cloudapi/lb/update
|
||||
- /cloudapi/lb/updateSysctlParams
|
||||
|
||||
</details>
|
||||
|
||||
@@ -715,16 +827,26 @@ except RequestException as e:
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>pcidevice</summary>
|
||||
|
||||
- /cloudapi/pcidevice/list
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>rg</summary>
|
||||
|
||||
- /cloudapi/rg/accessGrant
|
||||
- /cloudapi/rg/accessRevoke
|
||||
- /cloudapi/rg/add_storage_policy
|
||||
- /cloudapi/rg/create
|
||||
- /cloudapi/rg/del_storage_policy
|
||||
- /cloudapi/rg/delete
|
||||
- /cloudapi/rg/disable
|
||||
- /cloudapi/rg/enable
|
||||
- /cloudapi/rg/get
|
||||
- /cloudapi/rg/getResourceConsumption
|
||||
- /cloudapi/rg/list
|
||||
- /cloudapi/rg/listDeleted
|
||||
- /cloudapi/rg/removeDefNet
|
||||
- /cloudapi/rg/restore
|
||||
- /cloudapi/rg/setDefNet
|
||||
@@ -732,6 +854,24 @@ except RequestException as e:
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>security_group</summary>
|
||||
|
||||
- /cloudapi/security_group/get
|
||||
- /cloudapi/security_group/create
|
||||
- /cloudapi/security_group/create_rule
|
||||
- /cloudapi/security_group/delete
|
||||
- /cloudapi/security_group/delete_rule
|
||||
- /cloudapi/security_group/list
|
||||
- /cloudapi/security_group/update
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>sep</summary>
|
||||
|
||||
- /cloudapi/sep/listAvailableSepAndPools
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>stack</summary>
|
||||
|
||||
- /cloudapi/stack/get
|
||||
@@ -739,6 +879,13 @@ except RequestException as e:
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>storage_policy</summary>
|
||||
|
||||
- /cloudapi/storage_policy/get
|
||||
- /cloudapi/storage_policy/list
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>tasks</summary>
|
||||
|
||||
- /cloudapi/tasks/get
|
||||
@@ -746,11 +893,33 @@ except RequestException as e:
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>trunk</summary>
|
||||
|
||||
- /cloudapi/trunk/get
|
||||
- /cloudapi/trunk/list
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>user</summary>
|
||||
|
||||
- /cloudapi/user/apiList
|
||||
- /cloudapi/user/brief
|
||||
- /cloudapi/user/get
|
||||
- /cloudapi/user/getAudit
|
||||
- /cloudapi/user/getResourceConsumption
|
||||
- /cloudapi/user/setData
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>vfpool</summary>
|
||||
|
||||
- /cloudapi/vfpool/get
|
||||
- /cloudapi/vfpool/list
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>vgpu</summary>
|
||||
|
||||
- /cloudapi/vgpu/list
|
||||
|
||||
</details>
|
||||
|
||||
@@ -760,13 +929,21 @@ except RequestException as e:
|
||||
- /cloudapi/vins/createInRG
|
||||
- /cloudapi/vins/delete
|
||||
- /cloudapi/vins/disable
|
||||
- /cloudapi/vins/dnsApply
|
||||
- /cloudapi/vins/enable
|
||||
- /cloudapi/vins/extNetConnect
|
||||
- /cloudapi/vins/extNetDisconnect
|
||||
- /cloudapi/vins/extNetList
|
||||
- /cloudapi/vins/get
|
||||
- /cloudapi/vins/ipList
|
||||
- /cloudapi/vins/ipRelease
|
||||
- /cloudapi/vins/ipReserve
|
||||
- /cloudapi/vins/list
|
||||
- /cloudapi/vins/listDeleted
|
||||
- /cloudapi/vins/migrateToZone
|
||||
- /cloudapi/vins/natRuleAdd
|
||||
- /cloudapi/vins/natRuleDel
|
||||
- /cloudapi/vins/natRuleList
|
||||
- /cloudapi/vins/restore
|
||||
- /cloudapi/vins/staticRouteAdd
|
||||
- /cloudapi/vins/staticRouteDel
|
||||
@@ -776,16 +953,142 @@ except RequestException as e:
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>zone</summary>
|
||||
|
||||
- /cloudapi/zone/get
|
||||
- /cloudapi/zone/list
|
||||
|
||||
</details>
|
||||
|
||||
#### Cloudbroker
|
||||
|
||||
<details><summary>account</summary>
|
||||
|
||||
- /cloudbroker/account/add_storage_policy
|
||||
- /cloudbroker/account/addUser
|
||||
- /cloudbroker/account/addZone
|
||||
- /cloudbroker/account/create
|
||||
- /cloudbroker/account/del_storage_policy
|
||||
- /cloudbroker/account/delete
|
||||
- /cloudbroker/account/deleteAccounts
|
||||
- /cloudbroker/account/deleteUser
|
||||
- /cloudbroker/account/disable
|
||||
- /cloudbroker/account/disableAccounts
|
||||
- /cloudbroker/account/enable
|
||||
- /cloudbroker/account/enableAccounts
|
||||
- /cloudbroker/account/get
|
||||
- /cloudbroker/account/getResourceConsumption
|
||||
- /cloudbroker/account/list
|
||||
- /cloudbroker/account/listDeleted
|
||||
- /cloudbroker/account/removeZone
|
||||
- /cloudbroker/account/restore
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>audit</summary>
|
||||
|
||||
- /cloudbroker/audit/list
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>compute</summary>
|
||||
|
||||
- /cloudbroker/compute/change_security_groups
|
||||
- /cloudbroker/compute/clone
|
||||
- /cloudbroker/compute/clone_abort
|
||||
- /cloudbroker/compute/migrate_storage_list
|
||||
- /cloudbroker/compute/start_migration_in
|
||||
- /cloudbroker/compute/start_migration_out
|
||||
- /cloudbroker/compute/stop_migration_in
|
||||
- /cloudbroker/compute/stop_migration_out
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>disks</summary>
|
||||
|
||||
- /cloudbroker/disks/migrate
|
||||
- /cloudbroker/disks/migrate_abort
|
||||
- /cloudbroker/disks/migrate_status
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>image</summary>
|
||||
|
||||
- /cloudbroker/image/change_storage_policy
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>node</summary>
|
||||
|
||||
- cloudbroker/node/add_ssh_identity
|
||||
- cloudbroker/node/get_ssh_identity
|
||||
- cloudbroker/node/update_description
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>rg</summary>
|
||||
|
||||
- /cloudbroker/rg/add_storage_policy
|
||||
- /cloudbroker/rg/del_storage_policy
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>security_group</summary>
|
||||
|
||||
- /cloudbroker/security_group/create
|
||||
- /cloudbroker/security_group/create_rule
|
||||
- /cloudbroker/security_group/delete
|
||||
- /cloudbroker/security_group/delete_rule
|
||||
- /cloudbroker/security_group/get
|
||||
- /cloudbroker/security_group/list
|
||||
- /cloudbroker/security_group/update
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>storage_policy</summary>
|
||||
|
||||
- /cloudbroker/storage_policy/add_pool
|
||||
- /cloudbroker/storage_policy/create
|
||||
- /cloudbroker/storage_policy/delete
|
||||
- /cloudbroker/storage_policy/delete_pool
|
||||
- /cloudbroker/storage_policy/disable
|
||||
- /cloudbroker/storage_policy/enable
|
||||
- /cloudbroker/storage_policy/get
|
||||
- /cloudbroker/storage_policy/list
|
||||
- /cloudbroker/storage_policy/update
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>user</summary>
|
||||
|
||||
- /cloudbroker/user/block
|
||||
- /cloudbroker/user/create
|
||||
- /cloudbroker/user/get
|
||||
- /cloudbroker/user/list
|
||||
- /cloudbroker/user/unblock
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>vins</summary>
|
||||
|
||||
- /cloudbroker/vins/update
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>vnfdev</summary>
|
||||
|
||||
- /cloudbroker/vnfdev/migrate_abort
|
||||
|
||||
</details>
|
||||
|
||||
#### System
|
||||
|
||||
<details><summary>info</summary>
|
||||
|
||||
- /system/info/version
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>usermanager</summary>
|
||||
|
||||
- /system/usermanager/whoami
|
||||
|
||||
Reference in New Issue
Block a user