Description
List database services.
Request URL
Database API v1.0 GET /v1/services
Request Paramters
| Parameter | Value | Style | Type | Description |
|---|---|---|---|---|
| X-Auth-Token | - | header | string | User Token |
| offset(Optional) | - | query | int | Index Number to Start a Proceeding Default:0 |
| limit(Optional) | - | query | int | Maximum Number of Results Default:1000 |
| sort_key(Optional) | service_name/status/create_date | query | string | Sort Key Default:create_date |
| sort_type(Optional) | asc/desc | query | string | Sort Type Default:asc |
Response Paramters
| Parameter | Value | Style | Type | Description |
|---|---|---|---|---|
| services | - | - | list | - |
| service_id | - | plain | UUID | Service ID |
| service_name | - | plain | string | Service Name |
| create_date | - | plain | string | Date and Hour of Creation |
| quota | - | plain | int | Quota for Use(Unit:GB) |
| total_usage | - | plain | float | Total Usage(Unit:GB)It displays the number with two decimal point. |
| status | active/suspended/pending/creating/deleting/error | plain | string | Status |
| backup | enable/disable | plain | string | Flag to Enable Backup |
| prefix | - | plain | string | Prefix |
| total_count | - | plain | int | Total Count |
| current_count | - | plain | int | Current Count |
Request Json
This operation does not accept a request body.
Normal response codes
200 - Success
Error response codes
400 - Bad Request
401 - Access Denied
Repeatable
Yes
Example
curl -i -X GET \ -H "Accept: application/json" \ -H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \ https://database-hosting.tyo1.cloud.z.com/v1/services
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json
{
"services" : [
{
"service_id": "9d6441f6-c5a0-4dcf-a1a9-1a4d724e51fd",
"service_name": "dbservice01",
"create_date": "2012-11-02T19:56:26Z",
"quota": 10,
"total_usage": 2.25,
"status": "active",
"backup": "disable",
"prefix" : "02p8y"
},
{
"service_id": "ff164ba8-42d1-49d3-a597-a98503f6fd45",
"service_name": "dbservice02",
"create_date": "2012-11-02T19:56:26Z",
"quota": 30,
"total_usage": 14,
"status": "active",
"backup": "enable",
"prefix" : "8ypg0"
}
],
"total_count":100,
"current_count":10
}