Managed Service for MySQL API, REST: User.list
Retrieves the list of users in a cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/{clusterId}/users
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the cluster to list the users in. To get this ID, make a list request. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the API returns a nextPageToken that can be used to get the next page of results in the subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token that can be used to iterate through multiple pages of results. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"users": [
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"databaseName": "string",
"roles": [
"string"
]
}
],
"globalPermissions": [
"string"
],
"connectionLimits": {
"maxQuestionsPerHour": "integer",
"maxUpdatesPerHour": "integer",
"maxConnectionsPerHour": "integer",
"maxUserConnections": "integer"
},
"authenticationPlugin": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
users[] | object List of users. |
users[]. name |
string Name of the user. |
users[]. clusterId |
string ID of the cluster the user belongs to. |
users[]. permissions[] |
object Set of permissions granted to the user. |
users[]. permissions[]. databaseName |
string Name of the database that the permission grants access to. |
users[]. permissions[]. roles[] |
string Required. Roles granted to the user within the database. See the documentation for details. The minimum number of elements is 1.
|
users[]. globalPermissions[] |
string Set of global permissions to grant to the user.
|
users[]. connectionLimits |
object Set of user connection limits. |
users[]. connectionLimits. maxQuestionsPerHour |
integer (int64) The maximum permitted number of user questions per hour. The minimum value is 0. |
users[]. connectionLimits. maxUpdatesPerHour |
integer (int64) The maximum permitted number of user updates per hour. The minimum value is 0. |
users[]. connectionLimits. maxConnectionsPerHour |
integer (int64) The maximum permitted number of simultaneous client connections per hour. The minimum value is 0. |
users[]. connectionLimits. maxUserConnections |
integer (int64) The maximum number of simultaneous connections permitted to any given MySQL user account. The minimum value is 0. |
users[]. authenticationPlugin |
string User authentication plugin.
|
nextPageToken | string The token that can be used to get the next page of results. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken in the subsequent list request to iterate through multiple pages of results. Each of the subsequent list requests should use the nextPageToken value returned by the previous request to continue paging through the results. |