Managed Service for SPQR API, REST: User.List
Retrieves the list of SPQR User resources in the specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-spqr/v1/clusters/{clusterId}/users
Path parameters
|
Field |
Description |
|
clusterId |
string Required field. ID of the cluster to list SPQR users in. The maximum string length in characters is 50. |
Query parameters
|
Field |
Description |
|
pageSize |
string (int64) The maximum number of results per page to return. If the number of available Acceptable values are 0 to 1000, inclusive. |
|
pageToken |
string Page token. To get the next page of results, set The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"users": [
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"databaseName": "string"
}
],
"settings": {
"connectionLimit": "string",
"connectionRetries": "string"
},
"grants": [
"string"
],
"deletionProtection": "boolean"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
users[] |
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 |
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[] |
Set of permissions granted to the user. |
|
settings |
SPQR Settings for this user |
|
grants[] |
string User grants The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
deletionProtection |
boolean Deletion Protection inhibits deletion of the user |
Permission
|
Field |
Description |
|
databaseName |
string Name of the database that the permission grants access to. |
UserSettings
|
Field |
Description |
|
connectionLimit |
string (int64) |
|
connectionRetries |
string (int64) |