Jump to

• Request
• Response

Get host information

get

/serviceapi/apm.dataserver/api/v1/hostinfo

Retrieve a list of host information from all application servers

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): integer(int32)
  Maximum number of elements in the result set, useful for paging [default = all, max = 1000]. For more information see Paging.
• offset(optional): integer(int32)
  Offset into result set at which to start returning data, useful for paging [default = 0].
• orderBy(optional): string
  Comma-separated list of one or more attributes by which the result set is ordered [default = null]. For more information see Sorting.
• q(optional): string
  Query clause of one or more predicates to restrict the result set to those objects satisfying the clause [default = null]. For more information see Filtering.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Completed successfully, list may be empty. See Status Codes for information about other possible HTTP response status codes.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object HostInfo
  Information about an App Server Host (HostInfo)

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HostInfo"
    }
}

Nested Schema : HostInfo

Type: object

Information about an App Server Host (HostInfo)

Show Source

• agentVersionId(optional): integer(int64)
• agentVersionLongKey(optional): string
• hostArchitecture(optional): string
• hostName(optional): string
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• meId(optional): string
• metadataMap(optional): object metadataMap
  Additional Properties Allowed: additionalProperties
• osContainerId(optional): string
• osContainerType(optional): string
• osName(optional): string
• osVersion(optional): string
• processorCount(optional): integer(int64)
• queryTimeRange(optional): object TimeRange
• versionId(optional): integer(int64)
• versionLongKey(optional): string
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"integer",
            "format":"int64"
        },
        "versionLongKey":{
            "type":"string"
        },
        "hostName":{
            "type":"string"
        },
        "osName":{
            "type":"string"
        },
        "osVersion":{
            "type":"string"
        },
        "hostArchitecture":{
            "type":"string"
        },
        "processorCount":{
            "type":"integer",
            "format":"int64"
        },
        "agentVersionId":{
            "type":"integer",
            "format":"int64"
        },
        "agentVersionLongKey":{
            "type":"string"
        },
        "meId":{
            "type":"string"
        },
        "osContainerType":{
            "type":"string"
        },
        "osContainerId":{
            "type":"string"
        },
        "metadataMap":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "linkCollection":{
            "type":"array",
            "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "queryTimeRange":{
            "description":"Integer query time range used by server to run user query; see <a href='QP_Since_and_Until_Time_Range.html'>Since and Until Time Range</a> for more information",
            "$ref":"#/definitions/TimeRange"
        },
        "warnings":{
            "type":"array",
            "description":"Informational or Error messages",
            "items":{
                "$ref":"#/definitions/ErrorMessage"
            }
        }
    },
    "description":"Information about an App Server Host (HostInfo)"
}

Nested Schema : linkCollection

Type: array

See Links to Related Resources for more information

Show Source

• Array of: object Link
  Information about a Link to a resource

{
    "type":"array",
    "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : metadataMap

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : TimeRange

Type: object

Show Source

• sinceTime(optional): integer(int64)
  Results are returned *since* this timestamp
• timeInMinutes(optional): integer(int64)
• untilTime(optional): integer(int64)
  Results are returned *until* this timestamp

{
    "type":"object",
    "properties":{
        "timeInMinutes":{
            "type":"integer",
            "format":"int64"
        },
        "sinceTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *since* this timestamp"
        },
        "untilTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *until* this timestamp"
        }
    }
}

Nested Schema : warnings

Type: array

Informational or Error messages

Show Source

• Array of: object ErrorMessage
  An error message

{
    "type":"array",
    "description":"Informational or Error messages",
    "items":{
        "$ref":"#/definitions/ErrorMessage"
    }
}

Nested Schema : Link

Type: object

Information about a Link to a resource

Show Source

• baseUrl(optional): string
  The base URL for the link
• href: string
  The href portion of the link
• post(optional): string
  The post data of the link
• rel: string
  The relationship name of the link

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship name of the link"
        },
        "href":{
            "type":"string",
            "description":"The href portion of the link"
        },
        "baseUrl":{
            "type":"string",
            "description":"The base URL for the link"
        },
        "post":{
            "type":"string",
            "description":"The post data of the link"
        }
    },
    "description":"Information about a Link to a resource"
}

Nested Schema : additionalProperties

Type: object

Nested Schema : ErrorMessage

Type: object

An error message

Show Source

• detail: string
  A detailed description of the error
• errorType(optional): string
  Allowed Values: [ "INFO", "WARNING", "VALIDATION", "ERROR" ]

  The error type
• message: string
  The error message

{
    "type":"object",
    "required":[
        "detail",
        "message"
    ],
    "properties":{
        "errorType":{
            "type":"string",
            "description":"The error type",
            "enum":[
                "INFO",
                "WARNING",
                "VALIDATION",
                "ERROR"
            ]
        },
        "message":{
            "type":"string",
            "description":"The error message"
        },
        "detail":{
            "type":"string",
            "description":"A detailed description of the error"
        }
    },
    "description":"An error message"
}

Back to Top