API is not supported
Supported products: Operations Center
Provides information about servers managed by Operations Center.
Since Product Version: 3.7
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/managedServers
Response Parameters
accessibleAddress
String
|
This address is used by OpCenter to communicate with the managed server.
|
alias
String
|
|
highAvailabilityStatus
HighAvailabilityStatusEnum
|
Managed server high availability status.
|
name
String
|
IP address or hostname that was used to add the managed server.
|
port
int
|
Managed server network port.
|
state
ManagedServerStateEnum
|
Managed server reachability status.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/managedServers
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/managedServers" rootUrl="https://localhost/webacs/api/v1/op">
<managedServerDTO>
<accessibleAddress>String value</accessibleAddress>
<alias>String value</alias>
<highAvailabilityStatus>PRIMARY_ACTIVE</highAvailabilityStatus>
<name>String value</name>
<port>1</port>
<state>REACHABLE</state>
</managedServerDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/managedServers.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/managedServers",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"managedServerDTO" : {
"accessibleAddress" : "String value",
"alias" : "String value",
"highAvailabilityStatus" : "PRIMARY_ACTIVE",
"name" : "String value",
"port" : 1,
"state" : "REACHABLE"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/managedServers
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
accessibleAddress
String
|
This address is used by OpCenter to communicate with the managed server.
|
alias
String
|
|
highAvailabilityStatus
HighAvailabilityStatusEnum
|
Managed server high availability status.
|
name
String
|
IP address or hostname that was used to add the managed server.
|
port
int
|
Managed server network port.
|
state
ManagedServerStateEnum
|
Managed server reachability status.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/managedServers
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/managedServers" rootUrl="https://localhost/webacs/api/v2/op">
<managedServerDTO>
<accessibleAddress>String value</accessibleAddress>
<alias>String value</alias>
<highAvailabilityStatus>PRIMARY_ACTIVE</highAvailabilityStatus>
<name>String value</name>
<port>1</port>
<state>REACHABLE</state>
</managedServerDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/managedServers.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/managedServers",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"managedServerDTO" : [ {
"accessibleAddress" : "String value",
"alias" : "String value",
"highAvailabilityStatus" : "PRIMARY_ACTIVE",
"name" : "String value",
"port" : 1,
"state" : "REACHABLE"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/managedServers
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
accessibleAddress
String
|
This address is used by OpCenter to communicate with the managed server.
|
alias
String
|
|
highAvailabilityStatus
HighAvailabilityStatusEnum
|
Managed server high availability status.
|
name
String
|
IP address or hostname that was used to add the managed server.
|
port
int
|
Managed server network port.
|
state
ManagedServerStateEnum
|
Managed server reachability status.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/managedServers
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/managedServers" rootUrl="https://localhost/webacs/api/v3/op">
<managedServerDTO>
<accessibleAddress>String value</accessibleAddress>
<alias>String value</alias>
<highAvailabilityStatus>PRIMARY_ACTIVE</highAvailabilityStatus>
<name>String value</name>
<port>1</port>
<state>REACHABLE</state>
</managedServerDTO>
<managedServerDTO>
<accessibleAddress>Another string value</accessibleAddress>
<alias>Another string value</alias>
<highAvailabilityStatus>SECONDARY_ACTIVE</highAvailabilityStatus>
<name>Another string value</name>
<port>11</port>
<state>UNREACHABLE</state>
</managedServerDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/managedServers.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/managedServers",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"managedServerDTO" : [ {
"accessibleAddress" : "String value",
"alias" : "String value",
"highAvailabilityStatus" : "PRIMARY_ACTIVE",
"name" : "String value",
"port" : 1,
"state" : "REACHABLE"
}, {
"accessibleAddress" : "Another string value",
"alias" : "Another string value",
"highAvailabilityStatus" : "SECONDARY_ACTIVE",
"name" : "Another string value",
"port" : 11,
"state" : "UNREACHABLE"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/managedServers
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
accessibleAddress
String
|
This address is used by OpCenter to communicate with the managed server.
|
alias
String
|
|
highAvailabilityStatus
HighAvailabilityStatusEnum
|
Managed server high availability status.
|
name
String
|
IP address or hostname that was used to add the managed server.
|
port
int
|
Managed server network port.
|
state
ManagedServerStateEnum
|
Managed server reachability status.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v4/op/managedServers
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/managedServers" rootUrl="https://localhost/webacs/api/v4/op">
<managedServerDTO>
<accessibleAddress>String value</accessibleAddress>
<alias>String value</alias>
<highAvailabilityStatus>PRIMARY_ACTIVE</highAvailabilityStatus>
<name>String value</name>
<port>1</port>
<state>REACHABLE</state>
</managedServerDTO>
<managedServerDTO>
<accessibleAddress>Another string value</accessibleAddress>
<alias>Another string value</alias>
<highAvailabilityStatus>SECONDARY_ACTIVE</highAvailabilityStatus>
<name>Another string value</name>
<port>11</port>
<state>UNREACHABLE</state>
</managedServerDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/managedServers.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/managedServers",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"managedServerDTO" : [ {
"accessibleAddress" : "String value",
"alias" : "String value",
"highAvailabilityStatus" : "PRIMARY_ACTIVE",
"name" : "String value",
"port" : 1,
"state" : "REACHABLE"
}, {
"accessibleAddress" : "Another string value",
"alias" : "Another string value",
"highAvailabilityStatus" : "SECONDARY_ACTIVE",
"name" : "Another string value",
"port" : 11,
"state" : "UNREACHABLE"
} ]
}
}