Предварительное и последующее написание скрипта - История изменений

IKuznetsov: /* Методы скрипта после выполнения */

2025-04-25T20:49:26Z

Методы скрипта после выполнения

← Предыдущая		Версия 20:49, 25 апреля 2025
Строка 216:		Строка 216:

	=== Методы скрипта до выполнения ===		=== Методы скрипта до выполнения ===
	Эти методы специфичны для запроса, поэтому их можно использовать только для ~~сценариев предварительного~~ выполнения.		Эти методы специфичны для запроса, поэтому их можно использовать только для скриптов до выполнения.

	* <code>request.addHeader(key, value)</code> — Добавляет заголовок запроса, где <code>key</code>— имя заголовка, а <code>value</code>— значение заголовка.		* <code>request.addHeader(key, value)</code> — Добавляет заголовок запроса, где <code>key</code>— имя заголовка, а <code>value</code>— значение заголовка.
Строка 223:		Строка 223:

	=== Методы скрипта после выполнения ===		=== Методы скрипта после выполнения ===
	Эти методы специфичны для ответа, поэтому их можно использовать только для ~~сценариев, выполняемых~~ после выполнения.		Эти методы специфичны для ответа, поэтому их можно использовать только для скриптов после выполнения.

	* <code>response.getResponseBody()</code> — Возвращает первые 50 КБ тела ответа в виде строки. Чтобы преобразовать ответ в формате JSON в объект, используйте, например:		* <code>response.getResponseBody()</code> — Возвращает первые 50 КБ тела ответа в виде строки. Чтобы преобразовать ответ в формате JSON в объект, используйте, например:
Строка 232:		Строка 232:
	\|}		\|}

	* <code>response.getHeaders()</code> — Возвращает объект, содержащий все заголовки HTTP ответа. Используйте <code>response.getHeaders().get(<header-name>)</code>для получения значения определенного заголовка ответа в виде строки.		* <code>response.getHeaders()</code> — Возвращает объект, содержащий все заголовки HTTP ответа. Используйте <code>response.getHeaders().get(<header-name>)</code> для получения значения определенного заголовка ответа в виде строки.
	* <code>response.getStatusCode()</code> — Возвращает код статуса ответа в виде числа.		* <code>response.getStatusCode()</code> — Возвращает код статуса ответа в виде числа.

IKuznetsov: /* Извлечь данные */

2025-04-25T20:48:11Z

Извлечь данные

