- tocdepth
2
VDC
На этой странице собраны методы для управления виртуальными ЦОД.
POST создание виртуального ЦОД
POST https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc
- Аутентификация
- Параметры headers
Content-Type
application/json
Accept
application/json
- Параметры body
Параметр
Тип
Обязательный/опциональный
Описание
service_instance_id
string
обязательный
Идентификатор тенанта
name
string
обязательный
Название виртуального ЦОД
description
string
обязательный
Описание виртуального ЦОД
cpu_sku_int_name
string
обязательный
Название SKU. Можно получить в ответе на запрос доступных частот CPU
allocation_model
string
опциональный
Модель тарификации:
VDC_ALLOCATION_MODEL_UNSPECIFIED
ALLOCATION_POOL
tags[]
array [string]
опциональный
Перечень тегов виртуального ЦОД
cpu_quantity
string
обязательный
Количество ядер CPU
ram_size_gb
string
обязательный
Объем оперативной памяти в ГБ
storages[]
array [objects]
обязательный
Перечень виртуальных дисков
storages[]. type
string
опциональный
Тип виртуального диска:
SSD
SAS
storages[]. size_gb
string
обязательный
Объем диска в ГБ
storages[]. swap_size_gb
string
опциональный
Объем swap-памяти на диске в ГБ
storages[]. is_default
boolean
опциональный
Если значение равно true, виртуальный диск используется по умолчанию в виртуальном ЦОД
labels[]
array [string]
опциональный
Перечень меток
- Пример запроса
curl -L -X POST 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer eyJhb...' \ --data-raw '{ "service_instance_id": "e6e39...", "name": "test-vdc", "description": "test-vdc", "cpu_sku_int_name": "up_to_3.0", "allocation_model": ALLOCATION_POOL, "tags": [ "test", "min" ], "cpu_quantity": 1, "ram_size_gb": 16, "storages": [ { "type": "SSD", "size_gb": 100, "swap_size_gb": 0, "is_default": true } ] }'
- Пример успешного ответа
{ "task_id": "dfebe..." }
task_id
Идентификатор задачи
- Пример ответа с ошибкой 500
{ "code": 13, "message": "internal error", "details": [] }
Параметр
Тип
Описание
code
integer
Код ошибки
internal error
string
Краткое описание ошибки
details[]
array [objects]
Перечень подробных описаний ошибки
details[]. @type
string
Тип подробного описания
details[]. additionalProp1
string
Комментарий
details[]. additionalProp2
string
Комментарий
details[]. additionalProp3
string
Комментарий
GET список виртуальных ЦОД
GET https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc?service_instance_id={service_instance_id}
- Аутентификация
- Параметры headers
Accept
application/json
- Параметры query
Параметр
Тип
Обязательный/опциональный
Описание
service_instance_id
string
обязательный
Идентификатор тенанта
- Пример запроса
curl --location --request GET 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc?service_instance_id=id=863f4...' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer eyJhb...'
- Пример успешного ответа
{ "alias": "TEST-SS", "region": "pd12", "tenant": { "name": "TEST-SS-2TbVYS6HN", "vdc_list": [ { "id": "fba9f...", "name": "TEST-SS_01", "description": "", "provider": { "id": "71b5c...", "name": "lab-pclu01" }, "network": { "id": "5fa746...", "name": "lab01-gnp01" }, "allocation_model": "ALLOCATION_POOL", "tags": [], "cpu_quantity": "1", "cpu_freq_ghz": "3", "ram_size_gb": "2", "storages": [ { "id": "9892f...", "name": "Gold", "type": "SSD", "size_gb": "3", "swap_size_gb": "0", "is_default": true } ], "state": "Enabled" } ] } }
Параметр
Тип
Описание
alias
string
Название тенанта, присвоенное при создании
region
string
Название региона, в котором размещается тенант
tenant
object
Тенант, в котором размещается виртуальный ЦОД
tenant. name
string
Уникальное название тенанта
tenant. vdc_list[]
array [objects]
Перечень виртуальных ЦОД в тенанте
tenant. vdc_list[]. id
string
Идентификатор виртуального ЦОД
tenant. vdc_list[]. name
string
Название виртуального ЦОД
tenant. vdc_list[]. description
string
Описание виртуального ЦОД
tenant. vdc_list[]. provider
object
Кластер, в котором размещаются ресурсы виртуального ЦОД. В одном регионе может быть несколько кластеров. От кластера зависит например то, какая частота CPU будет доступна при создании виртуального ЦОД, наличие GPU
tenant. vdc_list[]. provider. id
string
Идентификатор кластера
tenant. vdc_list[]. provider. name
string
Название кластера
tenant. vdc_list[]. network
object
Внешняя сеть, которая подключается к виртуальному ЦОД
tenant. vdc_list[]. network. id
string
Идентификатор внешней сети
tenant. vdc_list[]. network. name
string
Название внешней сети
tenant. vdc_list[]. allocation_model
string
Модель тарификации:
VDC_ALLOCATION_MODEL_UNSPECIFIED
PAY_AS_YOU_GO
ALLOCATION_POOL
FLEX
tenant. vdc_list[]. tags[]
array [string]
Перечень тегов
tenant. vdc_list[]. cpu_quantity
string
Количество ядер CPU
tenant. vdc_list[]. cpu_freq_ghz
string
Частота CPU в ГГц
tenant. vdc_list[]. ram_size_gb
string
Объем оперативной памяти в ГБ
tenant. vdc_list[]. storages[]
array [objects]
Перечень виртуальных дисков
tenant. vdc_list[]. storages[]. id
string
Идентификатор виртуального диска
tenant. vdc_list[]. storages[]. name
string
Название политики хранения виртуального диска:
Gold
Bronze
tenant. vdc_list[]. storages[]. type
string
Тип виртуального диска:
STORAGE_TYPE_UNSPECIFIED
SSD
SAS
SATA
tenant. vdc_list[]. storages[]. size_gb
string
Объем виртуального диска в ГБ
tenant. vdc_lis[]. storages[]. swap_size_gb
string
Объем swap-памяти на диске в ГБ
tenant. vdc_list[]. storages[]. is_default
boolean
Если значение равно true, виртуальный диск используется по умолчанию в виртуальном ЦОД
tenant. vdc_list[]. state
string
Состояние виртуального ЦОД:
ENTITY_STATE_UNSPECIFIED
Enabled
Disabled
- Пример ответа с ошибкой 500
{ "code": 13, "message": "internal error", "details": [] }
Параметр
Тип
Описание
code
integer
Код ошибки
internal error
string
Краткое описание ошибки
details[]
array [objects]
Перечень подробных описаний ошибки
details[]. @type
string
Тип подробного описания
details[]. additionalProp1
string
Комментарий
details[]. additionalProp2
string
Комментарий
details[]. additionalProp3
string
Комментарий
PUT изменение объема ресурсов виртуального ЦОД
PUT https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc
- Аутентификация
- Параметры headers
Content-Type
application/json
Accept
application/json
- Параметры body
Параметр
Тип
Обязательный/опциональный
Описание
service_instance_id
string
обязательный
Идентификатор тенанта
id
string
обязательный
Идентификатор виртуального ЦОД
tags[]
array [string]
опциональный
Перечень тегов виртуального ЦОД
cpu_quantity
string
опциональный
Количество ядер CPU
ram_size_gb
string
опциональный
Объем оперативной памяти в ГБ
storages[]
array [objects]
Опциональный
Перечень виртуальных дисков
storages[]. type
string
опциональный
Тип виртуального диска:
SSD
SATA
storages[]. id
string
обязательный
Идентификатор виртуального диска
storages[]. size_gb
string
обязательный
Объем диска в ГБ
storages[]. swap_size_gb
string
опциональный
Объем swap-памяти на диске в ГБ
storages[]. is_default
boolean
опциональный
Если значение равно true, виртуальный диск используется по умолчанию в виртуальном ЦОД
- Пример запроса
curl -L -X PUT 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer eyJhb...' \ --data-raw '{ "service_instance_id": "d9fbb...", "id": "fba9f...", "tags": [ "test", "min" ], "cpu_quantity": "2", "ram_size_gb": "20", "storages": [ { "id": "9892f...", "size_gb": "200" } ] }'
- Пример успешного ответа
{ "task_id": "a9fbb..." }
Параметр
Тип
Описание
task_id
string
Идентификатор задачи
- Пример ответа с ошибкой 500
{ "code": 13, "message": "internal error", "details": [] }
Параметр
Тип
Описание
code
integer
Код ошибки
internal error
string
Краткое описание ошибки
details[]
array [objects]
Перечень подробных описаний ошибки
details[]. @type
string
Тип подробного описания
details[]. additionalProp1
string
Комментарий
details[]. additionalProp2
string
Комментарий
details[]. additionalProp3
string
Комментарий
PUT изменение состояния виртуального ЦОД
PUT https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc-state
- Аутентификация
- Параметры headers
Content-Type
application/json
Accept
application/json
- Параметры body
Параметр
Тип
Обязательный/опциональный
Описание
service_instance_id
string
обязательный
Идентификатор тенанта
vdc_id
string
обязательный
Идентификатор виртуального ЦОД
state
string
обязательный
Состояние виртуального ЦОД:
Enabled
Disabled
labels[]
array [string]
опциональный
Перечень меток
- Пример запроса
curl -L -X PUT 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer eyJhb...' \ --data-raw '{ "service_instance_id": "d9fbb...", "vdc_id": "fba9f...", "state": "Disabled" }'
- Пример успешного ответа
{ "task_id": "a9fbb..." }
Параметр
Тип
Описание
task_id
string
Идентификатор задачи
- Пример ответа с ошибкой 500
{ "code": 13, "message": "internal error", "details": [] }
Параметр
Тип
Описание
code
integer
Код ошибки
internal error
string
Краткое описание ошибки
details[]
array [objects]
Перечень подробных описаний ошибки
details[]. @type
string
Тип подробного описания
details[]. additionalProp1
string
Комментарий
details[]. additionalProp2
string
Комментарий
details[]. additionalProp3
string
Комментарий
DELETE удаление виртуального ЦОД
Примечание
Состояние удаляемого виртуального ЦОД должно быть «Disabled». См. PUT изменение состояния виртуального ЦОД.
DELETE https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc?service_instance_id={service_instance_id}&id={id}
- Аутентификация
- Параметры headers
Accept
application/json
- Параметры query
Параметр
Тип
Обязательный/опциональный
Описание
service_instance_id
string
обязательный
Идентификатор тенанта
id
string
обязательный
Идентификатор виртуального ЦОД
labels[]
array [string]
опциональный
Перечень меток
- Пример запроса
curl -L -X DELETE 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/vdc?service_instance_id=863f4...&id=12345...&labels=test&labels=min' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer eyJhb...'
- Пример успешного ответа
{ "task_id": "a6ffb..." }
Параметр
Тип
Описание
task_id
string
Идентификатор задачи
- Пример ответа с ошибкой 500
{ "code": 13, "message": "internal error", "details": [] }
Параметр
Тип
Описание
code
integer
Код ошибки
internal error
string
Краткое описание ошибки
details[]
array [objects]
Перечень подробных описаний ошибки
details[]. @type
string
Тип подробного описания
details[]. additionalProp1
string
Комментарий
details[]. additionalProp2
string
Комментарий
details[]. additionalProp3
string
Комментарий
для Dev & Test