Browse Source

Merge "[Doc] Refine the root enable API description"

Zuul 2 weeks ago
committed by Gerrit Code Review
2 changed files with 14 additions and 5 deletions
  1. +3
  2. +11

+ 3
- 0
api-ref/source/samples/user-root-enable-request.json View File

@@ -0,0 +1,3 @@
"password": "q5BXXMUMbc8XBf5kkVToKZW4Kx3Egv5VjY0P"

+ 11
- 5
api-ref/source/ View File

@@ -217,12 +217,12 @@ Enable root user

Enables the root user for a database instance and returns the root password.

This operation generates a root password for the root user and
enables the root user to log in from any host.
This operation generates password for the root user if not provided and
enables the root user to log in from any host. If provided, the user should
guarantee the password complexity and change regularly.

Enabling root user should only be restricted to admin user, as with root user,
the cloud user can change the database settings, e.g. remove users which
bypassing the Trove API.
Other than managing databases and users, root user can change database settings
without touching Trove API which is not recommended.

Normal response codes: 200

@@ -234,7 +234,13 @@ Request

- project_id: project_id
- instanceId: instanceId
- password: root_password

Request Example

.. literalinclude:: samples/user-root-enable-request.json
:language: javascript

Response Example