Skip to content

cachecontentgroup

Statistics for Integrated Cache content group resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of the cache contentgroup for which to display statistics. If you do not set this parameter, statistics are shown for all cache contentgroups.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
groupnon304hit<Double>Read-onlyNon304 hits for ContentGroup
group304hit<Double>Read-only304 hits for ContentGroup
totcell<Double>Read-onlyNumber of objects in contentgroup
totmarkercell<Double>Read-onlyNumber of marker objects in contentgroup
timesflushed<Double>Read-onlyNumber of times contentgroup is flushed
totmemory<Double>Read-onlycurrent memory usage
maxmemory<Double>Read-onlymaximum memory usage limit

Operations

(click to see Properties)

GET (ALL)| GET

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/cachecontentgroup

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/cachecontentgroup?args=name:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get cachecontentgroup resources based on additional properties.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "cachecontentgroup": [ {
"name":<String_value>,
"group304hit":<Double_value>,
"totmarkercell":<Double_value>,
"timesflushed":<Double_value>,
"totmemory":<Double_value>,
"totcell":<Double_value>,
"groupnon304hit":<Double_value>,
"maxmemory":<Double_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/cachecontentgroup/name_value><String>

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "cachecontentgroup": [ {
"name":<String_value>,
"group304hit":<Double_value>,
"totmarkercell":<Double_value>,
"timesflushed":<Double_value>,
"totmemory":<Double_value>,
"totcell":<Double_value>,
"groupnon304hit":<Double_value>,
"maxmemory":<Double_value>
}]}