reporting.exporters.get_instance ================================ Returns instance matching `id`. If `id` is not found, Validation error is raised. Please see `query` method documentation for `options`. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer
Parameter 2: options

options

Type: object Default: {}

Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).

No Additional Items
Each item of this array must be:
Type: string

Example:

[
        "size",
        "-devname",
        "nulls_first:-expiretime"
    ]

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.

No Additional Items
Each item of this array must be:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Example:

[
        "username",
        "Authentication.status"
    ]

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

ReportingExporterEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the reporting exporter.

Enabled

Type: boolean

Whether this exporter is enabled and active.

Attributes

Type: object

Specific attributes for the exporter.

 No Additional Properties

Exporter Type

Type: const

Type of exporter - Graphite.

Specific value: "GRAPHITE"

Destination Ip

Type: string

IP address of the Graphite server.

Must be at least 1 characters long

Destination Port

Type: integer

Port number of the Graphite server.

Value must be greater or equal to 1 and lesser or equal to 65535

Prefix

Type: string Default: "scale"

Prefix to prepend to all metric names.

Namespace

Type: string

Namespace to organize metrics under.

Must be at least 1 characters long

Update Every

Type: integer Default: 1

Interval in seconds between metric updates.

Value must be greater or equal to 1

Buffer On Failures

Type: integer Default: 10

Number of updates to buffer when Graphite server is unavailable.

Value must be greater or equal to 1

Send Names Instead Of Ids

Type: boolean Default: true

Whether to send human-readable names instead of internal IDs.

Matching Charts

Type: string Default: "*"

Pattern to match charts for export (supports wildcards).

Must be at least 1 characters long

Name

Type: string

User defined name of exporter configuration.


*Required roles:* REPORTING_READ