tocdepth

2

Вспомогательные методы

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

Получение информации об операции GET /operations/{operation_id}

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

Запрос
curl --location 'https://vmware.api.cloud.ru/api/vmware-public/operations/$operation_id' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN'

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

В ответе вернется актуальное состояние запрашиваемой операции.

{
   "id": "124e2dd0-f4b2-4586-827c-3025f8930257",
   "description": "",
   "completed": true,
   "response": {},
   "metadata": {
       "status": "SUCCESS",
       "service_instance_id": "eaf81279-8229-440a-81ed-04c5edea684c",
       "resource_id": "28293ba7-5e02-404f-965e-696ef8a115a7",
       "resource_name": "mg-apitest-1-g-k59CXis",
       "resource_type": "TENANT",
       "method": "/cloud.vmware.v1beta.TenantService/TenantState"
   },
   "created_at": "2024-10-07T09:57:55.926485Z",
   "created_by": "c9c9e57f-98e0-4b8c-a07b-c8d19b159ecc",
   "updated_at": "2024-10-07T09:57:59.027043Z"
}
Описание параметров

Параметр

Тип

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

Описание

operation_id

string($uuid)

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

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

description

string

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

Описание операции

completed

boolean

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

Статус операции

metadata

map<string, string>

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

Метаданные операции с идентификатором ресурса, над которым выполняется операция

created_at

string($date-time)

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

Дата и время создания операции

created_by

string($uuid)

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

Идентификатор пользователя, выполнившего операцию

updated_at

string($date-time)

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

Дата и время последнего обновления операции

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

Status Codes

Message

Details

grpc

Комментарии

404 Not Found

Operation not exists

The specified operation does not exist

5 NOT_FOUND

ErrOperationNotFound = fmt.Errorf("operation not found")

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")

Получение информации о списке операций

Для запроса используются полученные токен и project_id.

Запрос
curl --location 'https://vmware.api.cloud.ru/api/vmware-public/operations/$operation_id' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN'

Использование пагинации при запросе списков

Для работы со списками, например тенантов или операций, реализованы механизмы пагинации с указанием номера страницы и количества записей.

Параметры

Могут использоваться параметры:

  • pagination.page_size

  • pagination.page

При отсутствии в запросе параметров пагинации устанавливаются значения по умолчанию:

  • pagination.page_size = 100

  • pagination.page = 1

Пример запроса
curl --location 'https://vmware.api.cloud.ru/api/vmware-public/operations?project_id=84f2ac2b-0e1c-47b8-9898-21ec9301a733&pagination.page_size=3&pagination.page=1' \
Запустили Evolution free tier
для Dev & Test
Получить