← Предыдущая		Версия 20:48, 25 апреля 2025
Строка 186:		Строка 186:
	* <code>api.UUID()</code> — Возвращает универсальный уникальный идентификатор.		* <code>api.UUID()</code> — Возвращает универсальный уникальный идентификатор.

	* <code>api.getContext().location.name</code> — Возвращает имя частного или публичного расположения, из которого выполняется монитор. Это полезно при применении условной логики на основе расположения выполнения (например, при использовании различных данных для входа в каждое расположение) или для записи в логи, как показано в примере ниже. Пример:		* <code>api.getContext().location.name</code> — Возвращает имя частного или публичного расположения, из которого выполняется монитор. Это полезно при применении условной логики на основе расположения выполнения (например, при использовании различных данных для входа в каждое расположение) или для записи в логи, как показано в примере ниже.
			Пример:
			{\| class="wikitable"
			\|var loc = api.getContext().location.name;
			api.info("Location Name is: " + loc);
			\|}

			*<code>api.getCredential(id, type)</code> — Извлекает значение учетных данных, учитывая идентификатор учетных данных (<code>id</code>) и (<code>type</code>), который может быть <code>username</code>, <code>password</code>, или <code>token</code>. Вам необходимо предоставить точное значение одного из предложений автозаполнения для идентификатора учетных данных; использование динамических идентификаторов, таких как переменные, не поддерживается. Список состоит только из тех учетных данных, к которым у вас есть доступ. Для частных синтетических местоположений требуется АктивныхШлюз версии 1.212+. В целях безопасности мы рекомендуем использовать только специальные тестовые учетные данные для синтетических мониторов.
			Пример:
			{\| class="wikitable"
			\|var userName = api.getCredential("CREDENTIALS_VAULT-000000A0A00A0AA0", "username");
			api.setValue("un", userName + "1");
			\|}

			=== Запись данных ===

			* <code>api.saveCredential(id, username, password)</code> — Перезаписывает учетные данные имя пользователя-пароль, учитывая учетные данные <code>id</code>, новое значение для имени пользователя (<code>username</code>) и новое значение для пароля (<code>password</code>). Параметры <code>username</code> и <code>password</code> могут быть строками или переменными.

			Пример со строками имени пользователя и пароля:
			{\| class="wikitable"
			\|api.saveCredential("CREDENTIALS_VAULT-000000A0A00A0AA0", "newusername", "newpassword");
			\|}
			Пример с переменными, содержащими значения имени пользователя и пароля:
	{\| class="wikitable"		{\| class="wikitable"
	\|api.~~setValue~~("~~dateToFormat~~", ~~api.dateToFormat("1346524199000", "dd/MM/yy"));~~		\|api.saveCredential("CREDENTIALS_VAULT-000000A0A00A0AA0", myusernamevariable, mypasswordvariable);
	~~api.setValue("dateToFormatCurrentDate"~~, ~~api.dateToFormat(api.date(), "dd/MM/yy")~~);
	\|}		\|}

			* <code>api.saveToken(id, token)</code> — Перезаписывает учетные данные токена, учитывая учетные данные <code>id</code> и новое значение токена (<code>token</code>). Параметр <code>token</code> может быть строкой или переменной.

			=== Методы скрипта до выполнения ===
			Эти методы специфичны для запроса, поэтому их можно использовать только для сценариев предварительного выполнения.

			* <code>request.addHeader(key, value)</code> — Добавляет заголовок запроса, где <code>key</code>— имя заголовка, а <code>value</code>— значение заголовка.
			* <code>request.setUrl(URL)</code> — Устанавливает запрос <code>URL</code>.
			* <code>request.setBody(requestBody)</code> — Устанавливает тело запроса (<code>requestBody</code>).

			=== Методы скрипта после выполнения ===
			Эти методы специфичны для ответа, поэтому их можно использовать только для сценариев, выполняемых после выполнения.

			* <code>response.getResponseBody()</code> — Возвращает первые 50 КБ тела ответа в виде строки. Чтобы преобразовать ответ в формате JSON в объект, используйте, например:

			{\| class="wikitable"
			\|var responseBody = response.getResponseBody();
			var jsonData = JSON.parse(responseBody);
			\|}

	* <code>~~api~~.~~getCredential~~(~~id, type~~)</code> — ~~Извлекает значение учетных данных~~, ~~учитывая идентификатор учетных данных (~~ <code>~~id</code>~~) и ( <~~code>type</code~~>)~~, который может быть <code>username~~</code>, <code>~~password~~</code>, или <code>token</code>. Вам необходимо предоставить точное значение одного из предложений автозаполнения для идентификатора учетных данных; использование динамических идентификаторов, таких как переменные, не поддерживается. Список состоит только из тех учетных данных, к которым у вас есть доступ . Для частных синтетических местоположений требуется ActiveGate версии 1.212+ . В целях безопасности мы рекомендуем использовать только специальные тестовые учетные данные для синтетических мониторов. ~~Пример:~~		* <code>response.getHeaders()</code> — Возвращает объект, содержащий все заголовки HTTP ответа. Используйте <code>response.getHeaders().get(<header-name>)</code>для получения значения определенного заголовка ответа в виде строки.
			* <code>response.getStatusCode()</code> — Возвращает код статуса ответа в виде числа.

IKuznetsov: Новая страница: «При выполнении сложного API-монитора скрипты '''до''' и '''после выполнения''' позволяют добав...»

2025-04-25T20:40:57Z

Новая страница: «При выполнении сложного API-монитора скрипты '''до''' и '''после выполнения''' позволяют добав...»

Новая страница

При выполнении сложного API-монитора скрипты '''до''' и '''после выполнения''' позволяют добавлять логику '''до/после HTTP-запросов''' монитора (например, для пропуска запроса при определенных условиях, добавления заголовка, изменения содержимого тела или изменения URL). Скрипты основаны на пользовательском коде '''JavaScript''', который выполняется до и/или после выполнения каждого '''HTTP-запроса'''. Вы также можете задавать значения в своих скриптах и передавать их как переменные между запросами.

== Определение скриптов до и после выполнения ==
В режиме редактирования включите выполнение '''до''' или '''после скрипта''' в запросе для отображения редактора кода. По мере ввода редактор отображает встроенную справку с краткими описаниями доступных методов после ввода объектов <code>api</code>, <code>request</code> (для скриптов до выполнения) или <code>response</code> (для скриптов после выполнения).

