summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorLingxian Kong <anlin.kong@gmail.com>2019-12-14 21:25:06 +1300
committerLingxian Kong <anlin.kong@gmail.com>2019-12-18 22:13:46 +0000
commit75b9b686b1c4fa2be1be00ef390035da01e331eb (patch)
tree3bffe3ad078e4644f9f260e53594564c145d1297 /api-ref
parent5472d8a57c7c9e82cca122396fea75b8ef05a64a (diff)
downloadtrove-75b9b686b1c4fa2be1be00ef390035da01e331eb.tar.gz
Show service_status_updated in instance API
A new field named ``service_status_updated`` is added to the instance API response which e.g. could be used to validate if the instance 'HEALTHY' status is stale or not. Change-Id: Iabcfad81343a71304b843b3a7778486253220d20
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/database-instances.inc1
-rwxr-xr-xapi-ref/source/parameters.yaml7
-rw-r--r--api-ref/source/samples/db-instance-status-detail-response.json5
3 files changed, 11 insertions, 2 deletions
diff --git a/api-ref/source/database-instances.inc b/api-ref/source/database-instances.inc
index fa48ecb6..41c1e09f 100644
--- a/api-ref/source/database-instances.inc
+++ b/api-ref/source/database-instances.inc
@@ -179,6 +179,7 @@ Response Parameters
- ip: instance_ip_address
- created: created
- updated: updated
+ - service_status_updated: service_status_updated
- fault: instance_fault
- fault.message: instance_fault_message
- fault.created: instance_fault_created
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 293aa9a6..c0e4a852 100755
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -702,6 +702,13 @@ server_id:
in: body
required: false
type: string
+service_status_updated:
+ description: |
+ The date and time when the database service status was updated. This field
+ can be used to validate if the 'HEALTHY' status is stale or not.
+ in: body
+ required: true
+ type: string
shard_id:
description: |
The shard ID of an instance.
diff --git a/api-ref/source/samples/db-instance-status-detail-response.json b/api-ref/source/samples/db-instance-status-detail-response.json
index d69ed5df..64828e80 100644
--- a/api-ref/source/samples/db-instance-status-detail-response.json
+++ b/api-ref/source/samples/db-instance-status-detail-response.json
@@ -1,6 +1,6 @@
{
"instance": {
- "created": "2014-10-30T12:30:00",
+ "created": "2019-12-14T08:08:22",
"datastore": {
"type": "mysql",
"version": "5.5"
@@ -32,8 +32,9 @@
],
"name": "json_rack_instance",
"region": "RegionOne",
+ "service_status_updated": "2019-12-14T08:51:58",
"status": "HEALTHY",
- "updated": "2014-10-30T12:30:00",
+ "updated": "2019-12-14T08:08:30",
"volume": {
"size": 2,
"used": 0.16