Get Instance ID and database group ID

Select

SaaS

Customer Managed

Get Instance ID, Database group ID using client name and instance name

Query Parameters

• clientName string required

  Name of the client

• agent string required
• instanceName string required

  Name of the Instance

• subclientName string

  Name of the database group

Responses

• 200
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Get Instance I D
• Get Database group I D

---

Schema

• subclientId integer

  Database group ID

• clientId integer

  Client Id

• instanceName string

  Instance name

• appName string
• applicationId integer
• clientName string

  Client Name

• instanceId integer

  Instance ID

• _type_ integer
• subclientName string

  Database group name

{
  "subclientId": 0,
  "clientId": 0,
  "instanceName": "string",
  "appName": "string",
  "applicationId": 0,
  "clientName": "string",
  "instanceId": 0,
  "_type_": 0,
  "subclientName": "string"
}

{
  "clientId": 6,
  "instanceName": "mysql_3306",
  "appName": "MySQL",
  "applicationId": 104,
  "clientName": "mysql",
  "instanceId": 21,
  "_type_": 5
}

{
  "subclientId": 1005,
  "clientId": 200,
  "appName": "MySQL",
  "applicationId": 104,
  "clientName": "mysqlrhel",
  "backupsetId": 593,
  "instanceId": 406,
  "subclientName": "default",
  "_type_": 7
}

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Not Found

Response Headers

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "No client/instance is specified",
  "errorCode": 4
}

Loading...