Please wait

Loading...

Start typing in the pseudo command bar to explore the commands available.

api:environments:stack-metrics-data-find

Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu).

For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.

Usage

acli api:environments:stack-metrics-data-find [--to TO] [--resolution RESOLUTION] [--] <environmentId> <filter> <from>
acli api:environments:stack-metrics-data-find 12-d314739e-296f-11e9-b210-d663bd873d93 2021-01-29T22:45:21+00:00 --to="2021-01-29T23:55:21+00:00"
acli api:environments:stack-metrics-data-find myapp.dev 2021-01-29T22:45:21+00:00 --to="2021-01-29T23:55:21+00:00"

Arguments

  • environmentId

    Required

    The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • filter

    Required

    The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable. There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are: * Equals: `= (%3D)` * Does not equal: `!= (!%3D)` * Greater than: `> (%3E)` * Less than: `< (%3C)` * Greater than or equal to: `>= (%3E%3D)` * Less than or equal to: `<= (%3C%3D)` * Contains substring: `=@ (%3D@)` * Does not contain substring: `!@ (!@)` Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`). Some examples: * `filter=field%3Dvalue` (`field` equals `'value'`) * `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`) * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`) * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`) **For this endpoint, the "metric" filter is required. Multiple metrics can be returned in one request. The following metrics are available:** * apache-requests, bal-cpu, bal-memory, cron-memory, db-cpu, db-disk-size, db-disk-usage, db-memory, file-disk-size, file-cpu, file-disk-usage, file-memory, http-2xx, http-3xx, http-4xx, http-5xx, mysql-slow-query-count, nginx-requests, out-of-memory, php-proc-max-reached-site, php-proc-max-reached-total, php-proc-site, php-proc-total, varnish-cache-hit-rate, varnish-requests, web-cpu, web-memory

  • from

    Required

    An ISO-8601 formatted date retrieve metrics from.

Options

  • --to

    Required

    An ISO-8601 formatted date retrieve results to.

  • --resolution

    Required

    Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month. Limits: - 3 hour limit for “minute” resolution - 1 week limit for “hour” resolution - 6 month limit for “day” resolution - 1 year limit for "week" resolution - 3 year limit for “month” resolution

  • --help | -h

    Optional

    Display help for the given command. When no command is given display help for the <info>list</info> command

    Defaults to false

  • --quiet | -q

    Optional

    Do not output any message

    Defaults to false

  • --verbose | -v|-vv|-vvv

    Optional

    Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

    Defaults to false

  • --version | -V

    Optional

    Display this application version

    Defaults to false

  • --ansi

    Optional

    Force (or disable --no-ansi) ANSI output

  • --no-ansi

    Optional

    Negate the "--ansi" option

    Defaults to false

  • --no-interaction | -n

    Optional

    Do not ask any interactive question

    Defaults to false