Skip to main content

apic reports:catalogRatelimitstatus

Rate limit status report

Synopsis​

Return applications approaching their rate limits with pagination support at catalog scope. This report identifies applications that are consuming their rate limit quotas and provides comprehensive details for notification purposes including application, product, plan, API, consumer organization, and rate limit quota information.

apic reports:catalogRatelimitstatus --mode analytics [flags]

Possible Usages​

apic reports:catalogRatelimitstatus --mode analytics [flags]

Options​

      --accept-language string     Natural language and locale that the client prefers.
      --analytics-service string   Analytics service name or ID. (required)
  -c, --catalog string             Catalog name or ID. (required)
      --end string                 If set, only return events with a datetime equal or older than this. The date-time value must be such that the time component represents midnight. for example, 2021-07-21T00:00:000Z.
                                   
      --format string              Output format. One of [json yaml octet-stream go-template=... go-template-file=...], defaults to yaml.
      --limit string               If set, the number of items to return when requesting a list. Maximum: 500
      --offset string              If set, the offset to be applied when requesting a list. e.g. return events starting from the 100th result
  -o, --org string                 Provider organization name or ID. (required)
      --output string              Write file(s) to directory, instead of STDOUT (default "-")
      --search string              Filter results by search string
  -s, --server string              management server endpoint (required)
      --sort string                Specifies the field name to use to sort the results. By default, the sorting is in ascending order. To sort in descending order, prefix the field name with a -
      --start string               If set, only return events with a date equal to or newer than this. The date-time value must be such that the time component represents midnight. for example, 2021-07-21T00:00:000Z.
                                   
      --status string              Filter rate limit report by status level. Only returns applications matching the specified status. Status levels are calculated based on usage percentage: overage (100%), critical (90-99%), warning (75-89%), moderate (50-74%), healthy (0-49%). Use 'all' to return all records without filtering.
                                    (required)
      --timeframe string           If set, only return events within the indicated timeframe. Timeframe values are in the format of 'last<value><unit>' where <value> is a positive integer greater than one, and <unit> can be one of day, month, quarter or year.

Options inherited from parent commands​

      --accept-license                  Accept the license for API Connect
      --certificate-authority strings   Path to a cert file for the certificate authority
      --debug                           Enable debug output
      --debug-output string             Write debug output to file
      --insecure-skip-pkix-validation   Skip verifying the complete TLS certificate chain (insecure)
      --insecure-skip-tls-verify        If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --lang string                     Toolkit operation language
      --live-help                       Enable or disable tracking of limited usage information
  -m, --mode string                     Toolkit operation mode (default "apim")
      --tls-server-name string          Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used