tocdepth

2

Tenants

На этой странице собраны API-методы для управления тенантами.

POST создание тенанта

POST https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/tenants
Аутентификация

См. Вход в личный кабинет

Параметры headers

Content-Type

application/json

Accept

application/json
Параметры body

Параметр

Тип

Обязательный/опциональный

Описание

alias

string

обязательный

Название тенанта. Допустимые символы: A-Z a-z 0-9 _- . Максимальная длина: 10 символов

region

string

обязательный

Регион для размещения тенанта. Допустимые значения можно получить в ответе на запрос списка ЦОД

customer_id

string

обязательный

Идентификатор организации заказчика, которая инициирует запрос. Можно получить в ответе на запрос информации о проектах

project_id

string

обязательный

Идентификатор проекта. Можно получить в ответе на запрос информации о проектах

user_id

string

обязательный

Идентификатор пользователя, который создает тенант. Можно получить в ответе на запрос информации о пользователе

product_instance_id

string

обязательный

Идентификатор экземпляра Облака VMware, на котором планируется развернуть тенант. Можно получить в ответе на запрос информации об экземпляре платформы

labels[]

array [string]

опциональный

Перечень меток
Пример запроса
curl -L -X POST 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/tenants' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhb...' \
--data-raw '{
  "alias": "my_tenant",
  "region": "pd12",
  "customer_id": "e6c77...",
  "project_id": "ba4e7...",
  "user_id": "b39e1...",
  "product_instance_id": "cfa37..."
}'
Пример успешного ответа
{
 "task_id": "dfebe...",
 "service_instance_id": "e6e39..."
}
Пример ответа с ошибкой 500
{
  "code": 13,
  "message": "internal error",
  "details": []
}

GET список тенантов

GET https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/tenants?project_id=ba4e7...
Аутентификация

См. Вход в личный кабинет

Параметры headers

Accept

application/json
Параметры query

Параметр

Тип

Обязательный/опциональный

Описание

project_id

string

обязательный

Идентификатор проекта. Можно получить в ответе на запрос информации о проектах
Пример запроса
curl -L -X GET 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/tenants?project_id=ba4e7...' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhb...' \
Пример успешного ответа
{
 "result": [ {
   "id": "6ab76...",
   "alias": "my_tenant",
   "name": "my_tenant-2TbVYS6HN",
   "region": "pd12",
   "user_id": "b39e1...",
   "project_id": "ba4e7...",
   "customer_id": "e6c77...",
   "product_instance_id": "cfa37...",
   "service_instance_id": "e6e39...",
   "state": "Enabled",
   "description": "my_tenant-2TbVYS6HN",
   "tags": [],
   "number_of_vdc": "0",
   "number_of_vms": "0",
   "number_of_running_vms": "0",
   "number_of_vapps": "0",
   "reserve_zone": false,
   "with_rvdc": false,
   "url": "https://console.cloud.ru"
  }
]}
Пример ответа с ошибкой 500
{
  "code": 13,
  "message": "internal error",
  "details": []
}

PUT изменение тенанта

PUT https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/tenants
Аутентификация

См. Вход в личный кабинет

Параметры headers

Content-Type

application/json

Accept

application/json
Параметры body

Параметр

Тип

Обязательный/опциональный

Описание

service_instance_id

string

обязательный

Идентификатор тенанта

state

string

опциональный

Состояние тенанта:

  • Enabled

  • Disabled

labels[]

array [string]

опциональный

Перечень меток
Пример запроса
curl -L -X POST 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/tenants' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhb...' \
--data-raw '{
  "service_instance_id": "e6e39...",
  "state": "Enabled",
  "labels": [
    "test",
    "min"
  ]
}'
Пример успешного ответа
{
  "task_id": "afebe..."
}
Пример ответа с ошибкой 500
{
  "code": 13,
  "message": "internal error",
  "details": []
}

DELETE удаление тенанта

Примечание

Состояние удаляемого тенанта должно быть «Disabled». См. PUT изменение тенанта.

DELETE https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/tenants?service_instance_id={service_instance_id}
Аутентификация

См. Вход в личный кабинет

Параметры headers

Accept

application/json
Параметры query

Параметр

Тип

Обязательный/опциональный

Описание

service_instance_id

string

обязательный

Идентификатор тенанта. Можно получить в ответе на запрос списка тенантов

labels[]

array [string]

опциональный

Перечень меток
Пример запроса
curl -L -X DELETE 'https://console.cloud.ru/api/vmware-bff-api/console/vcloud/v1/tenants?service_instance_id=e6e39...' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhb...'
Пример успешного ответа
{
  "task_id": "afebe..."
}
Пример ответа с ошибкой 500
{
  "code": 13,
  "message": "internal error",
  "details": []
}
Запустили Evolution free tier
для Dev & Test
Получить