Получение запроса удалённого доступа

Материал из Документация Ключ-АСТРОМ
Версия от 14:33, 22 сентября 2022; RGolovanov (обсуждение | вклад) (Новая страница: «Этот вызов API получает информацию запроса доступа к кластеру для определенного идентифи...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Этот вызов API получает информацию запроса доступа к кластеру для определенного идентификатора доступа запроса. Запрос создает полезную нагрузку application/json.

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

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

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

/api/cluster/v2/remoteaccess/requests

Параметры

Параметр Тип Описание В Обязательно
requestId string Параметр идентификатора запроса path Да

Ответ

Коды ответа

Код Тип Описание
200 AccessRequestData Успешно
400 Неверный запрос
403 Утверждение запроса на удаленный доступ отключено
404 Не найдено

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

Объект AccessRequestData

Элемент Тип Описание
requestId string Идентификатор запроса
userId string ID пользователя
reason string Описание причины запроса
requestedDays integer На сколько дней запрашивается доступ
role string Запрошенная роль

Элемент может содержать эти значения:

  • devops-admin
  • devops-user
  • devops-viewer
createdTimestamp integer Запрос на доступ создан в (отметка времени)
expirationTimestamp integer Доступ истекает в (отметка времени)
state string Состояние запроса доступа

Элемент может содержать эти значения

  • ACCEPTED
  • EXPIRED
  • PENDING
  • REJECTED
stateModifiedByUser string Состояние запроса на доступ было изменено пользователем

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

{
  "requestId": "string",
  "userId": "string",
  "reason": "string",
  "requestedDays": 1,
  "role": "devops-admin",
  "createdTimestamp": 1,
  "expirationTimestamp": 1,
  "state": "ACCEPTED",
  "stateModifiedByUser": "string"
}

Пример

В этом примере вы запрашиваете список разрешений на удаленный доступ для определенного идентификатора доступа запроса (7a397770-86b7-473b-b23e-4a07d79f2eff). В ответ вы получаете ответ JSON, который указывает, что идентификатор запроса 7a397770-86b7-473b-b23e-4a07d79f2eff предназначен для пользователя john.smith@dynatrace.com, у которого есть разрешение на удаленный доступ с ролью администратора в течение 7 дней, и причина заключается в проверке состояние кластера после обновления.

Curl

curl -X GET "https://myManaged.cluster.com/api/cluster/v2/remoteaccess/requests/7a397770-86b7-473b-b23e-4a07d79f2eff" -H  "accept: application/json"

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

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

Тело ответа

{
  "requestId": "7a397770-86b7-473b-b23e-4a07d79f2eff",
  "userId": "john.smith@dynatrace.com",
  "reason": "SUP-123456 Verifying cluster state after upgrade",
  "requestedDays": 7,
  "role": "devops-admin",
  "createdTimestamp": 1586452866661,
  "expirationTimestamp": 1587081600000,
  "state": "ACCEPTED",
  "stateModifiedByUser": "katie.novak"
}

Код ответа

200