Jump to

• Request
• Response

Get all profiler groups

get

/serviceapi/apm.dataserver/api/v1/profiler/jobs

Retrieve list of all Profiler Groups and details in a given time range

Request

Supported Media Types

• application/json

Query Parameters

• appserverId(optional): string
  Name of application server (see Get application servers and their JVM metrics or similar). For more information see Object ID 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. Use attribute or attribute:asc or attribute:desc. Valid attributes can be found by using Get resource metadata with metadataType = OrderBy and metadataQuery resource = /appservers
• 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. Use query like predicates, such as attribute<=value< code>. Multiple predicates should be parenthesized and joined by AND or OR. Valid attributes can be found by using Get resource metadata with metadataType = Filter and metadataQuery resource = /appservers
• since(optional): string
  Retrieve results from start of time period, format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (e.g. 2015-11-23T22:11:05.000Z). For more information see Since and Until Time Range.
• until(optional): string
  Retrieve results until end of time period, format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

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 ProfilerGroup
  Profiler Job Details and also summary of attached Appsever profilers

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

Nested Schema : ProfilerGroup

Type: object

Profiler Job Details and also summary of attached Appsever profilers

Show Source

• appServerHostName(optional): string
• appServerName(optional): string
• appServerPort(optional): integer(int32)
• appServerSSLPort(optional): integer(int32)
• attachedProfilers(optional): array appServers
• createdBy(optional): string
• description(optional): string
• description_deprecated(optional): string
• duration(optional): integer(int32)
• groupLongKey(optional): string
• groupLongKey_deprecated(optional): string
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• name(optional): string
• name_deprecated(optional): string
• profilerGroupId(optional): integer(int64)
• profilerGroupId_deprecated(optional): integer(int64)
• queryTimeRange(optional): object TimeRange
• requestedTime(optional): integer(int64)
• status(optional): string
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "profilerGroupId":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"profilerJobId"
            }
        },
        "groupLongKey":{
            "type":"string",
            "xml":{
                "name":"profilerJobKey"
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"jobName"
            }
        },
        "appServerName":{
            "type":"string"
        },
        "appServerHostName":{
            "type":"string"
        },
        "appServerPort":{
            "type":"integer",
            "format":"int32"
        },
        "appServerSSLPort":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "name":"appServerSslPort"
            }
        },
        "description":{
            "type":"string",
            "xml":{
                "name":"jobDescription"
            }
        },
        "status":{
            "type":"string"
        },
        "duration":{
            "type":"integer",
            "format":"int32"
        },
        "requestedTime":{
            "type":"integer",
            "format":"int64"
        },
        "createdBy":{
            "type":"string"
        },
        "attachedProfilers":{
            "type":"array",
            "xml":{
                "name":"appServers"
            },
            "items":{
                "$ref":"#/definitions/ProfilerDetails"
            }
        },
        "profilerGroupId_deprecated":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"profilerGroupId"
            }
        },
        "groupLongKey_deprecated":{
            "type":"string",
            "xml":{
                "name":"profilerGroupKey"
            }
        },
        "name_deprecated":{
            "type":"string",
            "xml":{
                "name":"groupName"
            }
        },
        "description_deprecated":{
            "type":"string",
            "xml":{
                "name":"groupDescription"
            }
        },
        "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":"Profiler Job Details and also summary of attached Appsever profilers"
}

Nested Schema : appServers

Type: array

Show Source

• Array of: object ProfilerDetails
  Appserver Profiler Details

{
    "type":"array",
    "xml":{
        "name":"appServers"
    },
    "items":{
        "$ref":"#/definitions/ProfilerDetails"
    }
}

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 : 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 : ProfilerDetails

Type: object

Appserver Profiler Details

Show Source

• appServerVersionKey(optional): string
• cpuCores(optional): integer(int32)
• cpuPercent(optional): number(double)
• endTime(optional): integer(int64)
• gcPercent(optional): number(double)
• lastModified(optional): integer(int64)
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• memoryPercent(optional): number(double)
• profilerId(optional): integer(int64)
• profilerLongKey(optional): string
• queryTimeRange(optional): object TimeRange
• startTime(optional): integer(int64)
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "profilerId":{
            "type":"integer",
            "format":"int64"
        },
        "profilerLongKey":{
            "type":"string",
            "xml":{
                "name":"profilerKey"
            }
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "type":"integer",
            "format":"int64"
        },
        "cpuPercent":{
            "type":"number",
            "format":"double"
        },
        "memoryPercent":{
            "type":"number",
            "format":"double"
        },
        "gcPercent":{
            "type":"number",
            "format":"double"
        },
        "cpuCores":{
            "type":"integer",
            "format":"int32"
        },
        "appServerVersionKey":{
            "type":"string",
            "xml":{
                "name":"appServerKey"
            }
        },
        "lastModified":{
            "type":"integer",
            "format":"int64"
        },
        "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":"Appserver Profiler Details"
}

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 : 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 : 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