Jump to: navigation, search

Difference between revisions of "Trove/update-instance-name"

(Created page with "Description This blueprint will augment the existing API PUT/instances/{instanceId} call for renaming an instance name. Blueprint: Justification/Benefits Need to provide us...")
 
(Augment existing API call: Update Database Instance)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Description
+
== Description ==
  
This blueprint will augment the existing API PUT/instances/{instanceId} call for renaming an instance name.
+
This blueprint adds PATCH /instances/{instanceId} call for renaming an instance name/attaching or detaching a configuration to an instance.
 +
The long term plan is to deprecate the PUT /instances/{instanceId} call.
  
Blueprint:  
+
Blueprint: https://blueprints.launchpad.net/trove/+spec/update-instance-name
Justification/Benefits
 
Need to provide users capability to rename an instance name after creation.
 
  
Impacts
+
== Justification/Benefits ==
Configuration
+
Need to provide users ability to rename a database instance name post creation.
  
 +
== Impacts ==
 +
 +
=== Configuration ===
 
None
 
None
Database
+
=== Database ===
  
 
No impact
 
No impact
ReST API
+
=== ReST API ===
Augment existing API call: Update Database Instance
+
=== Augment existing API call: Update Database Instance ===
 +
The PATCH call does following functions:
 +
(1) updates configuration by doing the necessary checks (same as PUT call)
  
Request
+
(2) updates instance name if provided
  
PUT/instances/{instanceId}
+
'''Request'''
  
 +
PATCH {tenantId}/instances/{instanceId}
 +
<pre>
 
{
 
{
 
"instance": {
 
"instance": {
Line 27: Line 33:
 
}
 
}
 
}
 
}
 +
</pre>
 +
'''Response'''
  
Response
 
 
This call will not return a response body.
 
This call will not return a response body.
 +
 +
== Comments/Questions From Community ==

Latest revision as of 18:26, 11 September 2014

Description

This blueprint adds PATCH /instances/{instanceId} call for renaming an instance name/attaching or detaching a configuration to an instance. The long term plan is to deprecate the PUT /instances/{instanceId} call.

Blueprint: https://blueprints.launchpad.net/trove/+spec/update-instance-name

Justification/Benefits

Need to provide users ability to rename a database instance name post creation.

Impacts

Configuration

None

Database

No impact

ReST API

Augment existing API call: Update Database Instance

The PATCH call does following functions: (1) updates configuration by doing the necessary checks (same as PUT call)

(2) updates instance name if provided

Request

PATCH {tenantId}/instances/{instanceId}

{
"instance": {
"configuration" : "StagingConfig",
"name" : "Test_Instance"
}
}

Response

This call will not return a response body.

Comments/Questions From Community