summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--api-ref/source/backups.inc22
-rw-r--r--api-ref/source/configurations.inc28
-rw-r--r--api-ref/source/database-instance-actions.inc20
-rw-r--r--api-ref/source/database-instance-logs.inc24
-rw-r--r--api-ref/source/database-instances.inc120
-rw-r--r--api-ref/source/databases.inc12
-rw-r--r--api-ref/source/datastores.inc12
-rwxr-xr-xapi-ref/source/parameters.yaml34
-rw-r--r--api-ref/source/samples/db-create-instance-request.json57
-rw-r--r--api-ref/source/user-management.inc24
10 files changed, 187 insertions, 166 deletions
diff --git a/api-ref/source/backups.inc b/api-ref/source/backups.inc
index 4b35ea05..d842619a 100644
--- a/api-ref/source/backups.inc
+++ b/api-ref/source/backups.inc
@@ -10,7 +10,7 @@ List, show details, create and delete backups.
List database backups
~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/backups
+.. rest_method:: GET /v1.0/{project_id}/backups
List all database backups information for a project. You can filter results by
using query string parameters. The following filters are supported:
@@ -32,7 +32,7 @@ Request
.. rest_parameters:: parameters.yaml
- - accountId: accountId
+ - project_id: project_id
Response Parameters
@@ -69,10 +69,10 @@ Response Example
List database backups for an instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/backups
+.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/backups
List all database backups for the specified instance. This is equivalent to
-``GET /v1.0/{accountId}/backups?instance_id={instanceId}``.
+``GET /v1.0/{project_id}/backups?instance_id={instanceId}``.
Normal response codes: 200
@@ -87,7 +87,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Response Parameters
@@ -124,7 +124,7 @@ Response Example
Show database backup details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/backups/{backupId}
+.. rest_method:: GET /v1.0/{project_id}/backups/{backupId}
Show detailes of a backup.
@@ -140,7 +140,7 @@ Request
.. rest_parameters:: parameters.yaml
- - accountId: accountId
+ - project_id: project_id
- backupId: backup_id
@@ -177,7 +177,7 @@ Response Example
Create database backup
~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/backups
+.. rest_method:: POST /v1.0/{project_id}/backups
Creates a database backup for instance.
@@ -198,7 +198,7 @@ Request
- parent_id: backup_parentId
- incremental: backup_incremental
- description: backup_description
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -241,7 +241,7 @@ Response Example
Delete database backup
~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: DELETE /v1.0/{accountId}/backups/{backupId}
+.. rest_method:: DELETE /v1.0/{project_id}/backups/{backupId}
Deletes a database backup.
@@ -258,4 +258,4 @@ Request
.. rest_parameters:: parameters.yaml
- backupId: backup_id
- - accountId: accountId
+ - project_id: project_id
diff --git a/api-ref/source/configurations.inc b/api-ref/source/configurations.inc
index c0a3c79b..188d9733 100644
--- a/api-ref/source/configurations.inc
+++ b/api-ref/source/configurations.inc
@@ -10,7 +10,7 @@ Creates and lists all configuration groups.
Create configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/configurations
+.. rest_method:: POST /v1.0/{project_id}/configurations
Creates a configuration group.
@@ -29,7 +29,7 @@ Request
- datastore: datastore
- values: values
- name: name
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -51,7 +51,7 @@ Response Example
List configuration groups
~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/configurations
+.. rest_method:: GET /v1.0/{project_id}/configurations
Lists all configuration groups.
@@ -70,7 +70,7 @@ Request
.. rest_parameters:: parameters.yaml
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -85,7 +85,7 @@ Response Example
List configuration group instances
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/configurations/{configId}/instances
+.. rest_method:: GET /v1.0/{project_id}/configurations/{configId}/instances
Lists the instances associated with the specified configuration group.
@@ -102,7 +102,7 @@ Request
.. rest_parameters:: parameters.yaml
- configId: configId
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -117,7 +117,7 @@ Response Example
Delete configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: DELETE /v1.0/{accountId}/configurations/{configId}
+.. rest_method:: DELETE /v1.0/{project_id}/configurations/{configId}
Deletes a configuration group.
@@ -134,7 +134,7 @@ Request
.. rest_parameters:: parameters.yaml
- configId: configId
- - accountId: accountId
+ - project_id: project_id
@@ -142,7 +142,7 @@ Request
Patch configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: PATCH /v1.0/{accountId}/configurations/{configId}
+.. rest_method:: PATCH /v1.0/{project_id}/configurations/{configId}
Sets new values for a configuration group.
@@ -160,7 +160,7 @@ Request
- values: values
- configId: configId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -182,7 +182,7 @@ Response Example
Show configuration group details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/configurations/{configId}
+.. rest_method:: GET /v1.0/{project_id}/configurations/{configId}
Lists details about a configuration group, including its values.
@@ -199,7 +199,7 @@ Request
.. rest_parameters:: parameters.yaml
- configId: configId
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -214,7 +214,7 @@ Response Example
Update configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: PUT /v1.0/{accountId}/configurations/{configId}
+.. rest_method:: PUT /v1.0/{project_id}/configurations/{configId}
Sets new values for a configuration group. Also lets you change the name and
description of the configuration group.
@@ -234,7 +234,7 @@ Request
- description: description
- name: name
- configId: configId
- - accountId: accountId
+ - project_id: project_id
Request Example
diff --git a/api-ref/source/database-instance-actions.inc b/api-ref/source/database-instance-actions.inc
index f8d05a05..7d43ea4a 100644
--- a/api-ref/source/database-instance-actions.inc
+++ b/api-ref/source/database-instance-actions.inc
@@ -10,7 +10,7 @@ Resizes instances and volumes and restarts instances.
Restart instance
~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
Restarts the database service for an instance.
@@ -34,7 +34,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -49,7 +49,7 @@ Request Example
Resize instance
~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
Resizes the memory for an instance.
@@ -70,7 +70,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -85,7 +85,7 @@ Request Example
Resize instance volume
~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
Resizes the volume that is attached to an instance.
@@ -109,7 +109,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -124,7 +124,7 @@ Request Example
Promote instance to replica source
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
Promotes a replica.
@@ -158,7 +158,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -173,7 +173,7 @@ Request Example
Delete replication base instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
Deletes the base instance in a replication set.
@@ -211,7 +211,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
diff --git a/api-ref/source/database-instance-logs.inc b/api-ref/source/database-instance-logs.inc
index c40d92ba..64de9eab 100644
--- a/api-ref/source/database-instance-logs.inc
+++ b/api-ref/source/database-instance-logs.inc
@@ -10,7 +10,7 @@ List, show details, enable, disable, publish, and discard logs for instances.
List instance logs
~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/log
+.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/log
Listing all logs for an instance.
@@ -32,7 +32,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Response Parameters
@@ -63,7 +63,7 @@ Response Example
Show instance log details
~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
Show details for a instance log.
@@ -81,7 +81,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
- name: log_name
@@ -120,7 +120,7 @@ Response Example
Enable instance log
~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
Enable a log type for a instance.
@@ -138,7 +138,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
- name: log_name
- enable: log_enable_action
@@ -178,7 +178,7 @@ Response Example
Disable instance log
~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
Disable a log type for a instance.
@@ -196,7 +196,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
- name: log_name
- disable: log_disable_action
@@ -236,7 +236,7 @@ Response Example
Publish instance log
~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
Publish a log type for a instance.
@@ -256,7 +256,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
- name: log_name
- publish: log_publish_action
@@ -296,7 +296,7 @@ Response Example
Discard instance log
~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
Discard all previously published logs for a instance.
@@ -314,7 +314,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
- name: log_name
- discard: log_discard_action
diff --git a/api-ref/source/database-instances.inc b/api-ref/source/database-instances.inc
index 904f83a8..58a40088 100644
--- a/api-ref/source/database-instances.inc
+++ b/api-ref/source/database-instances.inc
@@ -13,7 +13,7 @@ root is enabled, for instances.
List database instances
~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/instances
+.. rest_method:: GET /v1.0/{project_id}/instances
Lists information, including status, for all database instances.
@@ -31,7 +31,7 @@ Request
.. rest_parameters:: parameters.yaml
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -46,7 +46,7 @@ Response Example
Show database instance details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}
+.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}
Shows database instance details.
@@ -82,7 +82,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -97,24 +97,15 @@ Response Example
Create database instance
~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances
+.. rest_method:: POST /v1.0/{project_id}/instances
Creates a database instance.
-Asynchronously provisions a database instance. You must specify a
-flavor and a volume size. The service provisions the instance with
-a volume of the requested size, which serves as storage for the
-database instance.
-
- **Notes**
-
-- You can create only one database instance per POST request.
-
-- You can create a database instance with one or more databases. You
- can also associate users with each database.
-
-- The port on which the database instance is listening is database
- specific.
+Asynchronously provisions a database instance. You must specify a flavor ID, a
+volume size and the tenant network ID. The service provisions the instance with
+a volume of the requested size, which serves as storage for the database
+instance. The database service can only be access within the tenant network,
+unless the ``access`` parameter is defined.
Normal response codes: 200
@@ -128,36 +119,39 @@ Request
.. rest_parameters:: parameters.yaml
- - users: users
- - users.name: user_name1
- - users.password: user_password
- - users.host: user_host
- - users.databases: user_databases
- - users.databases.name: user_database_name
- - datastore: datastore1
- - datastore.type: datastore_type
- - datastore.version: datastore_version
- - name: instanceName1
- - flavorRef: flavorRef
- - volume: volume
- - volume.size: volume_size
- - volume.type: volume_type
- - modules: modules
- - modules.id: module_id
- - restorePoint: restore_point
- - restorePoint.backupRef: restore_point_backupref
- - availability_zone: availability_zone
- - nics: nics
- - replica_of: replica_of
- - replica_count: replica_count
- - locality: locality
- - region_name: region_name
- - databases: databases
- - databases.characterSet: characterSet
- - databases.collate: collate
- - instance: instance
- - configuration: configuration
- - accountId: accountId
+ - project_id: project_id
+ - users: users
+ - users.name: user_name1
+ - users.password: user_password
+ - users.host: user_host
+ - users.databases: user_databases
+ - users.databases.name: user_database_name
+ - datastore: datastore1
+ - datastore.type: datastore_type
+ - datastore.version: datastore_version
+ - name: instanceName1
+ - flavorRef: flavorRef
+ - volume: volume
+ - volume.size: volume_size
+ - volume.type: volume_type
+ - modules: modules
+ - modules.id: module_id
+ - restorePoint: restore_point
+ - restorePoint.backupRef: restore_point_backupref
+ - availability_zone: availability_zone
+ - nics: nics
+ - replica_of: replica_of
+ - replica_count: replica_count
+ - locality: locality
+ - region_name: region_name
+ - databases: databases
+ - databases.characterSet: characterSet
+ - databases.collate: collate
+ - instance: instance
+ - configuration: configuration
+ - access: access
+ - access.is_public: access_is_public
+ - access.allowed_cidrs: access_allowed_cidrs
Request Example
@@ -233,7 +227,7 @@ Response Example
Attach configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: PUT /v1.0/{accountId}/instances/{instanceId}
+.. rest_method:: PUT /v1.0/{project_id}/instances/{instanceId}
Attaches a configuration group to an instance.
@@ -252,7 +246,7 @@ Request
- configuration: configuration
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -267,7 +261,7 @@ Request Example
Detach configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: PUT /v1.0/{accountId}/instances/{instanceId}
+.. rest_method:: PUT /v1.0/{project_id}/instances/{instanceId}
Detaches a configuration group from an instance.
@@ -290,7 +284,7 @@ Request
- configuration: configuration
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
---------------
@@ -304,7 +298,7 @@ Request Example
Detach replica
~~~~~~~~~~~~~~
-.. rest_method:: PATCH /v1.0/{accountId}/instances/{instanceId}
+.. rest_method:: PATCH /v1.0/{project_id}/instances/{instanceId}
Detaches a replica from its replication source.
@@ -331,7 +325,7 @@ Request
- replica_of: replica_of
- slave_of: slave_of
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -346,7 +340,7 @@ Request Example
Update instance name
~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: PATCH /v1.0/{accountId}/instances/{instanceId}
+.. rest_method:: PATCH /v1.0/{project_id}/instances/{instanceId}
Update the instance name.
@@ -366,7 +360,7 @@ Request
- instance: instance
- name: instanceName
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -381,7 +375,7 @@ Request Example
Upgrade datastore version
~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: PATCH /v1.0/{accountId}/instances/{instanceId}
+.. rest_method:: PATCH /v1.0/{project_id}/instances/{instanceId}
Upgrade datastore version.
@@ -405,7 +399,7 @@ Request
- instance: instance
- datastore_version: datastore_version
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -420,7 +414,7 @@ Request Example
Delete database instance
~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}
+.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}
Deletes a database instance, including any associated data.
@@ -442,7 +436,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
@@ -450,7 +444,7 @@ Request
List configuration defaults
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/configuration
+.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/configuration
Lists the configuration defaults for an instance.
@@ -467,7 +461,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Response Example
diff --git a/api-ref/source/databases.inc b/api-ref/source/databases.inc
index 2edb1bf0..aaf60a1c 100644
--- a/api-ref/source/databases.inc
+++ b/api-ref/source/databases.inc
@@ -10,7 +10,7 @@ Creates, lists all, and deletes databases.
Delete database
~~~~~~~~~~~~~~~
-.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}/databases/{databaseName}
+.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}/databases/{databaseName}
Deletes a database.
@@ -31,7 +31,7 @@ Request
- instanceId: instanceId
- databaseName: databaseName
- - accountId: accountId
+ - project_id: project_id
@@ -39,7 +39,7 @@ Request
Create database
~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/databases
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/databases
Creates a database within an instance.
@@ -59,7 +59,7 @@ Request
- collate: collate
- name: name
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
@@ -74,7 +74,7 @@ Request Example
List instance databases
~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/databases
+.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/databases
Lists databases for an instance.
@@ -96,7 +96,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Response Example
diff --git a/api-ref/source/datastores.inc b/api-ref/source/datastores.inc
index 36d43349..db77a964 100644
--- a/api-ref/source/datastores.inc
+++ b/api-ref/source/datastores.inc
@@ -11,7 +11,7 @@ shows parameter details for a data store version.
Show configuration parameter details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}
+.. rest_method:: GET /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}
Displays details for a configuration parameter associated with a data store
version.
@@ -33,7 +33,7 @@ Request
- parameter_name: parameter_name
- datastore_version_id: datastore_version_id
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -48,7 +48,7 @@ Response Example
List datastore versions
~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/datastores/{datastore_name}/versions
+.. rest_method:: GET /v1.0/{project_id}/datastores/{datastore_name}/versions
Lists the available versions of a data store.
@@ -65,7 +65,7 @@ Request
.. rest_parameters:: parameters.yaml
- datastore_name: datastore_name
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -80,7 +80,7 @@ Response Example
List configuration parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters
+.. rest_method:: GET /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters
Lists the available configuration parameters for a data store version.
@@ -101,7 +101,7 @@ Request
.. rest_parameters:: parameters.yaml
- datastore_version_id: datastore_version_id
- - accountId: accountId
+ - project_id: project_id
Response Example
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 7dfa51b1..a92901fe 100755
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -1,10 +1,4 @@
# variables in path
-accountId:
- description: |
- The account ID of the owner of the instance.
- in: path
- required: false
- type: string
backup_id:
description: |
The ID of the backup.
@@ -54,6 +48,12 @@ parameter_name:
in: path
required: false
type: string
+project_id:
+ description: |
+ The project ID of the instance owner.
+ in: path
+ required: true
+ type: string
user_name:
description: |
The name of the user.
@@ -61,6 +61,26 @@ user_name:
required: false
type: string
# variables in body
+access:
+ description: |
+ A ``access`` object defines how the database service is exposed.
+ in: body
+ required: false
+ type: object
+access_allowed_cidrs:
+ description: |
+ A list of IPv4, IPv6 or mix of both CIDRs that restrict access to the
+ database service. ``0.0.0.0/0`` is used by default if this parameter is not
+ provided.
+ in: body
+ required: false
+ type: array
+access_is_public:
+ description: |
+ Whether the database service is exposed to the public.
+ in: body
+ required: false
+ type: boolean
availability_zone:
description: |
The availability zone of the instance.
@@ -582,7 +602,7 @@ nics:
description: |
Network interfaces for database service inside Nova instances.
``NOTE:`` For backward compatibility, this parameter uses the same schema
- as novaclient creating servers, but only ``net-id`` is supported ans can
+ as novaclient creating servers, but only ``net-id`` is supported and can
only be specified once. This parameter is required in service tenant
deployment model.
in: body
diff --git a/api-ref/source/samples/db-create-instance-request.json b/api-ref/source/samples/db-create-instance-request.json
index e22b97c5..7e4b3e85 100644
--- a/api-ref/source/samples/db-create-instance-request.json
+++ b/api-ref/source/samples/db-create-instance-request.json
@@ -1,30 +1,37 @@
{
- "instance": {
+ "instance": {
+ "name": "test",
+ "flavorRef": 1,
+ "volume": {"size": 2},
+ "nics": [{"net-id": "a5330d7d-0e8c-48b4-9f6c-0f2c4ab1b854"}],
+ "datastore": {
+ "type": "mysql",
+ "version": "5.7"
+ },
+ "databases": [
+ {
+ "character_set": "utf8",
+ "collate": "utf8_general_ci",
+ "name": "sampledb"
+ },
+ {
+ "name": "nextround"
+ }
+ ],
+ "users": [
+ {
"databases": [
- {
- "character_set": "utf8",
- "collate": "utf8_general_ci",
- "name": "sampledb"
- },
- {
- "name": "nextround"
- }
+ {
+ "name": "sampledb"
+ }
],
- "flavorRef": 1,
- "name": "json_rack_instance",
- "users": [
- {
- "databases": [
- {
- "name": "sampledb"
- }
- ],
- "name": "demouser",
- "password": "demopassword"
- }
- ],
- "volume": {
- "size": 2
- }
+ "name": "demouser",
+ "password": "demopassword"
+ }
+ ],
+ "access": {
+ "is_public": true,
+ "allowed_cidrs": ["202.78.240.0/24"]
}
+ }
}
diff --git a/api-ref/source/user-management.inc b/api-ref/source/user-management.inc
index d17be907..44579878 100644
--- a/api-ref/source/user-management.inc
+++ b/api-ref/source/user-management.inc
@@ -10,7 +10,7 @@ Creates, lists all, and deletes users.
Enable root user
~~~~~~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/root
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/root
Enables the root user for a database instance and returns the root password.
@@ -38,7 +38,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -53,7 +53,7 @@ Response Example
Show root-enabled status for database instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/root
+.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/root
Shows root-enabled status for a database instance.
@@ -73,7 +73,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Response Example
@@ -88,7 +88,7 @@ Response Example
Disable root user
~~~~~~~~~~~~~~~~~
-.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}/root
+.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}/root
Disables the root user.
@@ -105,7 +105,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
@@ -113,7 +113,7 @@ Request
Delete user
~~~~~~~~~~~
-.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}/users/{name}
+.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}/users/{name}
Deletes a user for a database instance.
@@ -130,7 +130,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
- name: user_name
@@ -139,7 +139,7 @@ Request
Create user
~~~~~~~~~~~
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/users
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/users
Creates a user for a database instance.
@@ -244,7 +244,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Request Example
---------------
@@ -258,7 +258,7 @@ Request Example
List database instance users
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/users
+.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/users
Lists the users in a database instance and the associated databases for that
user.
@@ -293,7 +293,7 @@ Request
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- - accountId: accountId
+ - project_id: project_id
Response Example