Тенанты
На странице собраны API-методы для управления тенантами.
Получение списка доступных ЦОД
Для создания тенантов нужно запросить доступные ЦОД.
Для запроса используются:
токен, полученный при аутентификации;
project_id, полученный со списком проектов.
- Запрос
curl --location 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/data-centers?project_id=$project_id' \--header 'Authorization: Bearer TOKEN' \--header 'accept: application/json'
Создание тенанта POST /tenants
Для создания тенанта необходимы следующие параметры:
- Параметры headers
- Параметры body
- Запрос
idempotency-key в формате UUID-4, обязательный. Сгенерировать header можно через любой сервис, например Online UUID Generator.
Параметр |
Тип |
Опциональность |
Описание |
---|---|---|---|
project_id |
string($uuid) |
Обязательный |
Идентификатор проекта |
region |
string |
Обязательный |
Название региона |
alias |
string |
Обязательный |
Название тенанта |
monitoring_enabled |
boolean |
Опциональный |
Управление настройками мониторинга для создаваемого тенанта. По-умолчанию значение true |
curl --location 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/tenants' \--header 'content-type: application/json' \--header 'idempotency-key: a90b7a09-ce2d-4dfb-a236-97d375b4dc94' \--header 'Authorization: Bearer TOKEN' \--data '{"alias": "mg-apitest-3","region": "pd30-02","project_id": "84f2ac2b-0e1c-47b8-9898-21ec9301a733","monitoring_enabled": true}'
Получение списка тенантов GET /tenants
Для запроса используются полученные токен и project_id.
- Запрос
curl --location 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/tenants?project_id=$project_id' \--header 'content-type: application/json' \--header 'Authorization: Bearer TOKEN'
Изменение статуса тенанта PUT /tenants/state
Для запроса необходимы следующие параметры:
- Параметры headers
- Параметры body
ENTITY_STATE_UNSPECIFIED
Enabled
Disabled
- Запрос
idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.
Параметр |
Тип |
Опциональность |
Описание |
---|---|---|---|
service_instance_id |
string($uuid) |
Обязательный |
Идентификатор тенанта |
tenant_state |
string |
Обязательный |
Статус тенанта: |
curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/tenants/state' \--header 'accept: application/json' \--header 'idempotency-key: 124e2dd0-f4b2-4586-827c-3025f8930257' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer TOKEN' \--data '{"service_instance_id": "eaf81279-8229-440a-81ed-04c5edea684c","state": "Disabled"}'
Добавление тенанта в избранное PUT /tenants/favorite
Для запроса необходимы следующие параметры:
- Параметры headers
- Параметры body
- Запрос
idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.
Параметр |
Тип |
Опциональность |
Описание |
---|---|---|---|
service_instance_id |
string($uuid) |
Обязательный |
Идентификатор тенанта |
tenant_is_favoritestate |
string |
Обязательный |
Наличие тенанта в списке избранных |
curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/tenants/favorite' \--header 'accept: application/json' \--header 'idempotency-key: 05a92cc8-4b27-4e50-9071-0ed2ba180f6b' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer TOKEN' \--data '{"service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b","is_favorite": "true"}'
Включение мониторинга для тенанта PUT /tenants/monitoring
Для запроса необходимы следующие параметры:
- Параметры headers
- Параметры body
- Запрос
idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.
Параметр |
Тип |
Опциональность |
Описание |
---|---|---|---|
service_instance_id |
string |
Обязательный |
Идентификатор тенанта |
monitoring_enabled |
string($uuid) |
Обязательный |
Наличие мониторинга |
curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/tenants/monitoring' \--header 'accept: application/json' \--header 'idempotency-key: 05a92cc8-4b27-4e50-9071-0ed2ba180f6b' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer TOKEN' \--data '{"service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b","monitoring_enabled": "true"}'
Удаление тенанта DELETE /tenants{id}
Перед удалением тенант нужно перевести в статус «Disabled».
Для запроса необходимы следующие параметры:
- Параметры headers
- Параметры body
- Запрос
idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.
service_instance_id — идентификатор тенанта в формате string, обязательный.
curl --location --request DELETE 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/tenants?service_instance_id=$service_instance_id' \--header 'accept: application/json' \--header 'idempotency-key: 124e2dd0-f4b2-4586-827c-3025f8930257' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer TOKEN'
- Получение списка доступных ЦОД
- Создание тенанта POST /tenants
- Получение списка тенантов GET /tenants
- Изменение статуса тенанта PUT /tenants/state
- Добавление тенанта в избранное PUT /tenants/favorite
- Включение мониторинга для тенанта PUT /tenants/monitoring
- Удаление тенанта DELETE /tenants{id}