Description
List all database accounts.
Request URL
Database API v1.0 GET /v1/users
Request Paramters
| Parameter | Value | Style | Type | Description |
|---|---|---|---|---|
| X-Auth-Token | - | header | string | User Token |
| service_id(Optional) | - | query | UUID | Service ID If unspecifyed, all databases associate to tenants will be returned. |
| 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) | user_name/hostname/status/create_date/memo | 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 |
|---|---|---|---|---|
| users | - | - | list | - |
| databases | - | plain | list | Authorized Databases |
| database_id | - | plain | UUID | Database ID |
| db_name | - | plain | string | Database Name |
| service_id | - | plain | UUID | Service ID |
| hostname | - | plain | string | Hostname |
| memo | - | plain | string | Memo |
| user_id | - | plain | UUID | User ID |
| user_name | - | plain | string | User Name |
| status | active/pending/creating/deleting/error | plain | string | Status |
| 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/users?service_id=9d6441f6-c5a0-4dcf-a1a9-1a4d724e51fd
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json
{
"users": [
{
"databases": [
{
"database_id": "148147ba-8999-4901-9cd6-634db82f80ea",
"db_name": "02p8y_db0001"
},
{
"database_id": "f2d55856-ee66-4efb-9663-a501f3f29edb",
"db_name": "02p8y_db0003"
}
],
"service_id": "9d6441f6-c5a0-4dcf-a1a9-1a4d724e51fd",
"hostname": "host01.example.jp",
"memo": "memo",
"user_id": "5f02c821-977f-4160-812d-397a5e3c7caa",
"user_name": "02p8y_dbuser001",
"status": "active"
},
{
"databases": [
{
"database_id": "148147ba-8999-4901-9cd6-634db82f80ea",
"db_name": "02p8y_db0001"
},
{
"database_id": "f2d55856-ee66-4efb-9663-a501f3f29edb",
"db_name": "02p8y_db0003"
}
],
"service_id": "9d6441f6-c5a0-4dcf-a1a9-1a4d724e51fd",
"hostname": "host02.example.jp",
"memo": "memo2",
"user_id": "c5f4ce2d-8b17-4387-a06c-9ea9c8d71406",
"user_name": "02p8y_dbuser002",
"status": "active"
}
],
"total_count":100,
"current_count":10
}