- tocdepth
2
Product instances
Product instances — экземпляры Облака VMware в личном кабинете Cloud.ru.
GET информация об Облаке VMware
GET https://console.cloud.ru/api/bff-console/v1/projects/{projectid}/product-instances
- Аутентификация
- Параметры headers
Accept
application/json
- Параметры path
Параметр
Тип
Обязательный/опциональный
Описание
projectid
string
обязательный
Идентификатор проекта. Можно получить в ответе на запрос информации о проектах
- Пример запроса
curl -L -X GET 'https://console.cloud.ru/api/bff-console/v1/projects/ba4e7.../product-instances' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer eyJhb...'
- Пример успешного ответа
{ "product_instances": [ { "id": "cfa37...", "product": { "id": "70b96...", "name": "Виртуальный ЦОД на базе VMware", "short_description": "Виртуальная ИТ-инфраструктура в аренду для задач любого масштаба", "long_description": "", "int_name": "vmware" }, "offering_id": "18e2a...", "service_instance_id": "", "project_id": "ba4e7...", "name": "Виртуальный ЦОД", "status": "PRODUCT_INSTANCE_STATUS_ACTIVE", "trial_balance": "", "is_trial": false, "service_instance": { "id": "", "characteristics": [] }, "new_scheme": true, "created_at": "2022-07-01T08:53:28.026713Z", "updated_at": "2022-07-22T08:53:28.630553Z" } ] }
Параметр
Тип
Описание
product_instances
array [objects]
Перечень экземпляров Облака VMware
product_instances[]. id
string
Идентификатор Облака VMware
product_instances[]. product
object
Продукты, развернутые в Облаке VMware
product_instances[]. product. id
string
Идентификатор продукта
product_instances[]. product. name
string
Название продукта
product_instances[]. product. short_description
string
Краткое описание продукта
product_instances[]. product. long_description
string
Длинное описание продукта
product_instances[]. product. int_name
string
Внутреннее название продукта
product_instances[]. offering_id
string
Внутренний служебный параметр. Идентификатор сущности «продукт-ресурс» из продуктового каталога
product_instances[]. service_instance_id
string
Идентификатор тенанта
product_instances[]. project_id
string
Идентификатор проекта
product_instances[]. name
string
Название Облака VMware
product_instances[]. status
string
Статус Облака VMware:
ENTITY_STATE_UNSPECIFIED
Enabled
Disabled
product_instances[]. trial_balance
string
Бонусный счет на время тестового периода работы с продуктом
product_instances[]. is_trial
boolean
Если параметр принимает значение true, продукт используется в тестовом периоде
product_instances[]. service_instance
object
Перечень характеристик тенанта
product_instances[]. service_instance. id
string
Идентификатор тенанта
product_instances[]. service_instance. characteristics[]
array [string]
Перечень характеристик тенанта
product_instances[]. new_scheme
boolean
Внутренний служебный параметр. Если тенант создавался в личном кабинете, параметр принимает значение true. Если тенант вручную мигрировали в личный кабинет, параметр принимает значение false
product_instances[]. created_at
string<date-time>
Дата и время создания
product_instances[]. updated_at
string<date-time>
Дата и время последнего обновления
- Пример ответа с ошибкой 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