Изменение статуса запроса удалённого доступа: различия между версиями

Текущая версия от 07:33, 7 января 2025

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v2 / Удалённый доступ / Изменение статуса запроса удалённого доступа

Этот вызов API изменяет состояние запроса доступа для определенного идентификатора запроса. Вы можете установить запрос на доступ к состоянию PENDING, ACCEPTED, REJECTED или EXPIRED. Запрос использует полезную нагрузку application/json.

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

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

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

/api/cluster/v2/remoteaccess/requests

Параметры

Параметр	Тип	Описание	В	Обязательно
requestId	string	Параметр идентификатора запроса	path	Да
body	AccessRequestStateData	Тело запроса JSON, содержащее новое состояние запроса доступа.	body	Нет

Объекты тела запроса

Объект `AccessRequestStateData`

Элемент	Тип	Описание	Обязательно
state	string	Состояние запроса доступа Элемент может содержать эти значения `ACCEPTED` `EXPIRED` `PENDING` `REJECTED`	Нет

JSON-модель тела запроса

<{
  "state": "ACCEPTED"
}

Ответ

Коды ответа

Код	Описание
200	Успешно
400	Недопустимый запрос
403	Утверждение запроса на удаленный доступ отключено
404	Запрос доступа не найден
409	Запрос на доступ найден, но срок его действия уже истек
500	Операция не удалась

Пример

В этом примере вы запрашиваете изменение разрешения на удаленный доступ на отклоненное для идентификатора запроса на доступ: 7a397770-86b7-473b-b23e-4a07d79f2eff. Код ответа — 200, и состояние разрешений на удаленный доступ изменено.

Curl

curl -X PUT "https://myManaged.cluster.com/api/cluster/v2/remoteaccess/requests/7a397770-86b7-473b-b23e-4a07d79f2eff/state" -H "accept: */*" -H "Content-Type: */*" -d "{\"state\":\"ACCEPTED\"}"

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

https://myManaged.cluster.com/api/cluster/v2/remoteaccess/requests/7a397770-86b7-473b-b23e-4a07d79f2eff/state

Тело запроса

<{
  "state": "REJECTED"
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v2]] / [[API Кластера v2|Удалённый доступ]] / Изменение статуса запроса удалённого доступа'''''
 Этот вызов API изменяет состояние запроса доступа для определенного идентификатора запроса. Вы можете установить запрос на доступ к состоянию <code>PENDING</code>, <code>ACCEPTED</code>, <code>REJECTED</code> или <code>EXPIRED</code>. Запрос использует полезную нагрузку <code>application/json</code>.
 ==Аутентификация==
-Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ClusterTokenManagement, ServiceProvider или Nodekeeper)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
+Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ClusterTokenManagement, ServiceProvider или Nodekeeper)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
 ==Конечная точка==
 <code>/api/cluster/v2/remoteaccess/requests</code>
@@ Строка 49: / Строка 51: @@
 === JSON-модель тела запроса ===
-  <code>{
+  <{
     "state": "ACCEPTED"
-  }</code>
+  }
 ==Ответ==
@@ Строка 86: / Строка 88: @@
 ==== Тело запроса ====
-  <code>{
+  <{
     "state": "REJECTED"
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>