Подключиться
Yandex Managed Service for MySQL

Method list

Статья создана

Retrieves a list of MySQL users in the specified 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 MySQL users in. To get the cluster ID, use 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 service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a 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

A MySQL user. For more information, see the documentation.
users[].
name		 string

Name of the MySQL user.
users[].
clusterId		 string

ID of the MySQL 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
  • ALL_PRIVILEGES: All privileges that can be made available to the user.
  • ALTER: Altering tables.
  • ALTER_ROUTINE: Altering stored routines (stored procedures and functions).
  • CREATE: Creating tables or indexes.
  • CREATE_ROUTINE: Creating stored routines.
  • CREATE_TEMPORARY_TABLES: Creating temporary tables.
  • CREATE_VIEW: Creating views.
  • DELETE: Deleting tables.
  • DROP: Removing tables or views.
  • EVENT: Creating, altering, dropping, or displaying events for the Event Scheduler.
  • EXECUTE: Executing stored routines.
  • INDEX: Creating and removing indexes.
  • INSERT: Inserting rows into the database.
  • LOCK_TABLES: Using LOCK TABLES statement for tables available with SELECT privilege.
  • SELECT: Selecting rows from tables.

Some SELECT statements can be allowed without the SELECT privilege. All statements that read column values require the SELECT privilege. See details in MySQL documentation.

  • SHOW_VIEW: Using the SHOW CREATE VIEW statement. Also needed for views used with EXPLAIN.
  • TRIGGER: Creating, removing, executing, or displaying triggers for a table.
  • UPDATE: Updating rows in the database.
  • REFERENCES: Creation of a foreign key constraint for the parent table.
users[].
globalPermissions[]		 string
  • REPLICATION_CLIENT: Enables use of the SHOW MASTER STATUS, SHOW SLAVE STATUS, and SHOW BINARY LOGS statements.
  • REPLICATION_SLAVE: Enables the account to request updates that have been made to databases on the master server, using the SHOW SLAVE HOSTS, SHOW RELAYLOG EVENTS, and SHOW BINLOG EVENTS statements.
  • PROCESS: Enables display of information about the threads executing within the server (that is, information about the statements being executed by sessions). The privilege enables use of SHOW PROCESSLIST or mysqladmin processlist to see threads belonging to other accounts; you can always see your own threads. The PROCESS privilege also enables use of SHOW ENGINE.
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

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.
В этой статье: