InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\SystemInformationEndpointsService Class Reference

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 getConfig ($zap_trace_span=null)
 
 getConfigWithHttpInfo ($zap_trace_span=null)
 
 getDebugPprofAllProfiles ($zap_trace_span=null, $cpu=null)
 
 getDebugPprofAllProfilesWithHttpInfo ($zap_trace_span=null, $cpu=null)
 
 getDebugPprofAllocs ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofAllocsWithHttpInfo ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofBlock ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofBlockWithHttpInfo ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofCmdline ($zap_trace_span=null)
 
 getDebugPprofCmdlineWithHttpInfo ($zap_trace_span=null)
 
 getDebugPprofGoroutine ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofGoroutineWithHttpInfo ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofHeap ($zap_trace_span=null, $debug=null, $seconds=null, $gc=null)
 
 getDebugPprofHeapWithHttpInfo ($zap_trace_span=null, $debug=null, $seconds=null, $gc=null)
 
 getDebugPprofMutex ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofMutexWithHttpInfo ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofProfile ($zap_trace_span=null, $seconds=null)
 
 getDebugPprofProfileWithHttpInfo ($zap_trace_span=null, $seconds=null)
 
 getDebugPprofThreadCreate ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofThreadCreateWithHttpInfo ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofTrace ($zap_trace_span=null, $seconds=null)
 
 getDebugPprofTraceWithHttpInfo ($zap_trace_span=null, $seconds=null)
 
 getHealth ($zap_trace_span=null)
 
 getHealthWithHttpInfo ($zap_trace_span=null)
 
 getMetrics ($zap_trace_span=null)
 
 getMetricsWithHttpInfo ($zap_trace_span=null)
 
 getPing ()
 
 getPingWithHttpInfo ()
 
 getReady ($zap_trace_span=null)
 
 getReadyWithHttpInfo ($zap_trace_span=null)
 
 getResources ($zap_trace_span=null)
 
 getResourcesWithHttpInfo ($zap_trace_span=null)
 
 getRoutes ($zap_trace_span=null)
 
 getRoutesWithHttpInfo ($zap_trace_span=null)
 

