Get Object Status Trend

Before you begin

Before attempting to get an object status trend with this API, users must ensure any of the ACF permission from is available:

ADC > Control Center,
ADC > Dashboard > Application Widget
ADC > Orphan objects

This can be checked under Accounts > Role > Authorized Functions.

Request Structure


Endpoint:	`/adc-object-status-trend-fetch`
Type:	`GET`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-object-status-trend-fetch?gwsource=external` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Input Parameter
Name	Description
sessionId `Header`	(Mandatory) Specifies the session ID of the user session received after login. Type: String Constraints: The session ID is used when username and password are not provided.
username `Header`	(Mandatory) Specifies the login username used to access the AppViewX. Type: String Constraints: The username, along with the password, is used when the session ID is not provided.
password `Header`	(Mandatory) Specifies the login password used to access the AppViewX. Type: String Constraints: The password, along with the username, is used when the session ID is not provided.
Content-Type `Header`	(Mandatory) Specifies the format of the data in the payload. Type: String Constraints: The value of this param must be ‘application/json’.
gwsource `Query`	(Mandatory) Specifies the source from which the request is triggered. The options are: web external Type: String
payload `Body`	(Mandatory) Contains all the params to be sent in the request body for the post request. See Payload section for more details.

Payload


Name	Description
objectId `String`	(Mandatory) Resource ID of the object. Use the search API to search/get the resource ID.
lastNDays `Integer`	(Mandatory) Last ‘N’ no. of days for which an object remained in constant state.

Response Structure

Status Code: 200 OK
Message: Successful
Headers:
- Content-Type: application/json


Name	Description
response `String`	Contains the response for requested objects last ‘N’ flip history. See State Status Drift response for more details.
message `String`	Success message along with the objectIds or failure description in case of error.
appStatusCode `String`	Application specific status code for the response. Will be non-null for failure response.
tags `String`	More info in case of failure response.

Status Codes


HTTP Status Code	appStatusCode	Message	Possible remediation
200 OK	-	-	-
400 Bad Request	ADC_DASH_1606	Invalid Input: Mandatory fields 'objectId' is missing	Check and ensure if a non-null/non-empty value is given in the query param field - ‘objectId’.
400 Bad Request	ADC_DASH_0035	Invalid Input	Check the type of the query param field - lastNCounts. Expected type is Integer.
404 Not Found	ADC_DASH_1608	No objects found for the given input	Check if the requested objects have Read or ReadWrite permission. Refine the search query.

Sample Request/Response

Use Case

Get last 5 status flip trend for objectId - lpm:@5f4e3091a7452e427bcede52:@newltmpool:@Common::12.9.1.0:21:@Common

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-object-status-trend-fetch

Sample Request

NA

Sample Response

{
  "response": [
    {
      "objectId": "lpm:@5f4e3091a7452e427bcede52:@newltmpool:@Common::12.9.1.0:21:@Common",
      "objectName": "12.9.1.0:21",
      "objectType": "LTM Pool Member",
      "deviceId": "5f4e3091a7452e427bcede52",
      "deviceName": "gs-f5-pe109.lab.appviewx.net",
      "vendor": "F5",
      "state": null,
      "status": "OFFLINE",
      "displayName": "12.9.1.0:21/12.9.1.0:21/newltmpool/gs-f5-pe109.lab.appviewx.net/F5",
      "effectiveDays": 0,
      "lastFlipDate": "2020-09-01"
    }
  ],
  "message": null,
  "appStatusCode": null,
  "tags": null,
  "headers": null
}

Reference

Understanding the sample URL:

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.

What's Next

Action - Set Loadbalancing Method