tocdepth: 2

Виртуальные ЦОДы

На странице собраны методы для управления виртуальными ЦОДами.

Создание виртуального ЦОДа POST /vdcs
Получение списка виртуальных ЦОДов vdc GET /vdcs{service_instance_id}
Изменение типа тарификации PUT /vdcs/allocation-model
Изменение статуса виртуального ЦОДа PUT /vdcs/state
Изменение количества CPU PUT /vdcs/cpu
Изменение объема RAM PUT /vdcs/ram
Добавление хранилища PUT /vdcs/storages/add
Изменение объема хранилища PUT /vdcs/storages/size
Установка хранилища по-умолчанию PUT /vdcs/storages/default
Удаление хранилища PUT /vdcs/storages/remove
Удаление виртуального ЦОДа DELETE /tenants{tenant_id}&{vdc_id}

Создание виртуального ЦОДа POST /vdcs 

Для создания виртуального ЦОДа необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр	Тип	Опциональность	Описание
`service_instance_id`	string($uuid)	Обязательный	Идентификатор тенанта
`allocation_model`	string[enum]	Обязательный	Тип тарификации: VDC_ALLOCATION_MODEL_UNSPECIFIED PAY_AS_YOU_GO ALLOCATION_POOL
`name`	string (mask: `^[a-zA-Z0-9_\-]{1,6}$`)	Обязательный	Название виртуального ЦОДа
`user_comment`	string	Опциональный	Свободное поле
`description`	string	Обязательный	Описание виртуального ЦОДа
`cpu.quantity`	string($int64) minimum: 1	Обязательный	Количество CPU, шт
`cpu.range`	string[enum]	Обязательный	Частота CPU: CPU_RANGE_UNSPECIFIED CPU_RANGE_2_1_MHZ CPU_RANGE_2_4_MHZ CPU_RANGE_2_6_MHZ CPU_RANGE_2_9_MHZ CPU_RANGE_OVER_2_6_MHZ CPU_RANGE_OVER_3_5_MHZ CPU_RANGE_UPTO_3_0_MHZ
`ram_size_gb`	string($int64)	Опциональный	Объем RAM, ГБ
`storages.type`	string[enum]	Обязательный	Тип хранилища: STORAGE_TYPE_UNSPECIFIED SSD SAS SATA ENCRYPTED_SSD ENCRYPTED_SATA DR_SSD DR_SATA FAST_SSD ENCRYPTED_FAST_SSD DR_FAST_SSD
`storages.size_gb`	string($int64)	Обязательный	Объем хранилища, ГБ
`storages.is_default`	boolean	Обязательный	Хранилище по умолчанию

Запрос

curl --location 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs' \
--header 'content-type: application/json' \
--header 'idempotency-key: 545b2fcc-8004-42ff-831b-3584978cabe2' \
--header 'Authorization: Bearer TOKEN' \
--data '{
    "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
    "name": "vdc1",
    "description": "test-description",
    "allocation_model": "ALLOCATION_POOL",
    "cpu_range": "CPU_RANGE_UPTO_3_0_MHZ",
    "cpu_quantity": "1",
    "ram_size_gb": "2",
    "storages": [
        {
            "type": "SSD",
            "size_gb": "2",
            "is_default": true
        }
    }'
    "user_comment": "test-user-comment"
}'

Пример ответа 200 OK

В ответе вернется идентификатор и статус операции создания.

{
   "id": "545b2fcc-8004-42ff-831b-3584978cabe2",
   "description": "",
   "completed": false,
   "response": {},
   "metadata": {
       "method": "/cloud.vmware.v1beta.VdcService/CreateVdc",
       "status": "IN PROGRESS",
       "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
       "resource_id": "",
       "resource_name": "mg-demo-000-vdc1",
       "resource_type": "VDC"
   },
   "created_at": "2024-11-14T13:58:43.775765Z",
   "created_by": "c9c9e57f-98e0-4b8c-a07b-c8d19b159ecc",
   "updated_at": "2024-11-14T13:58:43.776793Z"
}

Описание параметров