Protected Member Functions

 getConfigRequest ($zap_trace_span=null)
 
 getDebugPprofAllProfilesRequest ($zap_trace_span=null, $cpu=null)
 
 getDebugPprofAllocsRequest ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofBlockRequest ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofCmdlineRequest ($zap_trace_span=null)
 
 getDebugPprofGoroutineRequest ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofHeapRequest ($zap_trace_span=null, $debug=null, $seconds=null, $gc=null)
 
 getDebugPprofMutexRequest ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofProfileRequest ($zap_trace_span=null, $seconds=null)
 
 getDebugPprofThreadCreateRequest ($zap_trace_span=null, $debug=null, $seconds=null)
 
 getDebugPprofTraceRequest ($zap_trace_span=null, $seconds=null)
 
 getHealthRequest ($zap_trace_span=null)
 
 getMetricsRequest ($zap_trace_span=null)
 
 getPingRequest ()
 
 getReadyRequest ($zap_trace_span=null)
 
 getResourcesRequest ($zap_trace_span=null)
 
 getRoutesRequest ($zap_trace_span=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\SystemInformationEndpointsService::__construct ( DefaultApi $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ getConfig()

InfluxDB2\Service\SystemInformationEndpointsService::getConfig ( $zap_trace_span = null)

Operation getConfig

Retrieve runtime configuration

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Config|string|string

◆ getConfigRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getConfigRequest ( $zap_trace_span = null)
protected

Create request for operation 'getConfig'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getConfigWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getConfigWithHttpInfo ( $zap_trace_span = null)

Operation getConfigWithHttpInfo

Retrieve runtime configuration

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Config|string|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofAllocs()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofAllocs ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofAllocs

Retrieve the memory allocations runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofAllocsRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofAllocsRequest ( $zap_trace_span = null,
$debug = null,
$seconds = null )
protected

Create request for operation 'getDebugPprofAllocs'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofAllocsWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofAllocsWithHttpInfo ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofAllocsWithHttpInfo

Retrieve the memory allocations runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofAllProfiles()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofAllProfiles ( $zap_trace_span = null,
$cpu = null )

Operation getDebugPprofAllProfiles

Retrieve all runtime profiles

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$cpuCollects and returns CPU profiling data for the specified duration. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofAllProfilesRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofAllProfilesRequest ( $zap_trace_span = null,
$cpu = null )
protected

Create request for operation 'getDebugPprofAllProfiles'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$cpuCollects and returns CPU profiling data for the specified duration. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofAllProfilesWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofAllProfilesWithHttpInfo ( $zap_trace_span = null,
$cpu = null )

Operation getDebugPprofAllProfilesWithHttpInfo

Retrieve all runtime profiles

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$cpuCollects and returns CPU profiling data for the specified duration. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofBlock()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofBlock ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofBlock

Retrieve the block runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofBlockRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofBlockRequest ( $zap_trace_span = null,
$debug = null,
$seconds = null )
protected

Create request for operation 'getDebugPprofBlock'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofBlockWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofBlockWithHttpInfo ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofBlockWithHttpInfo

Retrieve the block runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofCmdline()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofCmdline ( $zap_trace_span = null)

Operation getDebugPprofCmdline

Retrieve the command line invocation

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
string|string

◆ getDebugPprofCmdlineRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofCmdlineRequest ( $zap_trace_span = null)
protected

Create request for operation 'getDebugPprofCmdline'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofCmdlineWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofCmdlineWithHttpInfo ( $zap_trace_span = null)

Operation getDebugPprofCmdlineWithHttpInfo

Retrieve the command line invocation

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of string|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofGoroutine()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofGoroutine ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofGoroutine

Retrieve the goroutines runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text with comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofGoroutineRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofGoroutineRequest ( $zap_trace_span = null,
$debug = null,
$seconds = null )
protected

Create request for operation 'getDebugPprofGoroutine'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text with comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofGoroutineWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofGoroutineWithHttpInfo ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofGoroutineWithHttpInfo

Retrieve the goroutines runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text with comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofHeap()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofHeap ( $zap_trace_span = null,
$debug = null,
$seconds = null,
$gc = null )

Operation getDebugPprofHeap

Retrieve the heap runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
int$gc- `0`: (Default) don't force garbage collection before sampling. - `1`: Force garbage collection before sampling. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofHeapRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofHeapRequest ( $zap_trace_span = null,
$debug = null,
$seconds = null,
$gc = null )
protected

Create request for operation 'getDebugPprofHeap'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
int$gc- `0`: (Default) don't force garbage collection before sampling. - `1`: Force garbage collection before sampling. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofHeapWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofHeapWithHttpInfo ( $zap_trace_span = null,
$debug = null,
$seconds = null,
$gc = null )

Operation getDebugPprofHeapWithHttpInfo

Retrieve the heap runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
int$gc- `0`: (Default) don't force garbage collection before sampling. - `1`: Force garbage collection before sampling. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofMutex()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofMutex ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofMutex

Retrieve the mutual exclusion (mutex) runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofMutexRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofMutexRequest ( $zap_trace_span = null,
$debug = null,
$seconds = null )
protected

Create request for operation 'getDebugPprofMutex'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofMutexWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofMutexWithHttpInfo ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofMutexWithHttpInfo

Retrieve the mutual exclusion (mutex) runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofProfile()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofProfile ( $zap_trace_span = null,
$seconds = null )

Operation getDebugPprofProfile

Retrieve the CPU runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$secondsNumber of seconds to collect profile data. Default is `30` seconds. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofProfileRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofProfileRequest ( $zap_trace_span = null,
$seconds = null )
protected

Create request for operation 'getDebugPprofProfile'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$secondsNumber of seconds to collect profile data. Default is `30` seconds. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofProfileWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofProfileWithHttpInfo ( $zap_trace_span = null,
$seconds = null )

Operation getDebugPprofProfileWithHttpInfo

Retrieve the CPU runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$secondsNumber of seconds to collect profile data. Default is `30` seconds. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofThreadCreate()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofThreadCreate ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofThreadCreate

Retrieve the threadcreate runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofThreadCreateRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofThreadCreateRequest ( $zap_trace_span = null,
$debug = null,
$seconds = null )
protected

