Как начать работать с Yandex Cloud Quota Manager

Настройте работу с CLI

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Для просмотра квот аккаунт должен иметь роль quota-manager.viewer.

Посмотрите квоты

1. Посмотрите список сервисов, для которых есть квоты.

   yc quota-manager quota-limit list-services --resource-type=<тип_ресурса>
   

   Где --resource-type — тип ресурса:

   • resource-manager.cloud — облако;
   • organization-manager.organization — организация;
   • billing.account — платежный аккаунт.

   Пример:

   yc quota-manager quota-limit list-services --resource-type=resource-manager.cloud
   

   Будет выведен список сервисов, которые находятся на уровне облака и для которых есть квоты.

2. Посмотрите список квот для определенного сервиса, а также значение и потребление всех квот.

   yc quota-manager quota-limit list \
      --service=<название_сервиса> \
      --resource-type=<тип_ресурса> \
      --resource-id=<идентификатор_ресурса>
   

   Где:

   • --service — название сервиса, полученное на предыдущем шаге. Также название сервиса можно посмотреть в справочнике YC CLI.
   • --resource-id — идентификатор ресурса: идентификатор облака, организации или платежного аккаунта.
   • --resource-type — тип ресурса: resource-manager.cloud, organization-manager.organization, billing.account.

   Пример:

   yc quota-manager quota-limit list --service=iam --resource-type=resource-manager.cloud --resource-id=b1gflhy********
   

   Будут выведены идентификаторы квот, которые есть в сервисе IAM в облаке b1gflhy********. А также значение и потребление этих квот.

3. Посмотрите значение и потребление определенной квоты.

   yc quota-manager quota-limit get \
      --quota-id=<идентификатор_квоты> \
      --resource-id <идентификатор_ресурса> \
      --resource-type <тип_ресурса>
   

   Где:

   • --quota-id — идентификатор квоты, полученный на предыдущем шаге.
   • --resource-id — идентификатор ресурса (облака, организации или платежного аккаунта).
   • --resource-type — тип ресурса: resource-manager.cloud, organization-manager.organization, billing.account.

   Пример:

   yc quota-manager quota-limit get --quota-id=iam.apiKeys.count --resource-id=b1gflhy********  --resource-type=resource-manager.cloud
   

   Будут выведены значение и потребление квоты для количества API-ключей в облаке b1gflhy********:

   quota_id: iam.apiKeys.count
   limit: 1000
   usage: 27
   

   Где:

   • limit — значение квоты;
   • usage — потребление квоты.

Настройте работу с API

1. Чтобы проверить работу с квотами через API, установите утилиты:

   • cURL при использовании REST API.
   • gRPCurl при использовании gRPC API.

2. Создайте сервисный аккаунт с ролью quota-manager.viewer.

3. Получите IAM-токен для созданного сервисного аккаунта.

Посмотрите квоты

1. Посмотрите список сервисов, для которых есть квоты.

   Для этого воспользуйтесь методом REST API listServices для ресурса QuotaLimit или вызовом gRPC API QuotaLimitService/ListServices.

   Чтобы проверить работу метода REST API, выполните запрос:

   curl -X GET \
   --header "Authorization: Bearer <IAM-токен>" \
   "https://quota-manager.api.cloud.yandex.net/quota-manager/v1/quotaLimits/services?resourceType=<resourceType>"
   

   Где:

   • <resourceType> — тип ресурса: resource-manager.cloud, organization-manager.organization, billing.account.
   • <IAM-токен> — IAM-токен для сервисного аккаунта или переменная окружения, в которой находится IAM-токен.

   Пример запроса:

   curl -X GET \
   --header "Authorization: Bearer $IAM_TOKEN" \
   'https://quota-manager.api.cloud.yandex.net/quota-manager/v1/quotaLimits/services?resourceType=resource-manager.cloud'
   
   

2. Посмотрите список квот для определенного сервиса, а также значение и потребление всех квот.

   Для этого воспользуйтесь методом REST API list для ресурса QuotaLimit или вызовом gRPC API QuotaLimitService/List.

   Чтобы проверить работу метода REST API, выполните запрос:

   curl -X GET \
   --header "Authorization: Bearer <IAM-токен>" \
   "https://quota-manager.api.cloud.yandex.net/quota-manager/v1/quotaLimits?service=<serviceName>&resource.id=<resourceId>&resource.type=<resourceType>"
   

   Где:

   • <resourceId> — идентификатор ресурса: облака, организации или платежного аккаунта.
   • <resourceType> — тип ресурса: resource-manager.cloud, organization-manager.organization, billing.account.
   • <serviceName> — имя сервиса.
   • <IAM-токен> — IAM-токен для сервисного аккаунта или переменная окружения, в которой находится IAM-токен.

   Пример запроса:

   curl -X GET \
   --header "Authorization: Bearer $IAM_TOKEN" \
   'https://quota-manager.api.cloud.yandex.net/quota-manager/v1/quotaLimits?service=iam&resource.id=b1gflhy********&resource.type=resource-manager.cloud'
   

3. Посмотрите значение и потребление определенной квоты.

   Для этого воспользуйтесь методом REST API get для ресурса QuotaLimit или вызовом gRPC API QuotaLimitService/Get.

   Чтобы проверить работу метода REST API, выполните запрос:

   curl -X GET \
   --header "Authorization: Bearer <IAM-токен>" \
   "https://quota-manager.api.cloud.yandex.net/quota-manager/v1/quotaLimits/<quotaId>?resource.id=<resourceId>&resource.type=<resourceType>"
   

   Где:

   • <quotaId> — идентификатор квоты, полученный на предыдущем шаге.
   • <resourceId> — идентификатор ресурса (облака, организации или платежного аккаунта).
   • <resourceType> — тип ресурса: resource-manager.cloud, organization-manager.organization, billing.account.
   • <IAM-токен> — IAM-токен для сервисного аккаунта или переменная окружения, в которой находится IAM-токен.

   Пример запроса:

   curl -X GET \
   --header "Authorization: Bearer $IAM_TOKEN" \
   'https://quota-manager.api.cloud.yandex.net/quota-manager/v1/quotaLimits/iam.accessKeys.count?resource.id=b1gflhy********&resource.type=resource-manager.cloud'