From 7d2e6b7cc9110934e105c9469cda6dd2da1b2812 Mon Sep 17 00:00:00 2001 From: Lingxian Kong Date: Sun, 13 Sep 2020 22:21:00 +1200 Subject: [PATCH] [Doc] Refine the root enable API description Change-Id: Id144c0c73b10550a8b8d636beece37578c0af124 --- .../source/samples/user-root-enable-request.json | 3 +++ api-ref/source/users.inc | 16 +++++++++++----- 2 files changed, 14 insertions(+), 5 deletions(-) create mode 100644 api-ref/source/samples/user-root-enable-request.json 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 0000000000..3c45b71675 --- /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 686a84fddd..f0548cc536 100644 --- a/api-ref/source/users.inc +++ b/api-ref/source/users.inc @@ -213,12 +213,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 @@ -230,7 +230,13 @@ Request - project_id: project_id - instanceId: instanceId + - password: root_password +Request Example +--------------- + +.. literalinclude:: samples/user-root-enable-request.json + :language: javascript Response Example ----------------