Create request for operation 'getDebugPprofThreadCreate'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofThreadCreateWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofThreadCreateWithHttpInfo ( $zap_trace_span = null,
$debug = null,
$seconds = null )

Operation getDebugPprofThreadCreateWithHttpInfo

Retrieve the threadcreate runtime profile

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$debug- `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
string$secondsNumber of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getDebugPprofTrace()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofTrace ( $zap_trace_span = null,
$seconds = null )

Operation getDebugPprofTrace

Retrieve the runtime execution trace

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$secondsNumber of seconds to collect profile data. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|string

◆ getDebugPprofTraceRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofTraceRequest ( $zap_trace_span = null,
$seconds = null )
protected

Create request for operation 'getDebugPprofTrace'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$secondsNumber of seconds to collect profile data. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDebugPprofTraceWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getDebugPprofTraceWithHttpInfo ( $zap_trace_span = null,
$seconds = null )

Operation getDebugPprofTraceWithHttpInfo

Retrieve the runtime execution trace

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$secondsNumber of seconds to collect profile data. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|string, HTTP status code, HTTP response headers (array of strings)

◆ getHealth()

InfluxDB2\Service\SystemInformationEndpointsService::getHealth ( $zap_trace_span = null)

Operation getHealth

Retrieve the health of the instance

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\HealthCheck|\InfluxDB2\Model\HealthCheck|string

◆ getHealthRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getHealthRequest ( $zap_trace_span = null)
protected

Create request for operation 'getHealth'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getHealthWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getHealthWithHttpInfo ( $zap_trace_span = null)

Operation getHealthWithHttpInfo

Retrieve the health of the instance

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\HealthCheck|\InfluxDB2\Model\HealthCheck|string, HTTP status code, HTTP response headers (array of strings)

◆ getMetrics()

InfluxDB2\Service\SystemInformationEndpointsService::getMetrics ( $zap_trace_span = null)

Operation getMetrics

Retrieve workload performance metrics

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
string|string

◆ getMetricsRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getMetricsRequest ( $zap_trace_span = null)
protected

Create request for operation 'getMetrics'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getMetricsWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getMetricsWithHttpInfo ( $zap_trace_span = null)

Operation getMetricsWithHttpInfo

Retrieve workload performance metrics

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of string|string, HTTP status code, HTTP response headers (array of strings)

◆ getPing()

InfluxDB2\Service\SystemInformationEndpointsService::getPing ( )

Operation getPing

Get the status and version of the instance

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ getPingRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getPingRequest ( )
protected

Create request for operation 'getPing'

Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getPingWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getPingWithHttpInfo ( )

Operation getPingWithHttpInfo

Get the status and version of the instance

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ getReady()

InfluxDB2\Service\SystemInformationEndpointsService::getReady ( $zap_trace_span = null)

Operation getReady

Get the readiness of an instance at startup

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Ready|string

◆ getReadyRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getReadyRequest ( $zap_trace_span = null)
protected

Create request for operation 'getReady'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getReadyWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getReadyWithHttpInfo ( $zap_trace_span = null)

Operation getReadyWithHttpInfo

Get the readiness of an instance at startup

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Ready|string, HTTP status code, HTTP response headers (array of strings)

◆ getResources()

InfluxDB2\Service\SystemInformationEndpointsService::getResources ( $zap_trace_span = null)

Operation getResources

List all known resources

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
string[]|\InfluxDB2\Model\Error

◆ getResourcesRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getResourcesRequest ( $zap_trace_span = null)
protected

Create request for operation 'getResources'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getResourcesWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getResourcesWithHttpInfo ( $zap_trace_span = null)

Operation getResourcesWithHttpInfo

List all known resources

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of string[]|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getRoutes()

InfluxDB2\Service\SystemInformationEndpointsService::getRoutes ( $zap_trace_span = null)

Operation getRoutes

List all top level routes

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Routes

◆ getRoutesRequest()

InfluxDB2\Service\SystemInformationEndpointsService::getRoutesRequest ( $zap_trace_span = null)
protected

Create request for operation 'getRoutes'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getRoutesWithHttpInfo()

InfluxDB2\Service\SystemInformationEndpointsService::getRoutesWithHttpInfo ( $zap_trace_span = null)

Operation getRoutesWithHttpInfo

List all top level routes

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Routes, HTTP status code, HTTP response headers (array of strings)

The documentation for this class was generated from the following file: