Action - Set Ratio

Before you begin

Before attempting to initiate set ratio action with this API, users must ensure the ACF permission is available:

ADC > ControlCenter > Actions > Ratio

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

Request Structure


Endpoint:	`/adc-device-object-action-ratio`
Type:	`PUT`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-device-object-action-ratio?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
objects `Key value pair[]`	(Mandatory) Object information containing resource ID and parent resource ID. For object details, click here.
ratio	(Mandatory) Ratio to set. Constraints: Allows only numerical values.

Table 2. Object Details
Name	Description
_id `String`	Resource ID of the objects. Note: Use the search API to search/get the resource ID.
parent_id `String`	Resource ID of the parent objects. Note: Use the search API to search/get the resource ID.

Response Structure

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


Name	Description
response `String`	Success message or failure description in case of error.
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
202 Accepted	-	Action triggered for the following <n> object(s) : <resourceIds>	-
400 Bad Request	ADC_CC_05012	Invalid input. Please provide 'ratio' to perform action!	Check and ensure if a non-null/non-empty value is given in payload field - ‘ratio’.
400 Bad Request	ADC_OBJ_ACTION_001	Object id not found.	Check and en..sure if a non-null/non-empty value is given in payload field - ‘objects._id’
400 Bad Request	ADC_OBJ_ACTION_002	parent object id not found.	Check and ensure if a non-null/non-empty value is given in payload field - ‘objects.parent_id’
400 Bad Request	ADC_OBJ_ACTION_003	No object(s) not found to perform action.	Check and ensure if a non-null/non-empty value is given in payload field - ‘objects’.
400 Bad Request	ADC_OBJ_ACTION_004	Action is invalid for the given objects.	Check for supported objects for the action and change the request objectId.
403 Forbidden	ADC_DASH_0029	No given object(s) have Write permission.	Check and ensure if the requested object has Read Write permission.
403 Forbidden	ADC_INV_1077	Action cannot be performed on unmanaged device object(s)	-

Sample Request/Response

Use Case

Set a ratio of 1 on object with resource id - lpm:@5f369cc10ca9846e86a13e95:@ms_pool_1:@Common::ms_serv:443:@Common with parent object - lp:@5f369cc10ca9846e86a13e95:@ms_pool_1:@Common

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-device-object-action-ratio

Sample Request

{
  "payload": {
    "objects": [
      {
        "_id": "lpm:@5f369cc10ca9846e86a13e95:@ms_pool_1:@Common::ms_serv:443:@Common",
        "parent_id": "lp:@5f369cc10ca9846e86a13e95:@ms_pool_1:@Common"
      }
    ],
    "ratio": "1"
  }
}

Sample Response

{
  "response": "Action triggered successfully.",
  "message": "Action triggered for the following 1 object(s) : lpm:@5f369cc10ca9846e86a13e95:@ms_pool_1:@Common::ms_serv:443:@Common",
  "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 - ARP Enable/Disable