Параметр	Тип	Опциональность	Описание
`operation_id`	string($uuid)	Обязательный	Идектификатор операции
`description`	string	Обязательный	Описание операции
`completed`	boolean	Обязательный	Статус операции
`created_at`	string($date-time)	Обязательный	Дата и время создания операции
`created_by`	string($uuid)	Обязательный	Идектификатор пользователя, выполнившего операцию
`updated_at`	string($date-time)	Обязательный	Дата и время последнего обновления операции

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	Tenant not exists	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantNotFound = errors.New("tenant not found")`
404 Not Found	Tenant was deleted	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantDeleted = errors.New("tenant deleted")`
400 Bad Request	Invalid VDC name	The specified VDC name is not allowed. Please try another name	3 INVALID_ARGUMENT	`ErrVdcName = errors.New("name must contain only the characters [A-Z a-z 0-9 _-], max length 6 characters")`
400 Bad Request	VDC name already exists	The specified VDC name already exists. Please try another name	3 INVALID_ARGUMENT	`ErrVdcNameNotUnique = errors.New("vdc name already exists")`
400 Bad Request	The amount of VDCs limit is reached	The amount of VDCs limit is reached. Please contact the support to increase the limit	9 FAILED_PRECONDITION	`ErrLimits = errors.New("resource limits error")`
400 Bad Request	Invalid allocation model	The specified allocation model is incorrect. Please recheck the value	3 INVALID_ARGUMENT	`ErrAllocationModelInvalid = errors.New("allocation model is invalid")`
400 Bad Request	The CPU amount limit is reached	TheCPU amount limit is reached. Please contact the support to increase the limit	9 FAILED_PRECONDITION	`ErrLimits = errors.New("resource limits error")`
400 Bad Request	The RAM size limit is reached	The RAM size limit is reached. Please contact the support to increase the limit	9 FAILED_PRECONDITION	`ErrLimits = errors.New("resource limits error")`
400 Bad Request	The storage size limit is reached	The storage size limit is reached. Please contact the support to increase the limit.	9 FAILED_PRECONDITION	`ErrLimits = errors.New("resource limits error")`
400 Bad Request	Only one storage can be seleted by default	Please choose the only storage that should be set by default	9 FAILED_PRECONDITION	`ErrSelectSingleDefaultStorage = errors.New("should be selected single default storage")`
400 Bad Request	This storage type already exists	The specified storage type already exists. Please recheck the value or update the actual storage	3 INVALID_ARGUMENT	`ErrDuplicateStorageType = errors.New("storages should have different types")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`` ErrInsufficientPermissions = errors.New(«insufficient permissions»)``

Получение списка виртуальных ЦОДов vdc GET /vdcs{service_instance_id}

Для запроса используются:

токен, полученный при аутентификации;
project_id, полученный со списком проектов.

Запрос

curl --location 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs?service_instance_id=7e4c2391-25e1-47a3-b70f-20e2176dab2b' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN'

Пример ответа 200 OK

{
   "result": [
      {
          "id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
          "name": "mg-demo-000-vdc1",
          "description": "test-description",
          "provider_name": "pd30-b12-pclu01",
          "allocation_model": "ALLOCATION_POOL",
          "cpu_quantity": "1",
          "cpu_freq_ghz": 3,
          "ram_size_gb": "2",
          "storages": [
              {
                  "id": "6220b3ad-1bbb-47cc-8bd7-bc030332daf3",
                  "name": "Gold",
                  "type": "SSD",
                  "size_gb": "2",
                  "is_default": true
              }
          ],
          "state": "ENABLED",
          "user_comment": "test-user-comment"
      }
    ],
    "total": 1
}

Параметры ответа

Параметр	Тип	Опциональность	Описание
`id`	string	Обязательный	Идентификатор виртуального ЦОДа из VMware Cloud Director
`name`	string	Обязательный	Название виртуального ЦОДа
`description`	string	Опциональный	Описание виртуального ЦОДа
`allocation_model`	string[enum]	Обязательный	Тип тарификации: VDC_ALLOCATION_MODEL_UNSPECIFIED PAY_AS_YOU_GO ALLOCATION_POOL
`state`	string[enum]	Опциональный	Состояние виртуального ЦОДа: ENTITY_STATE_UNSPECIFIED ENABLED DISABLED
`provider_name`	string	Обязательный	Название кластера, в котором расположен виртуальный ЦОД
`cpu.quantity`	string($int64)	Обязательный	Количество CPU, шт
`cpu.freq_ghz`	string($double)	Обязательный	Частота CPU
`ram_size_gb`	string($int64)	Опциональный	Объем RAM, ГБ
`storages`	[массив]	Обязательный	Массив хранилищ в виртуальном ЦОДе
`storages.id`	string	Обязательный	Идентификатор хранилища
`storages.name`	string	Обязательный	Название типа хранилища
`storages.type`	string[enum]	Обязательный	Тип хранилища: STORAGE_TYPE_UNSPECIFIED SSD SAS SATA ENCRYPTED_SSD ENCRYPTED_SATA DR_SSD DR_SATA FAST_SSD ENCRYPTED_FAST_SSD DR_FAST_SSD
`storages.size_gb`	string($int64)	Обязательный	Объем хранилища, ГБ
`storages.is_default`	boolean	Обязательный	Хранилище по умолчанию
`total`	integer($int64)	Обязательный	Общее количество виртуальных ЦОДов в тенанте

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	Tenant not exists	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantNotFound = errors.New("tenant not found")`
404 Not Found	Tenant was deleted	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantDeleted = errors.New("tenant deleted")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`` ErrInsufficientPermissions = errors.New(«insufficient permissions»)``

