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

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

Этот вызов API получает список всех текущих запросов на доступ к кластеру, включая пользователя, роль доступа, продолжительность доступа и состояние запроса.

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

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

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

/api/cluster/v2/remoteaccess/requests

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответа

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

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

Объект 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"
  }
]

Пример

В этом примере вы запрашиваете у кластера (myManaged.cluster.com) список всех текущих запросов на удаленный доступ.

Curl

curl -X GET "https://myManaged.cluster.com/api/cluster/v2/remoteaccess/requests" -H  "accept: application/json"

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

https://myManaged.cluster.com/api/cluster/v2/remoteaccess/requests

Тело ответа

{
  "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":null,
  "state":"PENDING",
  "stateModifiedByUser":null
}

Код ответа

200