diff options
| author | Zuul <zuul@review.opendev.org> | 2020-09-13 12:36:57 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2020-09-13 12:36:57 +0000 |
| commit | e6feda698f64f894c8b63b6e93a106514fbeaebb (patch) | |
| tree | cb7a3419eed34dc376014a6775e9fc5d37878d5f /api-ref | |
| parent | 72e20e4e97c54d59e6330180b65635928c9b274e (diff) | |
| parent | 7d2e6b7cc9110934e105c9469cda6dd2da1b2812 (diff) | |
| download | trove-e6feda698f64f894c8b63b6e93a106514fbeaebb.tar.gz | |
Merge "[Doc] Refine the root enable API description"
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/samples/user-root-enable-request.json | 3 | ||||
| -rw-r--r-- | api-ref/source/users.inc | 16 |
2 files changed, 14 insertions, 5 deletions
diff --git a/api-ref/source/samples/user-root-enable-request.json b/api-ref/source/samples/user-root-enable-request.json new file mode 100644 index 00000000..3c45b716 --- /dev/null +++ b/api-ref/source/samples/user-root-enable-request.json @@ -0,0 +1,3 @@ +{ + "password": "q5BXXMUMbc8XBf5kkVToKZW4Kx3Egv5VjY0P" +}
\ No newline at end of file diff --git a/api-ref/source/users.inc b/api-ref/source/users.inc index 91be9969..64662002 100644 --- a/api-ref/source/users.inc +++ b/api-ref/source/users.inc @@ -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 ---------------- |