Get current tenant database configuration

This GET operation retrieves a list of the current tenant database configuration which includes the database username, password, and url.

GET /pcc/spcm/oam/tenants

HEADER INFO

authorisation: HTTP Basic Auth

accept: application/json

permissions: SPCM_OAM_READ_PERMISSION

JSON response

Sharded environment

When you run this API operation, you receive a JSON response including an array of tenants which includes the name and the configuration.

The configuration includes the username, password, and url of the tenant database.

{
   "tenants":[
      {
         "tenant":"A",
         "slice":"0",
         "shard":"0",
         "routingKey":"A.0.0",
         "state":"added",
         "scheduler":{
            "state":"running"
         },
         "config":{
            "jdbc.password":"password",
            "jdbc.url":"jdbc:mysql://db1/pmsdb",
            "jdbc.username":"userName"
         }
      },
      {
         "tenant":"A",
         "slice":"1",
         "shard":"0",
         "routingKey":"A.1.0",
         "state":"ignored",
         "config":{
            "jdbc.password":"password",
            "jdbc.url":"jdbc:mysql://db2/pmsdb",
            "jdbc.username":"userName"
         }
      }
   ],
   "filters":[
      "A.0"
   ]
}

Standard environment

{
   "tenants":[
      {
         "tenant":"A",
         "routingKey":"A",
         "state":"added",
         "scheduler":{
            "state":"running"
         },
         "config":{
            "jdbc.password":"password",
            "jdbc.url":"jdbc:mysql://db1/pmsdb",
            "jdbc.username":"userName",
         }
      },
      {
         "tenant":"B",
         "routingKey":"B",
         "state":"ignored"
         "config":{
            "jdbc.password":"password",
            "jdbc.url":"jdbc:mysql://db2/pmsdb",
            "jdbc.username":"userName"
         }
      }
   ],
   "filters":[
      "A"
   ]
}

OAM tenant configuration descriptions

These are the JSON key-value pair descriptions for the SPCM OM API tenant configuration operations.

Field Type Description

name

string

The name of the tenant, slice, and shard.

The format is <tenant>.<slice>.<shard> For example: theTenant.1.0.

config

list

An object list containing the following:

jdbc.username = the tenant database username
jdbc.password = the tenant database password
jdbc.url = the url for the tenant database

HTTP response codes

Code Description

200

success!

207

Multistatus response

Check out HTTP statuses for more details.

This is not applicable to all operations.

400

malformed request

401

unauthorised; bad username or password

403

forbidden; user does not have appropriate privileges

404

tenant not found

409

conflict with target resource

This often occurs if the item already exists, such as a plan, group, or name.

This is not applicable to all operations.

412

failed validation; this typically means that a property was not set or a value is out of range.

example

HTTP 412
{
  "errors" : [
        {
          "field" : "name",
          "description" : "name is mandatory"
        }
    ]
}

422

failed processing (after passing validation).

example

HTTP 422
{
    "message": "Subscriber max plan count exceeded",
    "errorCode": 1
}

500

internal error

example

HTTP/1.1 500
{
    "message": "Internal server error - [Failed to get session information]",
    "status": "error"
}

503

request rejected due to overload