Изменение типа тарификации PUT /vdcs/allocation-model 

Для услуги виртуального ЦОДа доступно изменение типа тарификации. Для запроса необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр

Тип

Опциональность

Описание

service_instance_id

string($uuid)

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

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

resource_id

string

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

Идентификатор виртуального ЦОДа

allocation_model

string

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

Тип тарификации, который нужно применить:

PAY_AS_YOU_GO
ALLOCATION_POOL

Запрос

curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs/allocation-model' \
--header 'content-type: application/json' \
--header 'idempotency-key: 7a0509fa-1001-4e16-ab81-c5b5a6ac9692' \
--header 'Authorization: Bearer TOKEN' \
--data '{
  "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
  "resource_id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
  "allocation_model": "PAY_AS_YOU_GO"
}'

Ответ 200 OK

В ответе вернется идентификатор и статус операции.

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	VDC not exists	The specified VDC does not exist	5 NOT_FOUND	`ErrVDCNotFound = errors.New("vdc not found")`
400 Bad Request	Invalid allocation model	The specified allocation model is incorrect. Please recheck the value	3 INVALID_ARGUMENT	`ErrAllocationModelInvalid = errors.New("allocation model is invalid")`
400 Bad Request	Allocation model update is not available for rvdc	Allocation model update is not available for rvdc. Please contact the support for details	3 INVALID_ARGUMENT	`ErrRvdcAllocationModel = errors.New("can't change allocation model for rvdc")`
400 Bad Request	Pay As You Go is not available for code-components enabled	Pay As You Go is not available for code-components enabled. Please contact the support for details	3 INVALID_ARGUMENT	`ErrOnlyPayaForCodeComponents = errors.New("only ALLOCATION_POOL available with code-components enabled")`
400 Bad Request	VDC is disabled	The VDC not in Active status cannot be updated. It should be put in active state	9 FAILED_PRECONDITION	`ErrVDCDisabled = errors.New("vdc should not be disabled")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`ErrInsufficientPermissions = errors.New("insufficient permissions")`

Изменение статуса виртуального ЦОДа PUT /vdcs/state 

Доступно изменение статуса витруального ЦОДа — включен или выключен. Для запроса необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр

Тип

Опциональность

Описание

service_instance_id

string($uuid)

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

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

resource_id

string

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

Идентификатор виртуального ЦОДа

vdc_state

string

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

Статус, который нужно применить:

Enabled
Disabled

Запрос

curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs/state' \
--header 'content-type: application/json' \
--header 'idempotency-key: 7a0509fa-1001-4e16-ab81-c5b5a6ac9692' \
--header 'Authorization: Bearer TOKEN' \
--data '{
  "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
  "resource_id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
  "state": "DISABLED"
}'

Ответ 200 OK

В ответе вернется идентификатор и статус операции.

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	Tenant not exists	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantNotFound = errors.New("tenant not found")`
404 Not Found	Tenant was deleted	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantDeleted = errors.New("tenant deleted")`
404 Not Found	VDC not exists	The specified VDC does not exist	5 NOT_FOUND	`ErrVDCNotFound = errors.New("vdc not found")`
400 Bad Request	Invalid state	The specified state is incorrect. Please recheck the value	3 INVALID_ARGUMENT	`ErrEntityStateInvalid = errors.New("entity state is invalid")`
400 Bad Request	VDC is disabled	The VDC not in Active status cannot be updated. It should be put in active state	9 FAILED_PRECONDITION	`ErrVDCDisabled = errors.New("vdc should not be disabled")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`ErrInsufficientPermissions = errors.New("insufficient permissions")`

