Связаться с намиПодключиться

Managed Service for SPQR API, REST: User.List

Статья создана
Обновлена 3 октября 2025 г.

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

HTTP request

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

Path parameters

Field

Description

clusterId

string

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

Query 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.

pageToken

string

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

Response

HTTP Code: 200 - OK

{
  "users": [
    {
      "name": "string",
      "clusterId": "string",
      "permissions": [
        {
          "databaseName": "string"
        }
      ],
      "settings": {
        "connectionLimit": "string",
        "connectionRetries": "string"
      },
      "grants": [
        "string"
      ]
    }
  ],
  "nextPageToken": "string"
}

Field

Description

users[]

User

List of SPQR 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.

User

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

Field

Description

name

string

Name of the SPQR user.

clusterId

string

ID of the SPQR cluster the user belongs to.

permissions[]

Permission

Set of permissions granted to the user.

settings

UserSettings

SPQR Settings for this user

grants[]

string

User grants

Permission

Field

Description

databaseName

string

Name of the database that the permission grants access to.

UserSettings

Field

Description

connectionLimit

string (int64)

connectionRetries

string (int64)
Предыдущая
Get
Следующая
Create