IKuznetsov в 16:47, 2 января 2025

2025-01-02T16:47:48Z

← Предыдущая версия		Версия от 16:47, 2 января 2025
Строка 1:		Строка 1:
			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D0%BE%D0%B4%D0%B8%D0%BD%20SLO-,%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B8,-%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B Настройки] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B8-,%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B,-GET%20%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B Объекты] / GET объект*'''''

	Получает указанный объект настроек.		Получает указанный объект настроек.

Строка 136:		Строка 138:
	"autoMonitoring": true		"autoMonitoring": true
	}		}
	}~~</code>~~		}

IKuznetsov в 20:57, 25 декабря 2024

2024-12-25T20:57:19Z

← Предыдущая версия		Версия от 20:57, 25 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>
	\|-		\|-
Строка 122:		Строка 122:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"schemaVersion": "1.0.0",		"schemaVersion": "1.0.0",
	"updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",		"updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",

ENetrebin: Новая страница: «Получает указанный объект настроек. Запрос создает в качестве полезной нагрузки `applic...»`


2022-10-20T09:04:19Z
Новая страница: «Получает указанный объект настроек.  Запрос создает в качестве полезной нагрузки <code>applic...»
Новая страница
Получает указанный объект настроек.



Запрос создает в качестве полезной нагрузки <code>application/json</code>формат.

{| class="wikitable"

| rowspan="2" |GET

|Managed

|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>

|-

|Cреда АктивногоШлюза

|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>

|}



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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение настроек ( <code>settings.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .



== Параметры ==

{| class="wikitable"

!Параметр

!Тип

!Описание

!In

!Необходимость

|-

|objectId

|string

|Идентификатор требуемого объекта настроек.

|path

|требуется

|}



== Ответ ==



=== Коды ответов ===

{| class="wikitable"

!Код

|Тип

!Описание

|-

|200

|SettingsObject

|Успех

|-

|403

|ErrorEnvelope

|Не удалось. Запрещенный.

|-

|404

|ErrorEnvelope

|Нет доступного объекта для данного objectId

|}



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



==== Объект <code>SettingsObject</code> ====

Объект настроек.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|schemaVersion

|string

|Версия схемы, на которой основан объект.

|-

|updateToken

|string

|Токен обновления объекта. Вы можете использовать его для обнаружения одновременных изменений разными пользователями.



Генерируется при извлечении (запросы GET). Если установлено при обновлении (запрос PUT) или удалении, обновление/удаление будет разрешено только в том случае, если не было никаких изменений между получением и обновлением.



Если опущено при обновлении/удалении, операция переопределяет текущее значение или удаляет его без каких-либо проверок.

|-

|modified

|integer

|Отметка времени последней модификации.

|-

|externalId

|string

|Внешний идентификатор объекта настроек.

|-

|author

|string

|Пользователь (идентифицируемый по идентификатору пользователя или общедоступному идентификатору токена), выполнивший последнее изменение.

|-

|schemaId

|string

|Схема, на которой основан объект.

|-

|objectId

|string

|Идентификатор объекта настроек.

|-

|created

|integer

|Отметка времени создания.

|-

|scope

|string

|Область, на которую нацелен объект.

|-

|summary

|string

|Кратко о настройках.

|-

|value

|SettingsValue

|Значение настройки.



Он определяет фактические значения параметров настроек.



Фактическое содержимое зависит от схемы объекта.

|}



==== Объект <code>SettingsValue</code> ====

Значение настройки.



Он определяет фактические значения параметров настроек.



Фактическое содержимое зависит от схемы объекта.



Объект не предоставляет никаких параметров.



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

 <code>{

   "schemaVersion": "1.0.0",

   "updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",

   "modified": 1,

   "externalId": "string",

   "author": "john.doe@example.com",

   "schemaId": "builtin:container.built-in-monitoring-rule",

   "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",

   "created": 1,

   "scope": "HOST-D3A3C5A146830A79",

   "summary": "string",

   "value": {

     "autoMonitoring": true

   }

 }</code>

GET объект* - История изменений

IKuznetsov в 16:47, 2 января 2025

IKuznetsov в 20:57, 25 декабря 2024

ENetrebin: Новая страница: «Получает указанный объект настроек. Запрос создает в качестве полезной нагрузки applic...»

ENetrebin: Новая страница: «Получает указанный объект настроек. Запрос создает в качестве полезной нагрузки `applic...»`