Изменение количества CPU PUT /vdcs/cpu 

Для запроса необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр

Тип

Опциональность

Описание

service_instance_id

string($uuid)

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

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

resource_id

string

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

Идентификатор виртуального ЦОДа

cpu_quantity

string($int64)

minimum: 1

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

Новое значение количества CPU

Запрос

curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs/cpu' \
--header 'content-type: application/json' \
--header 'idempotency-key: 7a0509fa-1001-4e16-ab81-c5b5a6ac9693' \
--header 'Authorization: Bearer TOKEN' \
--data '{
  "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
  "resource_id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
  "cpu_quantity": "2"
}'

Ответ 200 OK

В ответе вернется идентификатор и статус операции.

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	Tenant not exists	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantNotFound = errors.New("tenant not found")`
404 Not Found	Tenant was deleted	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantDeleted = errors.New("tenant deleted")`
404 Not Found	VDC not exists	The specified VDC does not exist	5 NOT_FOUND	`ErrVDCNotFound = errors.New("vdc not found")`
400 Bad Request	The amount of CPUs limit is reached	The amount of CPUs limit is reached. Please contact the support to increase the limit	9 FAILED_PRECONDITION	`ErrLimits = errors.New("resource limits error")`
400 Bad Request	VDC is disabled	The VDC not in Active status cannot be updated. It should be put in active state	9 FAILED_PRECONDITION	`ErrVDCDisabled = errors.New("vdc should not be disabled")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`ErrInsufficientPermissions = errors.New("insufficient permissions")`

Изменение объема RAM PUT /vdcs/ram 

Для запроса необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр	Тип	Опциональность	Описание
`service_instance_id`	string($uuid)	Обязательный	Идентификатор тенанта
`resource_id`	string	Обязательный	Идентификатор виртуального ЦОДа
`ram_size_gb`	string($int64)	Обязательный	Новое значение объема RAM

Запрос

curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs/cpu' \
--header 'content-type: application/json' \
--header 'idempotency-key: 7a0509fa-1001-4e16-ab81-c5b5a6ac9693' \
--header 'Authorization: Bearer TOKEN' \
--data '{
  "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
  "resource_id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
  "ram_size_gb": "2"
}'

Ответ 200 OK

В ответе вернется идентификатор и статус операции.

Добавление хранилища PUT /vdcs/storages/add 

Чтобы установить добавляемое хранилище как хранилище по-умолчанию, нужно выполнить отдельный запрос.

Для запроса на добавление хранилища необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр	Тип	Опциональность	Описание
`service_instance_id`	string($uuid)	Обязательный	Идентификатор тенанта
`resource_id`	string	Обязательный	Идентификатор виртуального ЦОДа
`storages.type`	string[enum]	Обязательный	Тип хранилища: STORAGE_TYPE_UNSPECIFIED SSD SAS SATA ENCRYPTED_SSD ENCRYPTED_SATA DR_SSD DR_SATA FAST_SSD ENCRYPTED_FAST_SSD DR_FAST_SSD
`storages.size_gb`	string($int64)	Обязательный	Объем хранилища, ГБ

Запрос

curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs/storages/add' \
--header 'content-type: application/json' \
--header 'idempotency-key: 3a0509fa-1001-4e16-ab81-c5b5a6ac9693' \
--header 'Authorization: Bearer TOKEN' \
--data '{
  "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
  "resource_id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
  "type": "SATA",
  "size_gb": "2"
}'

Ответ 200 OK

В ответе вернется идентификатор и статус операции.

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	Tenant not exists	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantNotFound = errors.New("tenant not found")`
404 Not Found	Tenant was deleted	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantDeleted = errors.New("tenant deleted")`
404 Not Found	VDC not exists	The specified VDC does not exist	5 NOT_FOUND	`ErrVDCNotFound = errors.New("vdc not found")`
400 Bad Request	This storage type already exists	The specified storage type already exists. Please recheck the value or update the actual storage	9 FAILED_PRECONDITION	`ErrLimits = errors.New("resource limits error")`
400 Bad Request	The storage size limit is reached	The storage size limit is reached. Please contact the support to increase the limit	9 FAILED_PRECONDITION	`ErrLimits = errors.New("resource limits error")`
400 Bad Request	VDC is disabled	The VDC not in Active status cannot be updated. It should be put in active state	9 FAILED_PRECONDITION	`ErrVDCDisabled = errors.New("vdc should not be disabled")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`ErrInsufficientPermissions = errors.New("insufficient permissions")`