Вы также можете добавлять скрипты с помощью '''режима скрипта''' — просто добавьте скрипт как значение ключей <code>preProcessingScript</code> или <code>postProcessingScript</code>. Однако при таком подходе вы не сможете использовать встроенный помощник метода и вам нужно будет экранировать все специальные символы и переносить строки с помощью обратной косой черты (например, новая строка — <code>\n</code>, двойные кавычки — <code>\"</code>, а табуляция — <code>\t</code>).

Объект <code>api</code> может использоваться в скриптах '''до''' или '''после выполнения''' для хранения и извлечения переменных, выполнения криптографических функций, регистрации данных, пропуска других запросов и многих других функций. Скрипты '''до выполнения''' используют объект <code>request</code> для добавления или изменения параметров текущего '''HTTP-запроса''' (например, URL, значения заголовков и тело запроса). Скрипты '''после выполнения''' используют объект <code>response</code> для доступа к телу ответа, заголовкам и коду состояния текущего '''HTTP-запроса''' после получения ответа.

Скрипты '''до''' и '''после выполнения''' имеют прямой доступ только к данным, полученным в результате текущего запроса. Другими словами, детали ответа доступны только в скрипте после выполнения того же запроса. Чтобы передать информацию другому запросу в том же мониторе, используйте '''переменную'''.

== Передача переменных ==
Переменные могут передаваться только в контексте одного выполнения '''HTTP-монитора'''. Вам также необходимо убедиться, что при обращении к переменной данные, стоящие за ней, логически доступны для монитора. Например, если вы устанавливаете переменную на основе данных из тела ответа запроса, вы не сможете получить значение в скрипте '''до выполнения''' для этого запроса, поскольку на этом этапе содержимое еще не существует.

После установки глобальной переменной с помощью метода <code>api.setValue()</code> вы можете применить ее значение с помощью соглашения <code>{variable_name}</code> с <code>api.getValue()</code> или <code>api.getValues()</code> в последующих скриптах '''до''' или '''после выполнения'''. Смотрите пример ниже о том, как установить переменную и получить ее с помощью <code>api.setValue()</code> и <code>api.getValue()</code>.

Вы также можете применить значение переменной, установленной ранее, <code>api.setValue()</code> в последующих полях конфигурации '''HTTP-монитора''', используя соглашение <code>{variable_name}</code>. Пользовательский интерфейс информирует вас, когда это возможно.

Имена переменных и ключей имеют ограничение в 100 символов. Значения глобальных переменных имеют ограничение в 5000 символов.

[[Файл:1305.png|граница]]

=== Пример монитора ===
В этом примере мы выполняем авторизацию '''OAuth 2.0''' с использованием скриптов '''до''' и '''после выполнения''', которые извлекают и применяют токен доступа.

'''HTTP-монитор''' состоит из двух запросов. Первый запрос извлекает токен доступа, а скрипт после выполнения сохраняет его в переменной <code>bearerToken</code>. Затем мы запускаем второй запрос, где скрипт '''до выполнения''' добавляет значение переменной <code>bearerToken</code> в заголовок авторизации запроса.

==== Запрос 1 ====
URL запроса : <code><nowiki>https://somesite.com/sso/oauth2/access_token?realm=/somename</nowiki></code> Метод HTTP : POST Скрипт после выполнения :
{| class="wikitable"
|if (response.getStatusCode() != 200) {
api.fail("HTTP error: " + response.getStatusCode());

}

var responseBody = response.getResponseBody();

var jsonData = JSON.parse(responseBody);

api.setValue("bearerToken", jsonData.access_token);

api.info(jsonData.access_token);
|}

==== Запрос 2 ====
URL запроса : <code><nowiki>https://account.somesite.com/rest/user/user%40somesite%2Ecom</nowiki>?</code> Метод HTTP : GET Скрипт до выполнения :
{| class="wikitable"
|request.addHeader("Authorization", "Bearer " + api.getValue("bearerToken"));
|}

==== Полный скрипт мониторинга ====
{| class="wikitable"
|{
"version": "1.0",

"requests": [

{

"description": "GET access_token",

"url": "<nowiki>https://somesite.com/sso/oauth2/access_token?realm=/somename</nowiki>",

"method": "POST",

"requestBody": "scope=openid%20read&client_secret=somesecret&grant_type=password&username=user%40somesite%2Ecom&password=password123&client_id=clientid",

"configuration": {

"requestHeaders": [

{

"name": "Content-Type",

"value": "application/x-www-form-urlencoded"

}

],

"acceptAnyCertificate": true,

"followRedirects": true

},

"preProcessingScript": "",

"postProcessingScript": "if (response.getStatusCode() != 200) {\n api.fail(\"HTTP error: \" + response.getStatusCode());\n}\nvar responseBody = response.getResponseBody();\nvar jsonData = JSON.parse(responseBody);\napi.setValue(\"bearerToken\", jsonData.access_token);\napi.info(jsonData.access_token);"

},

{

"description": "GET tenants",

"url": "<nowiki>https://account.somesite.com/rest/user/user%40somesite%2Ecom</nowiki>?",

"method": "GET",

"requestBody": "",

"configuration": {

"acceptAnyCertificate": true,

"followRedirects": true

},

"preProcessingScript": "request.addHeader(\"Authorization\", \"Bearer \" + api.getValue(\"bearerToken\"));",

"postProcessingScript": ""

}

]

}
|}

== Методы написания скрипта ==
При написании скриптов '''до''' и '''после выполнения''' вы можете использовать следующие методы в своем коде '''JavaScript'''. Редактор скриптов имеет встроенное руководство по синтаксису с опережающим вводом и проверку синтаксиса.

=== Сохранение и извлечение значений через HTTP-запросы ===

* <code>api.setValue(key, value)</code> — Устанавливает <code>value</code> для <code>key</code>. Используйте отдельный экземпляр <code>api.setValue()</code> для каждой пары ключ-значение, которую вы хотите указать.
* <code>api.getValue(key)</code> — Получает значение <code>key</code>, установленное ранее <code>api.setValue()</code>.
* <code>api.getValues()</code> — Возвращает объект, содержащий пары ключ-значение, которые были ранее установлены с помощью <code>api.setValue()</code>.

Имена переменных и ключей имеют ограничение в 100 символов. Значения глобальных переменных имеют ограничение в 5000 символов.

=== Отметить запросы как невыполненные или завершенные ===

* <code>api.fail(message)</code> — Отмечает запрос как неудавшийся, указывая <code>message</code> в качестве причины, и отмечает выполнение монитора как неудавшееся. Параметр <code>message</code> имеет ограничение в 1000 символов. <code>message</code> отображается как сообщение об ошибке на карточке '''События''' на странице сведений о мониторе HTTP. Пользовательские сообщения логов также отображаются в атрибуте <code>customLogs</code> в сведениях о выполнении монитора HTTP .
* <code>api.finish()</code> — Завершает запрос, чтобы был выполнен следующий запрос.

=== Пропустить HTTP-запросы ===
Эти методы пропускают HTTP-запросы после завершения текущего запроса.

* <code>api.skipNextRequest()</code> — Пропускает выполнение следующего запроса.
* <code>api.skipNextRequests(n)</code> — Пропускает выполнение следующих <code>n</code> последовательных запросов.
* <code>api.skipRequest(requestIndex)</code> — Пропускает выполнение запроса с индексом <code>requestIndex</code>. Номера индексов запросов начинаются с <code>1</code> и соответствуют номерам запросов, отображаемым в веб-интерфейсе.
* <code>api.skipRequests(requestIndexes)</code> — Пропускает выполнение нескольких запросов <code>requestIndexes</code>; Int32Array указывает запросы, которые нужно пропустить, например, <code>api.skipRequests(new Int32Array([2,4]))</code>. Вы также можете сначала определить массив, а затем ссылаться на него, например, <code>api.skipRequests(x)</code>, где <code>x=new Int32Array([2,4])</code> уже определено.

=== Базовое ведение логов ===

* <code>api.info(message)</code> — Регистрирует, <code>message</code> используя <code>info</code> уровень логов.
* <code>api.warn(message)</code> — Регистрирует, <code>message</code> используя <code>warning</code> уровень логов.
* <code>api.error(message)</code> — Регистрирует, <code>message</code> используя <code>error</code> уровень логов.

Параметр <code>message</code> имеет ограничение в 1000 символов. Сообщения регистрируются в файле <code>vuc-http-custom.log</code>, сохраненном в каталоге логов АктивногоШлюза, который доступен для частных синтетических расположений. Пользовательские сообщения логов также отображаются в атрибуте <code>customLogs</code> в сведениях о выполнении HTTP-монитора .

=== Базовая кодировка ===

* <code>api.urlEncode(url)</code> — Преобразует строку <code>url</code> в <code>application/x-www-form-urlencoded</code> в формат MIME.
* <code>api.base64UrlEncode(urlToEncode)</code> — Кодирует входные данные (<code>urlToEncode</code>) с использованием кодировки Base64URL.
* <code>api base64UrlDecode(encodedUrl)</code> — Декодирует входные данные Base64URL (<code>encodedUrl</code>).

* <code>api.HMACSHA256(message, secret)</code> — Создает хэш Base64 с использованием HMAC-SHA256, где <code>message</code>— текст, который требуется закодировать; <code>secret</code>— секретный ключ.
* <code>api.btoa(value)</code> — Создает строку ASCII в кодировке Base64 (<code>value</code>) из строки двоичных данных.
* <code>api.atob(value)</code> — Декодирует строку ASCII в кодировке Base64 ( <code>value</code>) в двоичную строку. Входная строка должна быть представлением Base64 допустимой строки UTF-8. Для более универсального декодирования Base64 используйте функцию <code>api.base64decode()</code>. Параметр <code>value</code> имеет ограничение в 10 000 символов.

=== Генерировать случайные значения ===

* <code>api.randomNextInt()</code> — Возвращает псевдослучайное, равномерно распределенное значение <code>int</code>.
* <code>api.randomNextIntWithBound(value)</code> — Возвращает псевдослучайное, равномерно распределенное значение <code>int</code> между 0 (включительно) и указанным (исключая) <code>value</code>.
* <code>api.randomNextFloat()</code> — Возвращает псевдослучайное, равномерно распределенное значение с плавающей точкой.
* <code>api.randomNextLong()</code> — Возвращает псевдослучайное, равномерно распределенное длинное значение.
* <code>api.randomString(numberOfChars, supportedChars)</code> — Создает случайную строку, длина которой равна количеству символов (<code>numberOfChars</code>); символы выбираются из набора символов, указанного в виде строки (<code>supportedChars</code>). Оба параметра имеют ограничение в 5000 символов.

=== Форматирование даты ===

* <code>api.dateToFormat(timestamp, format)</code> — Возвращает входные данные <code>timestamp</code> в указанном формате <code>format</code> на основе класса [https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html Java SimpleDateFormat]. Время <code>timestamp</code> должно быть в формате UNIX Epoch.
* <code>api.date()</code> — Возвращает текущую дату в виде необработанного значения в миллисекундах на основе эпохи UNIX.

Пример:
{| class="wikitable"
|api.setValue("dateToFormat", api.dateToFormat("1346524199000", "dd/MM/yy"));
api.setValue("dateToFormatCurrentDate", api.dateToFormat(api.date(), "dd/MM/yy"));
|}

=== Извлечь данные ===

* <code>api.UUID()</code> — Возвращает универсальный уникальный идентификатор.

* <code>api.getContext().location.name</code> — Возвращает имя частного или публичного расположения, из которого выполняется монитор. Это полезно при применении условной логики на основе расположения выполнения (например, при использовании различных данных для входа в каждое расположение) или для записи в логи, как показано в примере ниже. Пример:

{| class="wikitable"
|api.setValue("dateToFormat", api.dateToFormat("1346524199000", "dd/MM/yy"));
api.setValue("dateToFormatCurrentDate", api.dateToFormat(api.date(), "dd/MM/yy"));
|}

* <code>api.getCredential(id, type)</code> — Извлекает значение учетных данных, учитывая идентификатор учетных данных ( <code>id</code>) и ( <code>type</code>), который может быть <code>username</code>, <code>password</code>, или <code>token</code>. Вам необходимо предоставить точное значение одного из предложений автозаполнения для идентификатора учетных данных; использование динамических идентификаторов, таких как переменные, не поддерживается. Список состоит только из тех учетных данных, к которым у вас есть доступ . Для частных синтетических местоположений требуется ActiveGate версии 1.212+ . В целях безопасности мы рекомендуем использовать только специальные тестовые учетные данные для синтетических мониторов. Пример: