Skip to content

uri_dom

Configuration for AF URL dom Report table for Level 1 resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
embedded_object_count<Double>Read-writeembedded_object_count.
__count<Double>Read-writecount..
max_transaction_time<Double>Read-writeLast Transaction Time for this URL in the sampled timeframe..
complete_rendering_time<Double>Read-writeRender time..
response_send_time<Double>Read-writeresponse_send_time.
start_rendering_time<Double>Read-writeRender time..
render_time<Double>Read-writeRender time..
request_time_to_first_byte<Double>Read-writerequest_time_to_first_byte.
url<String>Read-writeHTTP Request URL..
Maximum length = 2000
id<String>Read-writeId is URL Dom..
Maximum length = 2000
rpt_sample_time<Double>Read-writeReport Sample time..
x_scale<Double>Read-writex_scale.
request_processing_time<Double>Read-writerequest_processing_time.
load_time<Double>Read-writeURI Load time..
is_embedded_object<Double>Read-writeis_embedded_object.
application_response_time<Double>Read-writeApplication Response Time..

Operations

(click to see Properties)

GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/uri_dom

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "uri_dom":[{
"embedded_object_count":<Double_value>,
"__count":<Double_value>,
"http_resp_status_name":<String_value>,
"max_transaction_time":<Double_value>,
"complete_rendering_time":<Double_value>,
"response_send_time":<Double_value>,
"start_rendering_time":<Double_value>,
"app_unit_name":<String_value>,
"render_time":<Double_value>,
"request_time_to_first_byte":<Double_value>,
"url":<String_value>,
"id":<String_value>,
"operating_system_name":<String_value>,
"server_ip_address":<String_value>,
"http_req_method_name":<String_value>,
"rpt_sample_time":<Double_value>,
"user_agent_name":<String_value>,
"x_scale":<Double_value>,
"device_ip_address":<String_value>,
"domain_name":<String_value>,
"request_processing_time":<Double_value>,
"load_time":<Double_value>,
"is_embedded_object":<Double_value>,
"client_ip_address":<String_value>,
"application_response_time":<Double_value>}]}