Изменение объема хранилища PUT /vdcs/storages/size 

Для запроса необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр	Тип	Опциональность	Описание
`service_instance_id`	string($uuid)	Обязательный	Идентификатор тенанта
`resource_id`	string	Обязательный	Идентификатор виртуального ЦОДа
`storage_id`	string	Обязательный	Идентификатор хранилища
`size_gb`	string($int64) minimum: 1	Обязательный	Новое значение размера хранилища

Запрос

curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs/storages/size' \
--header 'content-type: application/json' \
--header 'idempotency-key: 7a0509fa-1001-4e16-ab81-c5b5a6ac9693' \
--header 'Authorization: Bearer TOKEN' \
--data '{
  "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
  "resource_id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
  "storage_id": "6220b3ad-1bbb-47cc-8bd7-bc030332daf3",
  "size_gb": "2"
}'

Ответ 200 OK

В ответе вернется идентификатор и статус операции.

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	Tenant not exists	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantNotFound = errors.New("tenant not found")`
404 Not Found	Tenant was deleted	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantDeleted = errors.New("tenant deleted")`
404 Not Found	VDC not exists	The specified VDC does not exist	5 NOT_FOUND	`ErrVDCNotFound = errors.New("vdc not found")`
404 Not Found	Storage not exists	The specified storage does not exist	5 NOT_FOUND	`ErrStorageNotFound = errors.New("vdc storage not found")`
400 Bad Request	The storage size limit is reached	The storage size limit is reached. Please contact the support to increase the limit	9 FAILED_PRECONDITION	`ErrLimits = errors.New("resource limits error")`
400 Bad Request	VDC is disabled	The VDC not in Active status cannot be updated. It should be put in active state	9 FAILED_PRECONDITION	`ErrVDCDisabled = errors.New("vdc should not be disabled")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`ErrInsufficientPermissions = errors.New("insufficient permissions")`

Установка хранилища по-умолчанию PUT /vdcs/storages/default 

Если в виртуальном ЦОДе подключено только одно хранилище, оно всегда является хранилищем по-умолчанию.

Для запроса необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр	Тип	Опциональность	Описание
`service_instance_id`	string($uuid)	Обязательный	Идентификатор тенанта
`resource_id`	string	Обязательный	Идентификатор виртуального ЦОДа
`storage_id`	string	Обязательный	Идентификатор хранилища

Запрос

curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs/storages/size' \
--header 'content-type: application/json' \
--header 'idempotency-key: 7a0509fa-1001-4e16-ab81-c5b5a6ac9693' \
--header 'Authorization: Bearer TOKEN' \
--data '{
  "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
  "resource_id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
  "storage_id": "6220b3ad-1bbb-47cc-8bd7-bc030332daf3",
  "size_gb": "2"
}'

Ответ 200 OK

В ответе вернется идентификатор и статус операции.

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	Tenant not exists	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantNotFound = errors.New("tenant not found")`
404 Not Found	Tenant was deleted	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantDeleted = errors.New("tenant deleted")`
404 Not Found	VDC not exists	The specified VDC does not exist	5 NOT_FOUND	`ErrVDCNotFound = errors.New("vdc not found")`
404 Not Found	Storage not exists	The specified storage does not exist	5 NOT_FOUND	`ErrStorageNotFound = errors.New("vdc storage not found")`
400 Bad Request	Only one storage can be seleted by default	Please choose the only storage that should be set by default	9 FAILED_PRECONDITION	`ErrSelectSingleDefaultStorage = errors.New("should be selected single default storage")`
400 Bad Request	VDC is disabled	The VDC not in Active status cannot be updated. It should be put in active state	9 FAILED_PRECONDITION	`ErrVDCDisabled = errors.New("vdc should not be disabled")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`ErrInsufficientPermissions = errors.New("insufficient permissions")`

