Get Instance using parameters
This operation returns properties of a particular instance using client name, app name and instance name.
Path Parameters
- clientName string required
- appName string required
- instanceName string required
Header Parameters
- Accept string required
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
instanceProperties object[]
{
"instanceProperties": [
{
"isDeleted": true,
"instance": {
"clientId": 0,
"clientName": "string",
"instanceName": "string",
"appName": "string",
"instanceId": 0,
"applicationId": 0,
"instanceGUID": "string"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"mssqlInstance": {
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"instance": {
"clientId": 5,
"clientName": "firewalltestma_2",
"instanceName": "Test",
"appName": "SQL Server",
"instanceId": 3,
"applicationId": 81,
"instanceGUID": "33C8B996-2213-4000-A105-31BB061E1921"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mssqlInstance": {
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
}
}
}
]
}
GET /instance/byName(clientName=:clientName,appName=:appName),instanceName=:instanceName
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'