Yandex Cloud
Документация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»
Yandex Managed Service for Valkey™
KZ
  • Начало работы
  • Управление доступом
  • Инспекции и рекомендации
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Вопросы и ответы

В этой статье:

  • HTTP request
  • Path parameters
  • Query parameters
  • Response
  • User
  • Permissions
  • ConnectionManager
  1. Справочник API
  2. REST (англ.)
  3. User
  4. List

Managed Service for Redis API, REST: User.List

Статья создана
Yandex Cloud
Обновлена 7 октября 2026 г.
Открыть в Markdown
  • HTTP request
  • Path parameters
  • Query parameters
  • Response
  • User
  • Permissions
  • ConnectionManager

Retrieves the list of Valkey User resources in the specified cluster.

HTTP requestHTTP request

GET https://mdb.api.yandexcloud.kz/managed-redis/v1/clusters/{clusterId}/users

Path parametersPath parameters

Field

Description

clusterId

string

Required field. ID of the cluster to list Valkey users in.
To get the cluster ID, use a ClusterService.List request.

The maximum string length in characters is 50.

Query parametersQuery parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListUsersResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

Acceptable values are 0 to 1000, inclusive.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListUsersResponse.nextPageToken returned by the previous list request.

The maximum string length in characters is 400.

ResponseResponse

HTTP Code: 200 - OK

{
  "users": [
    {
      "name": "string",
      "clusterId": "string",
      "permissions": {
        "patterns": "string",
        "pubSubChannels": "string",
        "categories": "string",
        "commands": "string",
        "sanitizePayload": "string",
        "databases": "string"
      },
      "enabled": "boolean",
      "aclOptions": "string",
      "connectionManager": {
        "connectionId": "string"
      },
      "authType": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

users[]

User

List of Valkey User resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListUsersRequest.pageSize, use the nextPageToken as the value
for the ListUsersRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the results.

UserUser

A Valkey User resource. For more information, see the
Developer's Guide.

Field

Description

name

string

Name of the Valkey user.

clusterId

string

ID of the Valkey cluster the user belongs to.

permissions

Permissions

Set of permissions to grant to the user.

enabled

boolean

Is Valkey user enabled

aclOptions

string

Raw ACL string inside of Valkey

connectionManager

ConnectionManager

Connection Manager connection configuration.

authType

enum (AuthType)

Authentication type for the user

  • AUTH_TYPE_PASSWORD: Password-based authentication
  • AUTH_TYPE_IAM: IAM-based authentication

PermissionsPermissions

Field

Description

patterns

string

Keys patterns user has permission to.

pubSubChannels

string

Channel patterns user has permissions to.

categories

string

Command categories user has permissions to.

commands

string

Commands user can execute.

sanitizePayload

string

Deprecated. This parameter is ignored.

databases

string

Databases parameter.

ConnectionManagerConnectionManager

Connection Manager connection configuration.

Field

Description

connectionId

string

ID of Connection Manager connection.

Была ли статья полезна?

Предыдущая
Get
Следующая
Create
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»