Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET ApiResponseTimeSummary

Represents summarized information about response times for each service.

Since Product Version: 2.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

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/data/ApiResponseTimeSummary

Response Parameters

Attribute Description

average long

The arithmetic mean, or average response time, measured in milliseconds.

instanceOrigin InstanceOriginEnum

Allowed values:

  • UNCONCERNED
  • APPLICATION
  • NETWORK

instanceTenantId Integer

This is a tenant id for this instance.

latest long

The latest response time, measured in milliseconds.

max long

The maximum response time, measured in milliseconds.

min long

The minimum response time, measured in milliseconds.

path String

The path of the service.

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 Payload

https://localhost/webacs/api/v1/data/ApiResponseTimeSummary/15

<?xml version="1.0" ?>
<queryResponse type="ApiResponseTimeSummary" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/ApiResponseTimeSummary/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="apiResponseTimeSummaryDTO" type="ApiResponseTimeSummary" url="https://localhost/webacs/api/v1/data/ApiResponseTimeSummary/15">
    <apiResponseTimeSummaryDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
      <average>2</average>
      <latest>2</latest>
      <max>2</max>
      <min>2</min>
      <path>String value</path>
    </apiResponseTimeSummaryDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v1/data/ApiResponseTimeSummary/15.json

{
  "queryResponse" : {
    "@type" : "ApiResponseTimeSummary",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/ApiResponseTimeSummary\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "apiResponseTimeSummaryDTO",
      "@type" : "ApiResponseTimeSummary",
      "@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/ApiResponseTimeSummary\/15",
      "apiResponseTimeSummaryDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@instanceTenantId" : "String value",
        "@uuid" : "String value",
        "average" : 2,
        "latest" : 2,
        "max" : 2,
        "min" : 2,
        "path" : "String value"
      }
    }
  }
}