v1.6.13
This commit is contained in:
555
README.md
555
README.md
@@ -11,50 +11,34 @@ Decort SDK - это библиотека, написанная на языке G
|
||||
- Версия 1.4.x Decort-SDK соответствует 3.8.6 версии платформы
|
||||
- Версия 1.5.x Decort-SDK соответствует 3.8.7 версии платформы
|
||||
- Версия 1.6.x Decort-SDK соответствует 3.8.8 версии платформы
|
||||
- Версия 1.7.х Decort-SDK соответствует 3.8.9 версии платформы
|
||||
|
||||
## Оглавление
|
||||
|
||||
- [Установка](#установка)
|
||||
- [Список API](#список-api)
|
||||
- [Cloudapi](#cloudapi)
|
||||
- [Cloudbroker](#cloudbroker)
|
||||
- [Cloudapi](#cloudapi)
|
||||
- [Cloudbroker](#cloudbroker)
|
||||
- [Работа с библиотекой](#работа-с-библиотекой)
|
||||
- [Настройка конфигурации клиента](#настройка-конфигурации-клиента)
|
||||
- [Пример конфигурации клиента](#пример-конфигурации-клиента)
|
||||
- [Парсинг конфигурации из файла](#парсинг-конфигурации-из-файла)
|
||||
- [Пример JSON конфигурации](#пример-json-конфигурации)
|
||||
- [Пример YAML конфигурации](#пример-yaml-конфигурации)
|
||||
- [Создание клиента](#создание-клиента)
|
||||
- [Создание структуры запроса](#cоздание-структуры-запроса)
|
||||
- [Выполнение запроса](#выполнение-запроса)
|
||||
- [Фильтрация](#фильтрация)
|
||||
- [Сортировка](#сортировка)
|
||||
- [Сериализация](#сериализация)
|
||||
- [Получение списка уникальных идентификаторов (ID) объекта](#получение-списка-уникальных-идентификаторов-id-объекта)
|
||||
- [Настройка конфигурации клиента](#настройка-конфигурации-клиента)
|
||||
- [Пример конфигурации клиента](#пример-конфигурации-клиента)
|
||||
- [Парсинг конфигурации из файла](#парсинг-конфигурации-из-файла)
|
||||
- [Пример JSON конфигурации](#пример-json-конфигурации)
|
||||
- [Пример YAML конфигурации](#пример-yaml-конфигурации)
|
||||
- [Создание клиента](#создание-клиента)
|
||||
- [Создание структуры запроса](#cоздание-структуры-запроса)
|
||||
- [Выполнение запроса](#выполнение-запроса)
|
||||
- [Фильтрация](#фильтрация)
|
||||
- [Сортировка](#сортировка)
|
||||
- [Сериализация](#сериализация)
|
||||
- [Работа с legacy клиентом](#работа-с-legacy-клиентом)
|
||||
- [Настройка конфигурации legacy клиента](#настройка-конфигурации-legacy-клиента)
|
||||
- [Пример конфигурации legacy клиента](#пример-конфигурации-legacy-клиента)
|
||||
- [Парсинг legacy конфигурации из файла](#парсинг-legacy-конфигурации-из-файла)
|
||||
- [Пример legacy JSON конфигурации](#пример-legacy-json-конфигурации)
|
||||
- [Пример legacy YAML конфигурации](#пример-legacy-yaml-конфигурации)
|
||||
- [Создание legacy клиента](#создание-legacy-клиента)
|
||||
- [Создание структуры запроса](#cоздание-структуры-запроса)
|
||||
- [Выполнение запроса](#выполнение-запроса)
|
||||
- [Работа с BVS клиентом](#работа-с-bvs-клиентом)
|
||||
- [Настройка параметров BVS в кабинете администратора](#настройка-параметров-bvs-в-кабинете-администратора)
|
||||
- [Настройка конфигурации BVS клиента](#настройка-конфигурации-bvs-клиента)
|
||||
- [Описание структуры token](#описание-структуры-token)
|
||||
- [Пример конфигурации BVS клиента](#пример-конфигурации-bvs-клиента)
|
||||
- [Парсинг BVS конфигурации из файла](#парсинг-bvs-конфигурации-из-файла)
|
||||
- [Парсинг BVS токена из файла](#парсинг-bvs-токена-из-файла)
|
||||
- [Пример BVS JSON конфигурации](#пример-bvs-json-конфигурации)
|
||||
- [Пример BVS YAML конфигурации](#пример-bvs-yaml-конфигурации)
|
||||
- [Создание BVS клиента](#создание-bvs-клиента)
|
||||
- [Пример создания BVS клиента](#пример-создания-bvs-клиента)
|
||||
- [Пример получения BVS токена](#пример-получения-bvs-токена)
|
||||
- [Пример обновления BVS токена](#пример-обновления-bvs-токена)
|
||||
- [Пример выполнения запроса](#пример-выполнения-запроса)
|
||||
- [Настройка конфигурации legacy клиента](#настройка-конфигурации-legacy-клиента)
|
||||
- [Пример конфигурации legacy клиента](#пример-конфигурации-legacy-клиента)
|
||||
- [Парсинг legacy конфигурации из файла](#парсинг-legacy-конфигурации-из-файла)
|
||||
- [Пример legacy JSON конфигурации](#пример-legacy-json-конфигурации)
|
||||
- [Пример legacy YAML конфигурации](#пример-legacy-yaml-конфигурации)
|
||||
- [Создание legacy клиента](#создание-legacy-клиента)
|
||||
- [Создание структуры запроса](#cоздание-структуры-запроса)
|
||||
- [Выполнение запроса](#выполнение-запроса)
|
||||
|
||||
## Установка
|
||||
|
||||
@@ -129,8 +113,8 @@ go get -u repository.basistech.ru/BASIS/decort-golang-sdk
|
||||
Алгоритм работы с библиотекой выглядит следующим образом:
|
||||
|
||||
1. Выполнение одного из действий:
|
||||
- настройка конфигурации клиента;
|
||||
- парсинг конфигурации из файла.
|
||||
- настройка конфигурации клиента;
|
||||
- парсинг конфигурации из файла.
|
||||
2. Создание клиента.
|
||||
3. Создание структуры запроса.
|
||||
4. Выполнение запроса.
|
||||
@@ -172,7 +156,7 @@ func main(){
|
||||
|
||||
#### Парсинг конфигурации из файла
|
||||
|
||||
Также возможно создать переменную конфигурации из JSON или YAML файла, используя функцию `ParseConfigJSON` (или `ParseConfigYAML`) из пакета config.
|
||||
Также возможно создать переменную конфигурации из JSON или YAML файла, используя функцию `ParseConfigJSON` (или `ParseConfigYAML`) из пакета config.
|
||||
<br>
|
||||
*См. пример файлов конфигурации ниже и в директории `samples/`.*
|
||||
|
||||
@@ -183,7 +167,7 @@ import (
|
||||
|
||||
func main() {
|
||||
// Парсинг конфигурации из JSON-файла
|
||||
cfg, _ := config.ParseConfigJSON("<PATH>")
|
||||
cfg := config.ParseConfigJSON("<PATH>")
|
||||
}
|
||||
```
|
||||
|
||||
@@ -254,48 +238,48 @@ func main() {
|
||||
В каждом пакете находятся пакеты групп API:
|
||||
|
||||
- **cloudapi**:
|
||||
- `pkg/cloudapi/account` - для `Account`
|
||||
- `pkg/cloudapi/bservice` - для `Basic Service`
|
||||
- `pkg/cloudapi/compute` - для `Compute`
|
||||
- `pkg/cloudapi/disks` - для `Disks`
|
||||
- `pkg/cloudapi/extnet` - для `ExtNet`
|
||||
- `pkg/cloudapi/flipgroup` - для `FLIPGroup`
|
||||
- `pkg/cloudapi/image` - для `Image`
|
||||
- `pkg/cloudapi/k8ci` - для `K8CI`
|
||||
- `pkg/cloudapi/k8s` - для `K8S`
|
||||
- `pkg/cloudapi/kvmppc` - для `KVMPPC`
|
||||
- `pkg/cloudapi/kvmx86` - для `KVMX86`
|
||||
- `pkg/cloudapi/lb` - для `LB`
|
||||
- `pkg/cloudapi/locations` - для `Locations`
|
||||
- `pkg/cloudapi/rg` - для `RG`
|
||||
- `pkg/cloudapi/sizes` - для `Sizes`
|
||||
- `pkg/cloudapi/stack` - для `Stack`
|
||||
- `pkg/cloudapi/tasks` - для `Tasks`
|
||||
- `pkg/cloudapi/vins` - для `VINS`
|
||||
- `pkg/cloudapi/account` - для `Account`
|
||||
- `pkg/cloudapi/bservice` - для `Basic Service`
|
||||
- `pkg/cloudapi/compute` - для `Compute`
|
||||
- `pkg/cloudapi/disks` - для `Disks`
|
||||
- `pkg/cloudapi/extnet` - для `ExtNet`
|
||||
- `pkg/cloudapi/flipgroup` - для `FLIPGroup`
|
||||
- `pkg/cloudapi/image` - для `Image`
|
||||
- `pkg/cloudapi/k8ci` - для `K8CI`
|
||||
- `pkg/cloudapi/k8s` - для `K8S`
|
||||
- `pkg/cloudapi/kvmppc` - для `KVMPPC`
|
||||
- `pkg/cloudapi/kvmx86` - для `KVMX86`
|
||||
- `pkg/cloudapi/lb` - для `LB`
|
||||
- `pkg/cloudapi/locations` - для `Locations`
|
||||
- `pkg/cloudapi/rg` - для `RG`
|
||||
- `pkg/cloudapi/sizes` - для `Sizes`
|
||||
- `pkg/cloudapi/stack` - для `Stack`
|
||||
- `pkg/cloudapi/tasks` - для `Tasks`
|
||||
- `pkg/cloudapi/vins` - для `VINS`
|
||||
- **cloudbroker**:
|
||||
- `pkg/cloudbroker/account` - для `Account`
|
||||
- `pkg/cloudbroker/apiaccess` - для `APIAccess`
|
||||
- `pkg/cloudbroker/backup` - для `Backup`
|
||||
- `pkg/cloudbroker/compute` - для `Compute`
|
||||
- `pkg/cloudbroker/disks` - для `Disks`
|
||||
- `pkg/cloudbroker/extnet` - для `ExtNet`
|
||||
- `pkg/cloudbroker/flipgroup` - для `FLIPGroup`
|
||||
- `pkg/cloudbroker/grid` - для `Grid`
|
||||
- `pkg/cloudbroker/group` - для `Group`
|
||||
- `pkg/cloudbroker/image` - для `Image`
|
||||
- `pkg/cloudbroker/k8ci` - для `K8CI`
|
||||
- `pkg/cloudbroker/k8s` - для `K8S`
|
||||
- `pkg/cloudbroker/kvmppc` - для `KVMPPC`
|
||||
- `pkg/cloudbroker/kvmx86` - для `KVMX86`
|
||||
- `pkg/cloudbroker/lb` - для `LB`
|
||||
- `pkg/cloudbroker/pcidevice` - для `PCIDevice`
|
||||
- `pkg/cloudbroker/rg` - для `RG`
|
||||
- `pkg/cloudbroker/sep` - для `SEP`
|
||||
- `pkg/cloudbroker/stack` - для `Stack`
|
||||
- `pkg/cloudbroker/tasks` - для `Tasks`
|
||||
- `pkg/cloudbroker/user` - для `User`
|
||||
- `pkg/cloudbroker/vgpu` - для `VGPU`
|
||||
- `pkg/cloudbroker/vins` - для `VINS`
|
||||
- `pkg/cloudbroker/account` - для `Account`
|
||||
- `pkg/cloudbroker/apiaccess` - для `APIAccess`
|
||||
- `pkg/cloudbroker/backup` - для `Backup`
|
||||
- `pkg/cloudbroker/compute` - для `Compute`
|
||||
- `pkg/cloudbroker/disks` - для `Disks`
|
||||
- `pkg/cloudbroker/extnet` - для `ExtNet`
|
||||
- `pkg/cloudbroker/flipgroup` - для `FLIPGroup`
|
||||
- `pkg/cloudbroker/grid` - для `Grid`
|
||||
- `pkg/cloudbroker/group` - для `Group`
|
||||
- `pkg/cloudbroker/image` - для `Image`
|
||||
- `pkg/cloudbroker/k8ci` - для `K8CI`
|
||||
- `pkg/cloudbroker/k8s` - для `K8S`
|
||||
- `pkg/cloudbroker/kvmppc` - для `KVMPPC`
|
||||
- `pkg/cloudbroker/kvmx86` - для `KVMX86`
|
||||
- `pkg/cloudbroker/lb` - для `LB`
|
||||
- `pkg/cloudbroker/pcidevice` - для `PCIDevice`
|
||||
- `pkg/cloudbroker/rg` - для `RG`
|
||||
- `pkg/cloudbroker/sep` - для `SEP`
|
||||
- `pkg/cloudbroker/stack` - для `Stack`
|
||||
- `pkg/cloudbroker/tasks` - для `Tasks`
|
||||
- `pkg/cloudbroker/user` - для `User`
|
||||
- `pkg/cloudbroker/vgpu` - для `VGPU`
|
||||
- `pkg/cloudbroker/vins` - для `VINS`
|
||||
|
||||
Все поля структуры имеют описание, в которых содержится:
|
||||
|
||||
@@ -436,50 +420,50 @@ func main() {
|
||||
|
||||
Доступные методы для `.CloudAPI()`:
|
||||
|
||||
- `.Account()` - для работы с `Account`
|
||||
- `.BService()` - для работы с `BService`
|
||||
- `.Compute()` - для работы с `Compute`
|
||||
- `.Disks()` - для работы с `Disks`
|
||||
- `.ExtNet()` - для работы с `ExtNet`
|
||||
- `.FLIPgroup()` - для работы с `FLIPGroup`
|
||||
- `.Image()` - для работы с `Image`
|
||||
- `.K8CI()` - для работы с `K8CI`
|
||||
- `.K8S()` - для работы с `K8S`
|
||||
- `.KVMPPC()` - для работы с `KVMPPC`
|
||||
- `.KVMx86()` - для работы с `KVMX86`
|
||||
- `.LB()` - для работы с `LB`
|
||||
- `.Locations()` - для работы с `Locations`
|
||||
- `.RG()` - для работы с `RG`
|
||||
- `.Sizes()` - для работы с `Sizes`
|
||||
- `.Stack()` - для работы с `Stack`
|
||||
- `.Tasks()` - для работы с `Tasks`
|
||||
- `.VINS()` - для работы с `VINS`
|
||||
- `.Account()` - для работы с `Account`
|
||||
- `.BService()` - для работы с `BService`
|
||||
- `.Compute()` - для работы с `Compute`
|
||||
- `.Disks()` - для работы с `Disks`
|
||||
- `.ExtNet()` - для работы с `ExtNet`
|
||||
- `.FLIPgroup()` - для работы с `FLIPGroup`
|
||||
- `.Image()` - для работы с `Image`
|
||||
- `.K8CI()` - для работы с `K8CI`
|
||||
- `.K8S()` - для работы с `K8S`
|
||||
- `.KVMPPC()` - для работы с `KVMPPC`
|
||||
- `.KVMx86()` - для работы с `KVMX86`
|
||||
- `.LB()` - для работы с `LB`
|
||||
- `.Locations()` - для работы с `Locations`
|
||||
- `.RG()` - для работы с `RG`
|
||||
- `.Sizes()` - для работы с `Sizes`
|
||||
- `.Stack()` - для работы с `Stack`
|
||||
- `.Tasks()` - для работы с `Tasks`
|
||||
- `.VINS()` - для работы с `VINS`
|
||||
|
||||
Доступные методы для `.CloudBroker()`:
|
||||
|
||||
- `.Account()` - для работы с `Account`
|
||||
- `.APIAccess()` - для работы с `APIAccess`
|
||||
- `.Backup()` - для работы с `Backup`
|
||||
- `.Compute()` - для работы с `Compute`
|
||||
- `.Disks()` - для работы с `Disks`
|
||||
- `.ExtNet()` - для работы с `ExtNet`
|
||||
- `.FLIPGroup()` - для работы с `FLIPGroup`
|
||||
- `.Grid()` - для работы с `Grid`
|
||||
- `.Group()` - для работы с `Group`
|
||||
- `.Image()` - для работы с `Image`
|
||||
- `.K8CI()` - для работы с `K8CI`
|
||||
- `.K8S()` - для работы с `K8S`
|
||||
- `.KVMPPC()` - для работы с `KVMPPC`
|
||||
- `.KVMx86()` - для работы с `KVMX86`
|
||||
- `.LB()` - для работы с `LB`
|
||||
- `.PCIDevice()` - для работы с `PCIDevice`
|
||||
- `.RG()` - для работы с `RG`
|
||||
- `.SEP()` - для работы с `SEP`
|
||||
- `.Stack()` - для работы с `Stack`
|
||||
- `.Tasks()` - для работы с `Tasks`
|
||||
- `.User()` - для работы с `User`
|
||||
- `.VGPU()` - для работы с `VGPU`
|
||||
- `.VINS()` - для работы с `VINS`
|
||||
- `.Account()` - для работы с `Account`
|
||||
- `.APIAccess()` - для работы с `APIAccess`
|
||||
- `.Backup()` - для работы с `Backup`
|
||||
- `.Compute()` - для работы с `Compute`
|
||||
- `.Disks()` - для работы с `Disks`
|
||||
- `.ExtNet()` - для работы с `ExtNet`
|
||||
- `.FLIPGroup()` - для работы с `FLIPGroup`
|
||||
- `.Grid()` - для работы с `Grid`
|
||||
- `.Group()` - для работы с `Group`
|
||||
- `.Image()` - для работы с `Image`
|
||||
- `.K8CI()` - для работы с `K8CI`
|
||||
- `.K8S()` - для работы с `K8S`
|
||||
- `.KVMPPC()` - для работы с `KVMPPC`
|
||||
- `.KVMx86()` - для работы с `KVMX86`
|
||||
- `.LB()` - для работы с `LB`
|
||||
- `.PCIDevice()` - для работы с `PCIDevice`
|
||||
- `.RG()` - для работы с `RG`
|
||||
- `.SEP()` - для работы с `SEP`
|
||||
- `.Stack()` - для работы с `Stack`
|
||||
- `.Tasks()` - для работы с `Tasks`
|
||||
- `.User()` - для работы с `User`
|
||||
- `.VGPU()` - для работы с `VGPU`
|
||||
- `.VINS()` - для работы с `VINS`
|
||||
|
||||
3. Вызвать метод, отвечающий за выполнение запроса и передать в него:
|
||||
|
||||
@@ -650,7 +634,7 @@ filtered := resp.
|
||||
```go
|
||||
func main() {
|
||||
// Чтение конфигурации из файла
|
||||
cfg, _ := config.ParseConfigJSON("<PATH>")
|
||||
cfg := config.ParseConfigJSON("<PATH>")
|
||||
|
||||
// Создание клиента
|
||||
client := decort.New(cfg)
|
||||
@@ -782,7 +766,7 @@ func main() {
|
||||
|
||||
```
|
||||
|
||||
### Получение списка уникальных идентификаторов ID объекта
|
||||
### Получение списка уникальных идентификаторов (ID) объекта
|
||||
|
||||
Для всех структур, имеющих поля со списками объектов с уникальными числовыми идентификаторами (ID), добавлены методы IDs(), возвращающие массивы уникальных идентификаторов объектов в этих списках.
|
||||
|
||||
@@ -879,7 +863,7 @@ import (
|
||||
|
||||
func main() {
|
||||
// Парсинг конфигурации из YAML-файла
|
||||
legacyCfg, _ := config.ParseLegacyConfigYAML("<PATH>")
|
||||
legacyCfg := config.ParseLegacyConfigYAML("<PATH>")
|
||||
}
|
||||
```
|
||||
|
||||
@@ -931,7 +915,7 @@ func main() {
|
||||
legacyCfg.SetTimeout(5 * time.Minute)
|
||||
|
||||
// Создание клиента
|
||||
legacyClient := decort.NewLegacy(legacyCfg)
|
||||
legacyClient := decort.NewLegacy(cfg)
|
||||
}
|
||||
```
|
||||
|
||||
@@ -952,13 +936,12 @@ func main() {
|
||||
legacyCfg := config.LegacyConfig{
|
||||
Username: "<USERNAME>",
|
||||
Password: "<PASSWORD>",
|
||||
Domain: "dynamix",
|
||||
DecortURL: "https://mr4.digitalenergy.online",
|
||||
Retries: 5,
|
||||
}
|
||||
|
||||
// Создание клиента
|
||||
legacyClient := decort.NewLegacy(legacyCfg)
|
||||
legacyClient := decort.NewLegacy(cfg)
|
||||
|
||||
// Создание структуры запроса
|
||||
// CreateRequest - реквест на создание виртуальной машины
|
||||
@@ -971,322 +954,10 @@ func main() {
|
||||
}
|
||||
|
||||
// Выполнение запроса
|
||||
res, err := legacyClient.CloudAPI().KVMX86().Create(context.Background(), req)
|
||||
res, err := client.CloudAPI().KVMX86().Create(context.Background(), req)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Println(res)
|
||||
}
|
||||
```
|
||||
|
||||
## Работа с BVS клиентом
|
||||
|
||||
Работа с BVS клиентом применяется для пользователей, которые используют для авторизации BVS.
|
||||
|
||||
### Настройка параметров BVS в кабинете администратора
|
||||
|
||||
Для корректной работы функции обновления токена необходимо соблюдать следующие условия:
|
||||
|
||||
на странице администратора по следующему пути: домены-<имя вашего домена>-(символ i)-токены
|
||||
- параметр "Время жизни токена доступа" - устанавливается для всего домена. Не применяется есть по следующему пути: безопасность-клиентские_системы-(символ i)-токены-"Время жизни токена доступа" не выставлено иное время, которое имеет больший приоритет для конкретной клиентской системы
|
||||
- параметр "Время простоя сессии" - время жизни токена обновления. В случае указания количества минут меньше, чем время жизни токена, то обновление токена будет работать некорректно. Редомендуется указывать время или равное или больше времени жизни токена
|
||||
- параметр "Максимальное время жизни сессии" - время в течение которого возможно производить обновление токена. Если данный параметр будет равен времени жизни токена, то обновление токена будет работать некорректно. Редомендуется указывать время больше времени жизни токена
|
||||
|
||||
### Настройка конфигурации BVS клиента
|
||||
|
||||
Сначала, необходимо создать переменную конфигурации клиента. Конфигурация состоит как из обязательных, так и необязательных полей.
|
||||
|
||||
| Поле | Тип | Обязательный | Описание |
|
||||
| ------------- | --------------------------------------------- | ------------ | ------------------------------------------------------------------ |
|
||||
| Username | string | Да | username пользователя |
|
||||
| Password | string | Да | пароль пользователя |
|
||||
| AppID | string | Да | app_id ключа для выполнения запросов |
|
||||
| AppSecret | string | Да | app_secret ключ для выполнения запроса |
|
||||
| DecortURL | string | Да | URL адрес платформы, с которой будет осуществляться взаимодействие |
|
||||
| SSOURL | string | Да | URL адрес сервиса аутентификации и авторизации |
|
||||
| Domain | string | Да | Имя домена |
|
||||
| Retries | uint | Нет | Кол-во неудачных попыток выполнения запроса, по умолчанию - 5 |
|
||||
| Timeout | config.Duration | Нет | Таймаут HTTP клиента, по умолчанию - без ограничений |
|
||||
| SSLSkipVerify | bool | Нет | Пропуск проверки подлинности сертификата |
|
||||
| Token | struct{} [см. ниже](#описание-структуры-token)| Нет | JWT токен |
|
||||
| PathCfg | string | Нет | Путь записи конфигурации в файл |
|
||||
| PathToken | string | Нет | Путь записи токена в файл |
|
||||
| TimeToRefresh | uint | Нет | Количество минут, за сколько до истечения срока действия токена выполнится его обновление, по умолчанию - 1 минута |
|
||||
|
||||
### Описание структуры token
|
||||
| Параметр | Тип | Описание |
|
||||
| ------------ | ------ | ------------------------------- |
|
||||
| AccessToken | string | Токен |
|
||||
| TokenType | string | Тип токена |
|
||||
| RefreshToken | string | Токен для запроса на обновление |
|
||||
| Expiry | time | Время жизни токена |
|
||||
|
||||
#### Пример конфигурации BVS клиента
|
||||
|
||||
```go
|
||||
import (
|
||||
"repository.basistech.ru/BASIS/decort-golang-sdk/config"
|
||||
)
|
||||
|
||||
func main(){
|
||||
// Настройка конфигурации
|
||||
BvsCfg := config.BVSConfig{
|
||||
AppID: "<APP_ID>",
|
||||
AppSecret: "<APP_SECRET>",
|
||||
Username: "<USERNAME>",
|
||||
Password: "<PASSWORD>",
|
||||
SSOURL: "https://bvs-delta.qa.loc:8443",
|
||||
DecortURL: "https://delta.qa.loc",
|
||||
Domain: "dynamix",
|
||||
Retries: 5,
|
||||
}
|
||||
|
||||
BvsCfg.SetTimeout(5 * time.Minute)
|
||||
}
|
||||
```
|
||||
|
||||
#### Парсинг BVS конфигурации из файла
|
||||
|
||||
Также возможно создать переменную конфигурации из JSON или YAML файла, используя функцию `ParseConfigBVSJSON` (или `ParseConfigBVSYAML`) из пакета config.
|
||||
<br>
|
||||
*См. пример файлов конфигурации ниже и в директории `samples/`.*
|
||||
|
||||
```go
|
||||
import (
|
||||
"repository.basistech.ru/BASIS/decort-golang-sdk/config"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Парсинг конфигурации из YAML-файла
|
||||
BVSCfg, _ := config.ParseConfigBVSYAML("<PATH>")
|
||||
}
|
||||
```
|
||||
|
||||
#### Парсинг BVS токена из файла
|
||||
|
||||
Также возможно создать переменную токена из JSON или YAML файла, используя функцию `ParseTokenBVSJSON` (или `ParseTokenBVSYAML`) из пакета config.
|
||||
<br>
|
||||
*См. пример файлов конфигурации ниже и в директории `samples/`.*
|
||||
|
||||
```go
|
||||
import (
|
||||
"repository.basistech.ru/BASIS/decort-golang-sdk/config"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Парсинг токена из json-файла
|
||||
BVSToken, _ := config.ParseTokenBVSJSON("<PATH>")
|
||||
}
|
||||
```
|
||||
|
||||
#### Пример BVS JSON конфигурации
|
||||
|
||||
```json
|
||||
{
|
||||
"username": "<USERNAME>",
|
||||
"password": "<PASSWORD>",
|
||||
"appId": "<APP_ID>",
|
||||
"appSecret": "<APP_SECRET>",
|
||||
"ssoUrl": "https://bvs-delta.qa.loc:8443",
|
||||
"decortUrl": "https://delta.qa.loc",
|
||||
"domain": "dynamix",
|
||||
"token": {
|
||||
"access_token": "string_token",
|
||||
"token_type": "bearer",
|
||||
"refresh_token": "string_refresh_token",
|
||||
"expiry": "2023-11-24T12:40:27.954150524+03:00"
|
||||
},
|
||||
"retries": 5,
|
||||
"sslSkipVerify": true,
|
||||
"timeout": "5m",
|
||||
"path_cfg": "config",
|
||||
"path_token": "token",
|
||||
"timeToRefresh": 5
|
||||
}
|
||||
```
|
||||
|
||||
#### Пример BVS YAML конфигурации
|
||||
```yaml
|
||||
username: <USERNAME>
|
||||
password: <PASSWORD>
|
||||
appId: <APP_ID>
|
||||
appSecret: <APP_SECRET>
|
||||
ssoUrl: https://bvs-delta.qa.loc:8443
|
||||
decortUrl: https://delta.qa.loc
|
||||
domain: dynamix
|
||||
token":
|
||||
access_token: string_token
|
||||
token_type: bearer
|
||||
refresh_token: string_refresh_token
|
||||
expiry: 2023-11-24T12:40:27.954150524+03:00
|
||||
retries: 5
|
||||
sslSkipVerify: true
|
||||
timeout: 5m
|
||||
path_cfg: config
|
||||
path_token: token
|
||||
timeToRefresh: 5
|
||||
```
|
||||
### Создание BVS клиента
|
||||
|
||||
Создание клиента происходит с помощью функции-строителя `NewBVS` из основного пакета `decort-sdk`, для избежания проблем с именами, пакету можно присвоить алиас `decort`. Функция принимает конфигурацию, возвращает структуру `DecortClient`, с помощью которой можно взаимодействовать с платформой.
|
||||
|
||||
#### Пример создания BVS клиента
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"repository.basistech.ru/BASIS/decort-golang-sdk/config"
|
||||
decort "repository.basistech.ru/BASIS/decort-golang-sdk"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Настройка конфигурации
|
||||
BVSCfg := config.BVSConfig{
|
||||
Username: "<USERNAME>",
|
||||
Password: "<PASSWORD>",
|
||||
AppID: "<APPID>",
|
||||
AppSecret: "<APPSECRET>",
|
||||
SSOURL: "https://bvs-delta.qa.loc:8443",
|
||||
DecortURL: "https://mr4.digitalenergy.online",
|
||||
Domain: "dynamix",
|
||||
Retries: 5,
|
||||
}
|
||||
|
||||
BVSCfg.SetTimeout(5 * time.Minute)
|
||||
|
||||
// Создание клиента
|
||||
BVSClient := decort.NewBVS(BVSCfg)
|
||||
}
|
||||
```
|
||||
|
||||
#### Пример получения BVS токена
|
||||
|
||||
В случае указания значения в переменной конфигурации `PathCfg` токен и конфигурация будут записаны в файл в формате `json`, переменная `PathToken` служит для записи токена в файл в формате `json`
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"repository.basistech.ru/BASIS/decort-golang-sdk/config"
|
||||
decort "repository.basistech.ru/BASIS/decort-golang-sdk"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Настройка конфигурации
|
||||
BVSCfg := config.BVSConfig{
|
||||
Username: "<USERNAME>",
|
||||
Password: "<PASSWORD>",
|
||||
AppID: "<APPID>",
|
||||
AppSecret: "<APPSECRET>",
|
||||
SSOURL: "https://bvs-delta.qa.loc:8443",
|
||||
DecortURL: "https://mr4.digitalenergy.online",
|
||||
Domain: "dynamix",
|
||||
PathCfg: "config",
|
||||
Retries: 5,
|
||||
}
|
||||
|
||||
// Создание клиента
|
||||
BVSClient := decort.NewBVS(BVSCfg)
|
||||
|
||||
// Выполнение запроса на получение токена
|
||||
token, err := BVSClient.GetToken(context.Background())
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Println(token)
|
||||
}
|
||||
```
|
||||
|
||||
#### Пример обновления BVS токена
|
||||
|
||||
В случае указания значения в переменной конфигурации `PathCfg` обновленный токен и конфигурация будут записаны в файл в формате `json`, переменная `PathToken` служит для записи токена в файл в формате `json`
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"repository.basistech.ru/BASIS/decort-golang-sdk/config"
|
||||
decort "repository.basistech.ru/BASIS/decort-golang-sdk"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Настройка конфигурации
|
||||
BVSCfg := config.BVSConfig{
|
||||
Username: "<USERNAME>",
|
||||
Password: "<PASSWORD>",
|
||||
AppID: "<APPID>",
|
||||
AppSecret: "<APPSECRET>",
|
||||
SSOURL: "https://bvs-delta.qa.loc:8443",
|
||||
DecortURL: "https://mr4.digitalenergy.online",
|
||||
Domain: "dynamix",
|
||||
PathToken: "token",
|
||||
Retries: 5,
|
||||
}
|
||||
|
||||
// Создание клиента
|
||||
BVSClient := decort.NewBVS(BVSCfg)
|
||||
|
||||
// Выполнение запроса на обновление токена
|
||||
token, err := BVSClient.RefreshToken(context.Background())
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Println(token)
|
||||
}
|
||||
```
|
||||
|
||||
#### Пример выполнения запроса
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"repository.basistech.ru/BASIS/decort-golang-sdk/config"
|
||||
decort "repository.basistech.ru/BASIS/decort-golang-sdk"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Настройка конфигурации
|
||||
BVSCfg := config.BVSConfig{
|
||||
Username: "<USERNAME>",
|
||||
Password: "<PASSWORD>",
|
||||
AppID: "<APPID>",
|
||||
AppSecret: "<APPSECRET>",
|
||||
SSOURL: "https://bvs-delta.qa.loc:8443",
|
||||
DecortURL: "https://mr4.digitalenergy.online",
|
||||
Domain: "dynamix",
|
||||
Retries: 5,
|
||||
}
|
||||
|
||||
// Создание клиента
|
||||
BVSClient := decort.NewBVS(BVSCfg)
|
||||
|
||||
// Создание структуры запроса
|
||||
// CreateRequest - реквест на создание виртуальной машины
|
||||
req := kvmx86.CreateRequest{
|
||||
RGID: 123,
|
||||
Name: "compute",
|
||||
CPU: 4,
|
||||
RAM: 4096,
|
||||
ImageID: 321,
|
||||
}
|
||||
|
||||
// Выполнение запроса
|
||||
res, err := BVSClient.CloudAPI().KVMX86().Create(context.Background(), req)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Println(res)
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user