Удаление хранилища PUT /vdcs/storages/remove 

Если в виртуальном ЦОДе подключено только одно хранилище или хранилище выбрано хранилищем по-умолчанию, удаление недоступно.

Для запроса необходимы следующие параметры:

Параметры headers

idempotency-key — ключ идемпотентности в формате UUID-4, обязательный. Сгенерировать ключ можно через любой сервис, например Online UUID Generator.

Параметры body

Параметр	Тип	Опциональность	Описание
`service_instance_id`	string($uuid)	Обязательный	Идентификатор тенанта
`resource_id`	string	Обязательный	Идентификатор виртуального ЦОДа
`storage_id`	string	Обязательный	Идентификатор хранилища

Запрос

curl --location --request PUT 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/vdcs/storages/remove' \
--header 'content-type: application/json' \
--header 'idempotency-key: 4a0509fa-1001-4e16-ab81-c5b5a6ac9693' \
--header 'Authorization: Bearer TOKEN' \
--data '{
  "service_instance_id": "7e4c2391-25e1-47a3-b70f-20e2176dab2b",
  "resource_id": "704c7c7d-df62-4d67-bfc8-ae747d958613",
  "storage_id": "b4e548f2-8390-431e-a7b4-c53c4be95912"
}'

Ответ 200 OK

В ответе вернется идентификатор и статус операции удаления хранилища.

Ошибки в ответе

Status Codes	Message	Details	grpc	Комментарии
404 Not Found	Tenant not exists	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantNotFound = errors.New("tenant not found")`
404 Not Found	Tenant was deleted	The specified tenant does not exist	5 NOT_FOUND	`ErrTenantDeleted = errors.New("tenant deleted")`
404 Not Found	VDC not exists	The specified VDC does not exist	5 NOT_FOUND	`ErrVDCNotFound = errors.New("vdc not found")`
404 Not Found	Storage not exists	The specified storage does not exist	5 NOT_FOUND	`ErrStorageNotFound = errors.New("vdc storage not found")`
400 Bad Request	VDC is disabled	The VDC not in Active status cannot be updated. It should be put in active state	9 FAILED_PRECONDITION	`ErrVDCDisabled = errors.New("vdc should not be disabled")`
400 Bad Request	The storage is default	Storage set by default cannot be deleted. Another storage should be chosen by default at first	9 FAILED_PRECONDITION	`ErrRemoveDefaultStorage = errors.New("storage is default")`
403 Forbidden	Self-service not available	It is not possible to process the operation due to the self-service is not available for the current organization. Please contact the support for details	7 PERMISSION_DENIED	`ErrNoSelfService = errors.New("customer has no self-service enabled")`
403 Forbidden	Permission denied	The used account has no permissons for the operation. Please check the accounts roles or contact the support	7 PERMISSION_DENIED	`ErrInsufficientPermissions = errors.New("insufficient permissions")`

Удаление виртуального ЦОДа DELETE /tenants{tenant_id}&{vdc_id}

Перед удалением виртуальный ЦОД нужно перевести в статус «Disabled».

Для запроса удаления необходимы следующие параметры:

Параметры headers

Параметр

Тип

Опциональность

Описание

service_instance_id

string($uuid)

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

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

resource_id

string

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

Идентификатор виртуального ЦОДа

idempotency-key

string

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

Ключ идемпотентности в формате UUID-4.

Сгенерировать ключ можно через любой сервис, например Online UUID Generator

Запрос

curl --location --request DELETE 'https://vmware.api.cloud.ru/api/vmware-public/v1beta/tenants?
service_instance_id=211d549f-0fd8-445a-a7e7-d8fdef19865f&resource_id=704c7c7d-df62-4d67-bfc8-ae747d958613' \
--header 'accept: application/json' \
--header 'idempotency-key: 124e2dd0-f4b2-4586-827c-3025f8930250' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN'

Ответ 200 OK

В ответе вернется идентификатор и статус операции удаления виртуального ЦОДа.

Была ли статья полезной?

Спасибо за отзыв! Что можно улучшить?

Виртуальные ЦОДы