Получение свойств окружения

Этот вызов API получает свойства указанной среды.

Аутентификация

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/cluster/v2/environments

Параметры

Параметр	Тип	Описание	В	Обязательно
id	string	Идентификатор среды.	path	Да
includeConsumptionInfo	boolean	Если true, информация о потреблении (лимиты, использование) возвращается для каждой среды. Возвращенное использование, как правило, до 1 часа назад. Чтобы получить более свежие данные, вы можете вместо этого использовать параметр includeUncachedConsumptionInfo.	query	Нет
includeStorageInfo	boolean	Если true, информация о хранилище (ограничения, использование) возвращается для каждой среды.	query	Нет
includeUncachedConsumptionInfo	boolean	Если true, для каждой среды возвращается некэшированная информация о потреблении (лимиты, использование). Будет рассчитан актуальный расход. Вычисление может занять много времени, поэтому вместо него рекомендуется использовать параметр includeConsummentInfo. Если установлены и этот параметр, и includeConsummentInfo, то includeUncachedConsumptionInfo будет иметь приоритет.	query	Нет

Ответ

Коды ответа

Код	Тип	Описание
200	Environment	Успешно

Объекты тела ответа

Объект Environment

Элемент	Тип	Описание
name	string	Отображаемое имя среды.
id	string	Идентификатор среды. Должен соответствовать [a-zA-Z0-9_-]{1,70}
trial	boolean	Указывает, является ли среда пробной или непробной. Создание пробной среды возможно только в том случае, если это позволяет ваша лицензия. Значение по умолчанию — false (не пробная версия).
state	string	Указывает, включена или отключена среда (DISABLED, ENABLED). Значение по умолчанию — ENABLED
tags	string[]	Набор тегов, которые назначаются этой среде. Каждый тег может иметь максимальную длину 100 символов.
creationDate	string	Дата создания среды в формате ISO 8601 (гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z')
quotas	EnvironmentQuotas	Информация о потреблении на уровне среды и квотах. Возвращается только в том случае, если для параметра includeConsumptionInfo или includeUncachedConsumptionInfo установлено значение true. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.
storage	EnvironmentStorage	Использование хранилища на уровне среды и информация об ограничениях. Не возвращается, если параметр includeStorageInfo не равен true. Если пропустить при редактировании методом PUT, то уже установленные лимиты останутся.

Объект EnvironmentQuotas

Информация о потреблении на уровне среды и квотах. Возвращается только в том случае, если для параметра includeConsumptionInfo или includeUncachedConsumptionInfo установлено значение true. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.

Элемент	Тип	Описание
hostUnits	HostUnitQuota	Информация о потреблении хост-модулей и квотах на уровне среды. Если пропустить при редактировании методом PUT, то уже установленная квота останется.
demUnits	DemUnitsQuota	Потребление единиц DEM и информация о квотах на уровне среды. Не устанавливается (и не редактируется), если единицы ЦМР не включены. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.
userSessions	UserSessionsQuota	Информация о потреблении пользовательских сеансов и квоте на уровне среды. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.
sessionProperties	SessionPropertiesQuota	Информация о потреблении свойств сеанса пользователя на уровне среды.
syntheticMonitors	SyntheticQuota	Синтетика отслеживает потребление и информацию о квотах на уровне среды. Не устанавливается (и не редактируется), если не включены ни синтетические, ни цифровые единицы измерения. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.
customMetrics	CustomMetricsQuota	Использование пользовательских метрик и информация о квотах на уровне среды. Не задано (и недоступно для редактирования), если специальные показатели не включены. Не устанавливается (и не редактируется), если включены единицы данных Дейвиса. Если пропустить при редактировании методом PUT, то уже установленная квота останется.
AIDataUnits	AIDataUnitsQuota	Потребление единиц данных ИИ и информация о квотах на уровне среды. Не устанавливается (и не редактируется), если единицы данных Дэвиса не включены. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.
logMonitoring	LogMonitoringQuota	Журнал мониторинга потребления и информации о квотах на уровне среды. Не задано (и недоступно для редактирования), если мониторинг журналов не включен. Не задано (и недоступно для редактирования), если мониторинг журналов перенесен в данные AI на уровне лицензии. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.

Объект HostUnitQuota

Информация о потреблении хост-модулей и квотах на уровне среды. Если пропустить при редактировании методом PUT, то уже установленная квота останется.

Элемент	Тип	Описание
currentUsage	number	Текущее использование среды.
maxLimit	integer	Параллельная квота среды. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.

Объект DemUnitsQuota

Потребление единиц DEM и информация о квотах на уровне среды. Не устанавливается (и не редактируется), если единицы ЦМР не включены. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.

Элемент	Тип	Описание
consumedThisMonth	number	Ежемесячное потребление окружающей среды. Сбрасывается каждый календарный месяц.
consumedThisYear	number	Годовое потребление среды. Сбрасывается каждый год в годовщину создания лицензии.
monthlyLimit	integer	Ежемесячная квота окружающей среды. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.
annualLimit	integer	Годовая квота. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.

Объект UserSessionsQuota

Информация о потреблении пользовательских сеансов и квоте на уровне среды. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.

Элемент	Тип	Описание
consumedUserSessionsWithMobileSessionReplayThisYear	number	Ежегодные сеансы мобильных пользователей с использованием среды воспроизведения. Сбрасывается каждый год в годовщину создания лицензии.
consumedUserSessionsWithWebSessionReplayThisMonth	number	Ежемесячные сеансы веб-пользователей с использованием среды воспроизведения. Сбрасывает каждый календарный месяц.
consumedUserSessionsWithMobileSessionReplayThisMonth	number	Ежемесячные сеансы мобильных пользователей с использованием среды воспроизведения. Сбрасывает каждый календарный месяц.
totalAnnualLimit	integer	Общая годовая квота среды сеансов пользователей. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.
totalConsumedThisMonth	number	Ежемесячное потребление среды сеансов пользователей. Сбрасывает каждый календарный месяц.
totalConsumedThisYear	number	Общее годовое потребление среды сеансов пользователей. Сбрасывается каждый год в годовщину создания лицензии.
totalMonthlyLimit	integer	Ежемесячная квота среды сеансов пользователей. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.
consumedUserSessionsWithWebSessionReplayThisYear	number	Ежегодные сеансы веб-пользователей с использованием среды воспроизведения. Сбрасывается каждый год в годовщину создания лицензии.
consumedMobileSessionsThisMonth	number	Ежемесячное потребление среды сеансов мобильных пользователей. Сбрасывает каждый календарный месяц.
consumedMobileSessionsThisYear	number	Годовое потребление среды сеансов мобильных пользователей. Сбрасывается каждый год в годовщину создания лицензии.

Объект SessionPropertiesQuota

User session properties consumption information on environment level.

Элемент	Тип	Описание
consumedThisMonth	number	Ежемесячное потребление окружающей среды. Сбрасывает каждый календарный месяц.
consumedThisYear	number	Годовое потребление окружающей среды. Сбрасывается каждый год в годовщину создания лицензии.

Объект SyntheticQuota

Синтетика отслеживает потребление и информацию о квотах на уровне среды. Не устанавливается (и не редактируется), если не включены ни синтетические, ни цифровые единицы измерения. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.

Элемент	Тип	Описание
consumedThisMonth	number	Ежемесячное потребление окружающей среды. Сбрасывает каждый календарный месяц.
consumedThisYear	number	Годовое потребление окружающей среды. Сбрасывается каждый год в годовщину создания лицензии.
monthlyLimit	integer	Ежемесячная квота окружающей среды. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.
annualLimit	integer	Годовая экологическая квота. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.

Объект CustomMetricsQuota

Использование пользовательских метрик и информация о квотах на уровне среды. Не задано (и недоступно для редактирования), если специальные показатели не включены. Не устанавливается (и не редактируется), если включены единицы данных Дейвиса. Если пропустить при редактировании методом PUT, то уже установленная квота останется.

Элемент	Тип	Описание
currentUsage	number	Текущее использование среды.
maxLimit	integer	Параллельная квота среды. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.

Объект AIDataUnitsQuota

Потребление единиц данных Дэвиса и информация о квотах на уровне среды. Не устанавливается (и не редактируется), если единицы данных Дейвиса не включены. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.

Элемент	Тип	Описание
consumedThisMonth	number	Ежемесячное потребление окружающей среды. Сбрасывает каждый календарный месяц.
consumedThisYear	number	Годовое потребление окружающей среды. Сбрасывается каждый год в годовщину создания лицензии.
monthlyLimit	integer	Ежемесячная квота окружающей среды. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.
annualLimit	integer	Годовая экологическая квота. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.

Объект LogMonitoringQuota object

Журнал мониторинга потребления и информации о квотах на уровне среды. Не задано (и недоступно для редактирования), если мониторинг журналов не включен. Не задано (и недоступно для редактирования), если мониторинг журналов перенесен в данные ИИ на уровне лицензии. Если пропустить при редактировании методом PUT, то уже установленные квоты останутся.

Элемент	Тип	Описание
consumedThisMonth	number	Ежемесячное потребление окружающей среды. Сбрасывает каждый календарный месяц.
consumedThisYear	number	Годовое потребление окружающей среды. Сбрасывается каждый год в годовщину создания лицензии.
monthlyLimit	integer	Ежемесячная квота окружающей среды. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.
annualLimit	integer	Годовая экологическая квота. Не устанавливается, если неограничен. При обновлении методом PUT пропуск этого поля приведет к неограниченной квоте.

Объект EnvironmentStorage object

Использование хранилища на уровне среды и информация об ограничениях. Не возвращается, если параметр includeStorageInfo не равен true. Если пропустить при редактировании методом PUT, то уже установленные лимиты останутся.

Элемент	Тип	Описание
transactionStorage	TransactionStorage	Использование хранилища транзакций и ограничение информации на уровне среды. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
sessionReplayStorage	SessionReplayStorage	Использование хранилища повторов сеансов и ограничение информации на уровне среды. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
symbolFilesFromMobileApps	SymbolFilesFromMobileApps	Файлы символов из хранилища мобильных приложений используют информацию об использовании и ограничениях на уровне среды. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
logMonitoringStorage	LogMonitoringStorage	Журнал мониторинга использования хранилища и информации об ограничениях на уровне среды. Недоступно для редактирования, если мониторинг журналов не разрешен лицензией или не настроен на уровне кластера. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
serviceRequestLevelRetention	ServiceRequestLevelRetention	Параметры хранения уровня запросов на обслуживание на уровне среды. Срок хранения на уровне сервисного кода не может быть больше, чем срок хранения на уровне сервисного запроса, и оба не могут превышать один год. Если пропустить при редактировании с помощью метода PUT, то уже установленное ограничение останется.
serviceCodeLevelRetention	ServiceCodeLevelRetention	Параметры хранения на уровне кода службы на уровне среды. Срок хранения на уровне сервисного кода не может быть больше, чем срок хранения на уровне сервисного запроса, и оба не могут превышать один год. Если пропустить при редактировании с помощью метода PUT, то уже установленное ограничение останется.
realUserMonitoringRetention	RealUserMonitoringRetention	Реальные параметры хранения мониторинга пользователей на уровне среды. Может быть установлено любое значение от 1 до 35 дней. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
syntheticMonitoringRetention	SyntheticMonitoringRetention	Настройки хранения синтетического мониторинга на уровне среды. Может быть установлено любое значение от 1 до 35 дней. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
sessionReplayRetention	SessionReplayRetention	Параметры сохранения воспроизведения сеанса на уровне среды. Может быть установлено любое значение от 1 до 35 дней. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
logMonitoringRetention	LogMonitoringRetention	Параметры хранения мониторинга журнала на уровне среды. Недоступно для редактирования, если мониторинг журналов не разрешен лицензией или не настроен на уровне кластера. Может быть установлено любое значение от 5 до 90 дней. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
userActionsPerMinute	UserActionsPerMinute	Максимальное количество пользовательских действий, генерируемых в минуту на уровне среды. Можно установить любое значение от 1 до 2 147 483 646 или оставить без ограничений. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.
transactionTrafficQuota	TransactionTrafficQuota	Максимальное количество новых отслеживаемых точек входа PurePath, захваченных за процесс в минуту на уровне среды. Может быть установлено любое значение от 100 до 100000. Если пропустить при редактировании методом PUT, то останется уже установленный лимит.

Объект TransactionStorage

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

Элемент	Тип	Описание
retentionReductionPercentage	string	Процент усечения для новых данных.
retentionReductionReason	string	Причина усечения.
maxLimit	integer	Максимальный предел хранения [байт]
currentlyUsed	integer	Текущее используемое хранилище [байт]

Объект SessionReplayStorage

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

Элемент	Тип	Описание
retentionReductionPercentage	string	Процент усечения для новых данных.
retentionReductionReason	string	Причина усечения.
maxLimit	integer	Максимальный предел хранения [байт]
currentlyUsed	integer	Текущее используемое хранилище [байт]

Объект SymbolFilesFromMobileApps

Файлы символов из хранилища мобильных приложений используют информацию об использовании и ограничениях на уровне среды. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.

Элемент	Тип	Описание
maxLimit	integer	Максимальный предел хранения [байт]
currentlyUsed	integer	Текущее используемое хранилище [байт]

Объект LogMonitoringStorage

Журнал мониторинга использования хранилища и информации об ограничениях на уровне среды. Недоступно для редактирования, если мониторинг журналов не разрешен лицензией или не настроен на уровне кластера. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.

Элемент	Тип	Описание
maxLimit	integer	Максимальный предел хранения [байт]
currentlyUsed	integer	Текущее используемое хранилище [байт]

Объект ServiceRequestLevelRetention

Параметры хранения уровня запросов на обслуживание на уровне среды. Срок хранения на уровне сервисного кода не может быть больше, чем срок хранения на уровне сервисного запроса, и оба не могут превышать один год. Если пропустить при редактировании с помощью метода PUT, то уже установленное ограничение останется.

Элемент	Тип	Описание
maxLimitInDays	integer	Максимальный срок хранения [дней]
currentlyUsedInMillis	integer	Текущий возраст данных [миллисекунды]
currentlyUsedInDays	integer	Текущий возраст данных [дни]

Объект ServiceCodeLevelRetention

Параметры хранения на уровне кода службы на уровне среды. Срок хранения на уровне сервисного кода не может быть больше, чем срок хранения на уровне сервисного запроса, и оба не могут превышать один год. Если пропустить при редактировании с помощью метода PUT, то уже установленное ограничение останется.

Элемент	Тип	Описание
maxLimitInDays	integer	Максимальный срок хранения [дней]
currentlyUsedInMillis	integer	Текущий возраст данных [миллисекунды]
currentlyUsedInDays	integer	Текущий возраст данных [дни]

Объект RealUserMonitoringRetention

Реальные параметры хранения мониторинга пользователей на уровне среды. Может быть установлено любое значение от 1 до 35 дней. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.

Элемент	Тип	Описание
maxLimitInDays	integer	Максимальный срок хранения [дней]
currentlyUsedInMillis	integer	Текущий возраст данных [миллисекунды]
currentlyUsedInDays	integer	Текущий возраст данных [дни]

Объект SyntheticMonitoringRetention

Настройки хранения синтетического мониторинга на уровне среды. Может быть установлено любое значение от 1 до 35 дней. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.

Элемент	Тип	Описание
maxLimitInDays	integer	Максимальный срок хранения [дней]
currentlyUsedInMillis	integer	Текущий возраст данных [миллисекунды]
currentlyUsedInDays	integer	Текущий возраст данных [дни]

Объект SessionReplayRetention

Параметры сохранения воспроизведения сеанса на уровне среды. Может быть установлено любое значение от 1 до 35 дней. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.

Элемент	Тип	Описание
maxLimitInDays	integer	Максимальный срок хранения [дней]
currentlyUsedInMillis	integer	Текущий возраст данных [миллисекунды]
currentlyUsedInDays	integer	Текущий возраст данных [дни]

Объект LogMonitoringRetention

Параметры хранения мониторинга журнала на уровне среды. Недоступно для редактирования, если мониторинг журналов не разрешен лицензией или не настроен на уровне кластера. Может быть установлено любое значение от 5 до 90 дней. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.

Элемент	Тип	Описание
maxLimitInDays	integer	Максимальный срок хранения [дней]
currentlyUsedInMillis	integer	Текущий возраст данных [миллисекунды]
currentlyUsedInDays	integer	Текущий возраст данных [дни]

Объект UserActionsPerMinute

Максимальное количество пользовательских действий, генерируемых в минуту на уровне среды. Можно установить любое значение от 1 до 2 147 483 646 или оставить без ограничений. Если пропустить при редактировании методом PUT, то уже установленный лимит останется.

Элемент	Тип	Описание
maxLimit	integer	Максимальный трафик [единиц в минуту]

Объект TransactionTrafficQuota

Максимальное количество новых отслеживаемых точек входа PurePath, захваченных за процесс в минуту на уровне среды. Может быть установлено любое значение от 100 до 100000. Если пропустить при редактировании методом PUT, то останется уже установленный лимит.

Элемент	Тип	Описание
maxLimit	integer	Максимальный трафик [единиц в минуту]

JSON-модель тела ответа

{
  "name": "example environment",
  "state": "ENABLED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "trial": false
}

Пример

Находит среду с идентификатором be22c776-1414-43f3-b39b-32e7bddcb0a3 и включает данные о потреблении.

Curl

curl -X GET "https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e?includeConsumptionInfo=true" -H "accept: application/json; charset=utf-8" -H "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890"

URL-адрес запроса

https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e?includeConsumptionInfo=true

Тело ответа

{
  "name": "MyNewTeam",
  "id": "19a963a7-b19f-4382-964a-4df674c8eb8e",
  "trial": false,
  "state": "ENABLED",
  "tags": [
    "owner:somebody@mycompany.ru",
    "department:finance"
  ],
  "creationDate": "2021-03-09T08:43:32.496Z",
  "quotas": {
    "hostUnits": {
      "maxLimit": null,
      "currentUsage": 0
    },
    "demUnits": {
      "monthlyLimit": null,
      "annualLimit": null,
      "consumedThisMonth": 0,
      "consumedThisYear": 0
    },
    "userSessions": {
      "totalMonthlyLimit": null,
      "totalAnnualLimit": null,
      "totalConsumedThisMonth": 0,
      "totalConsumedThisYear": 0,
      "consumedMobileSessionsThisMonth": 0,
      "consumedMobileSessionsThisYear": 0,
      "consumedUserSessionsWithWebSessionReplayThisMonth": 0,
      "consumedUserSessionsWithWebSessionReplayThisYear": 0,
      "consumedUserSessionsWithMobileSessionReplayThisMonth": 0,
      "consumedUserSessionsWithMobileSessionReplayThisYear": 0
    },
    "sessionProperties": {
      "consumedThisMonth": 0,
      "consumedThisYear": 0
    },
    "syntheticMonitors": {
      "monthlyLimit": null,
      "annualLimit": null,
      "consumedThisMonth": 0,
      "consumedThisYear": 0
    },
    "customMetrics": null,
    "AIDataUnits": {
      "monthlyLimit": null,
      "annualLimit": null,
      "consumedThisMonth": 0,
      "consumedThisYear": 0
    },
    "logMonitoring": null
  }
}

Код ответа

200