summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorshangxiaobj <shangxiaobj@inspur.com>2018-01-22 18:47:02 -0800
committerShangXiao <shangxiaobj@inspur.com>2018-01-25 00:25:55 +0000
commite54c46e312adac96b4830fd4eb1e1817a9bd767f (patch)
treec685f32c9f67e5359ee8e4cdc26c4bb264f5ffaf /api-ref
parent980577ee5b7e97811b4c49ddeecef971fea3e993 (diff)
downloadtrove-e54c46e312adac96b4830fd4eb1e1817a9bd767f.tar.gz
[api-ref] Add fault names for the error response codes
Error response codes with fault names will be easier for understanding. Change-Id: I5970cb6d40cf5793f024fd5d46b0da8f24bee0d6
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/api-versions.inc8
-rw-r--r--api-ref/source/configurations.inc30
-rw-r--r--api-ref/source/database-instance-actions.inc30
-rw-r--r--api-ref/source/database-instances.inc36
-rw-r--r--api-ref/source/databases.inc14
-rw-r--r--api-ref/source/datastores.inc12
-rw-r--r--api-ref/source/flavors.inc8
-rw-r--r--api-ref/source/user-management.inc27
8 files changed, 124 insertions, 41 deletions
diff --git a/api-ref/source/api-versions.inc b/api-ref/source/api-versions.inc
index 6af3ea03..cf9f371f 100644
--- a/api-ref/source/api-versions.inc
+++ b/api-ref/source/api-versions.inc
@@ -17,7 +17,9 @@ Lists information about all Database Service API versions.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
@@ -49,7 +51,9 @@ Shows details for the Database Service API v1.0.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
diff --git a/api-ref/source/configurations.inc b/api-ref/source/configurations.inc
index 734f2fd0..b8b72168 100644
--- a/api-ref/source/configurations.inc
+++ b/api-ref/source/configurations.inc
@@ -16,7 +16,9 @@ Creates a configuration group.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -70,7 +72,9 @@ for each configuration group.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -111,7 +115,9 @@ Lists the instances associated with the specified configuration group.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -151,7 +157,10 @@ Delete configuration group
Deletes a configuration group.
-Error response codes:202,413,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -186,7 +195,9 @@ Sets new values for a configuration group.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -236,7 +247,9 @@ Lists details about a configuration group, including its values.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -276,7 +289,10 @@ Update configuration group
Sets new values for a configuration group. Also lets you change the name and description of the configuration group.
-Error response codes:202,413,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
diff --git a/api-ref/source/database-instance-actions.inc b/api-ref/source/database-instance-actions.inc
index 35426339..ade4d32b 100644
--- a/api-ref/source/database-instance-actions.inc
+++ b/api-ref/source/database-instance-actions.inc
@@ -20,10 +20,10 @@ in the database instance.
The database instance is unavailable until the instance restarts.
-If the operation succeeds, it returns the ``Accepted (202)``
-response code.
-
-Error response codes:202,413,415,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),badMediaType(415),unprocessableEntity(422),instanceFault(500),
+notImplemented(501),serviceUnavailable(503)
Request
@@ -67,7 +67,10 @@ Resizes the memory for an instance.
If you provide a valid ``flavorRef``, this operation changes the
memory size of the instance, and restarts the database.
-Error response codes:202,413,415,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),badMediaType(415),unprocessableEntity(422),instanceFault(500),
+notImplemented(501),serviceUnavailable(503)
Request
@@ -114,9 +117,10 @@ size. A valid volume size is an integer value in gigabytes (GB).
You cannot increase the volume to a size that is larger than the
API volume size limit.
-If this operation succeeds, it returns a 202 Accepted response.
-
-Error response codes:202,413,415,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),badMediaType(415),unprocessableEntity(422),instanceFault(500),
+notImplemented(501),serviceUnavailable(503)
Request
@@ -173,7 +177,10 @@ instance.
For ``instanceId``, pass in the instance ID of the replica you want
to promote.
-Error response codes:202,413,415,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),badMediaType(415),unprocessableEntity(422),instanceFault(500),
+notImplemented(501),serviceUnavailable(503)
Request
@@ -234,7 +241,10 @@ This operation:
For ``instanceId``, pass in the instance ID of the unreachable base
instance.
-Error response codes:202,413,415,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),badMediaType(415),unprocessableEntity(422),instanceFault(500),
+notImplemented(501),serviceUnavailable(503)
Request
diff --git a/api-ref/source/database-instances.inc b/api-ref/source/database-instances.inc
index 46364830..fe65b939 100644
--- a/api-ref/source/database-instances.inc
+++ b/api-ref/source/database-instances.inc
@@ -22,7 +22,10 @@ This operation does not delete any read slaves.
You cannot complete this operation when the instance state is
either ``REBUILDING`` or ``BUILDING``.
-Error response codes:202,413,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405), overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -76,7 +79,9 @@ instance.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -116,7 +121,10 @@ Attach configuration group
Attaches a configuration group to an instance.
-Error response codes:202,413,415,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),badMediaType(415),unprocessableEntity(422),instanceFault(500),
+notImplemented(501),serviceUnavailable(503)
Request
@@ -162,7 +170,10 @@ When you pass in only an instance ID and omit the configuration ID,
this operation detaches any configuration group that was attached
to the instance.
-Error response codes:202,413,415,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),badMediaType(415),unprocessableEntity(422),instanceFault(500),
+notImplemented(501),serviceUnavailable(503)
Request
@@ -211,7 +222,10 @@ replica from the source, making the replica a standalone database
instance. You can then take the new standalone instance and create
a new replica of that instance.
-Error response codes:202,413,415,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),badMediaType(415),unprocessableEntity(422),instanceFault(500),
+notImplemented(501),serviceUnavailable(503)
Request
@@ -271,7 +285,9 @@ database instance.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -351,7 +367,9 @@ Lists status and information for all database instances.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -392,7 +410,9 @@ Lists the configuration defaults for an instance.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
diff --git a/api-ref/source/databases.inc b/api-ref/source/databases.inc
index 465a755d..e270d390 100644
--- a/api-ref/source/databases.inc
+++ b/api-ref/source/databases.inc
@@ -17,7 +17,10 @@ Deletes a database.
This operation also deletes all data that is associated with the
database.
-Error response codes:202,413,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405), overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -51,7 +54,10 @@ Create database
Creates a database within an instance.
-Error response codes:202,413,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -101,7 +107,9 @@ databases.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
diff --git a/api-ref/source/datastores.inc b/api-ref/source/datastores.inc
index e5562959..ef33deaa 100644
--- a/api-ref/source/datastores.inc
+++ b/api-ref/source/datastores.inc
@@ -20,7 +20,9 @@ you must restart the instance after you change the parameter value.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -63,7 +65,9 @@ Lists the available versions of a data store.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -109,7 +113,9 @@ a parameter value.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
diff --git a/api-ref/source/flavors.inc b/api-ref/source/flavors.inc
index 0af0a99b..6d9fdabf 100644
--- a/api-ref/source/flavors.inc
+++ b/api-ref/source/flavors.inc
@@ -24,7 +24,9 @@ value.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -71,7 +73,9 @@ Nova API.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
diff --git a/api-ref/source/user-management.inc b/api-ref/source/user-management.inc
index 612464b4..79f265a0 100644
--- a/api-ref/source/user-management.inc
+++ b/api-ref/source/user-management.inc
@@ -27,7 +27,9 @@ your instance, and so on.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -72,7 +74,9 @@ Otherwise, returns ``false``.
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -112,7 +116,10 @@ Disable root user
Disables the root user.
-Error response codes:202,413,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -145,7 +152,10 @@ Delete user
Deletes a user for a database instance.
-Error response codes:202,413,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -266,7 +276,10 @@ names, and passwords.
| Password maximum length | unlimited (no restrictions) |
+------------------------------+-----------------------------+
-Error response codes:202,413,405,404,403,401,400,422,503,500,501,
+Normal response codes: 202
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request
@@ -325,7 +338,9 @@ The following notes apply to MySQL users:
Normal response codes: 200
-Error response codes:413,405,404,403,401,400,422,503,500,501,
+Error response codes: badRequest(400),unauthorized(401),forbidden(403),itemNotFound(404),
+badMethod(405),overLimit(413),unprocessableEntity(422),instanceFault(500),notImplemented(501),
+serviceUnavailable(503)
Request