• InfluxDB.Client API
Show / Hide Table of Contents
  • InfluxDB.Client
    • AuthorizationsApi
    • BucketsApi
    • ChecksApi
    • DeleteApi
    • IAuthorizationsApi
    • IBucketsApi
    • IChecksApi
    • IDeleteApi
    • IDomainObjectMapper
    • IInfluxDBClient
    • IInvokableScriptsApi
    • ILabelsApi
    • InfluxDBClient
    • InfluxDBClientFactory
    • InfluxDBClientOptions
    • InfluxDBClientOptions.AuthenticationScheme
    • InfluxDBClientOptions.Builder
    • INotificationEndpointsApi
    • INotificationRulesApi
    • InvokableScriptsApi
    • IOrganizationsApi
    • IQueryApi
    • IQueryApiSync
    • IScraperTargetsApi
    • ISourcesApi
    • ITasksApi
    • ITelegrafsApi
    • IUsersApi
    • IWriteApi
    • IWriteApiAsync
    • LabelsApi
    • NotificationEndpointsApi
    • NotificationRulesApi
    • OrganizationsApi
    • QueryApi
    • QueryApiSync
    • ScraperTargetsApi
    • SourcesApi
    • TasksApi
    • TelegrafsApi
    • UsersApi
    • WriteApi
    • WriteApiAsync
    • WriteOptions
    • WriteOptions.Builder
  • InfluxDB.Client.Api.Domain
    • AddResourceMemberRequestBody
    • AnalyzeQueryResponse
    • AnalyzeQueryResponseErrors
    • ArrayExpression
    • ArrayExpression.ArrayExpressionElementsAdapter
    • ASTResponse
    • Authorization
    • AuthorizationLinks
    • AuthorizationPostRequest
    • Authorizations
    • AuthorizationUpdateRequest
    • AuthorizationUpdateRequest.StatusEnum
    • Axes
    • Axis
    • Axis.BaseEnum
    • AxisScale
    • BadStatement
    • BandViewProperties
    • BandViewProperties.HoverDimensionEnum
    • BandViewProperties.ShapeEnum
    • BandViewProperties.TypeEnum
    • BinaryExpression
    • BinaryExpression.BinaryExpressionLeftAdapter
    • BinaryExpression.BinaryExpressionRightAdapter
    • Block
    • Block.BlockBodyAdapter
    • BooleanLiteral
    • Bucket
    • Bucket.TypeEnum
    • BucketLinks
    • BucketMetadataManifest
    • BucketRetentionRules
    • BucketRetentionRules.TypeEnum
    • Buckets
    • BucketShardMapping
    • BuilderAggregateFunctionType
    • BuilderConfig
    • BuilderConfigAggregateWindow
    • BuilderFunctionsType
    • BuilderTagsType
    • BuiltinStatement
    • CallExpression
    • CallExpression.CallExpressionArgumentsAdapter
    • CallExpression.CallExpressionCalleeAdapter
    • Cell
    • CellLinks
    • CellUpdate
    • CellWithViewProperties
    • Check
    • CheckBase
    • CheckBase.LastRunStatusEnum
    • CheckBaseLinks
    • CheckDiscriminator
    • CheckPatch
    • CheckPatch.StatusEnum
    • Checks
    • CheckStatusLevel
    • CheckViewProperties
    • CheckViewProperties.ShapeEnum
    • CheckViewProperties.TypeEnum
    • ConditionalExpression
    • ConditionalExpression.ConditionalExpressionAlternateAdapter
    • ConditionalExpression.ConditionalExpressionConsequentAdapter
    • ConditionalExpression.ConditionalExpressionTestAdapter
    • Config
    • ConstantVariableProperties
    • ConstantVariableProperties.TypeEnum
    • CreateCell
    • CreateDashboardRequest
    • CustomCheck
    • CustomCheck.TypeEnum
    • Dashboard
    • DashboardColor
    • DashboardColor.TypeEnum
    • DashboardLinks
    • DashboardMeta
    • DashboardQuery
    • Dashboards
    • DashboardWithViewProperties
    • DateTimeLiteral
    • DBRP
    • DBRPCreate
    • DBRPGet
    • DBRPs
    • DBRPUpdate
    • DeadmanCheck
    • DeadmanCheck.TypeEnum
    • DecimalPlaces
    • DeletePredicateRequest
    • Dialect
    • Dialect.AnnotationsEnum
    • Dialect.DateTimeFormatEnum
    • DictExpression
    • DictItem
    • DictItem.DictItemKeyAdapter
    • DictItem.DictItemValAdapter
    • Duration
    • DurationLiteral
    • Error
    • Error.CodeEnum
    • Expression
    • ExpressionStatement
    • ExpressionStatement.ExpressionStatementExpressionAdapter
    • Field
    • Field.TypeEnum
    • File
    • File.FileBodyAdapter
    • FloatLiteral
    • FluxResponse
    • FluxSuggestion
    • FluxSuggestions
    • FunctionExpression
    • FunctionExpression.FunctionExpressionBodyAdapter
    • GaugeViewProperties
    • GaugeViewProperties.ShapeEnum
    • GaugeViewProperties.TypeEnum
    • GreaterThreshold
    • GreaterThreshold.TypeEnum
    • HealthCheck
    • HealthCheck.StatusEnum
    • HeatmapViewProperties
    • HeatmapViewProperties.ShapeEnum
    • HeatmapViewProperties.TypeEnum
    • HistogramViewProperties
    • HistogramViewProperties.PositionEnum
    • HistogramViewProperties.ShapeEnum
    • HistogramViewProperties.TypeEnum
    • HTTPNotificationEndpoint
    • HTTPNotificationEndpoint.AuthMethodEnum
    • HTTPNotificationEndpoint.MethodEnum
    • HTTPNotificationRule
    • HTTPNotificationRuleBase
    • HTTPNotificationRuleBase.TypeEnum
    • Identifier
    • ImportDeclaration
    • IndexExpression
    • IndexExpression.IndexExpressionArrayAdapter
    • IndexExpression.IndexExpressionIndexAdapter
    • IntegerLiteral
    • IsOnboarding
    • Label
    • LabelCreateRequest
    • LabelMapping
    • LabelResponse
    • LabelsResponse
    • LabelUpdate
    • LanguageRequest
    • LegacyAuthorizationPostRequest
    • LesserThreshold
    • LesserThreshold.TypeEnum
    • LinePlusSingleStatProperties
    • LinePlusSingleStatProperties.HoverDimensionEnum
    • LinePlusSingleStatProperties.PositionEnum
    • LinePlusSingleStatProperties.ShapeEnum
    • LinePlusSingleStatProperties.TypeEnum
    • LineProtocolError
    • LineProtocolError.CodeEnum
    • LineProtocolLengthError
    • LineProtocolLengthError.CodeEnum
    • Links
    • ListStacksResponse
    • LogEvent
    • LogicalExpression
    • LogicalExpression.LogicalExpressionLeftAdapter
    • LogicalExpression.LogicalExpressionRightAdapter
    • Logs
    • MapVariableProperties
    • MapVariableProperties.TypeEnum
    • MarkdownViewProperties
    • MarkdownViewProperties.ShapeEnum
    • MarkdownViewProperties.TypeEnum
    • MemberAssignment
    • MemberAssignment.MemberAssignmentInitAdapter
    • MemberExpression
    • MemberExpression.MemberExpressionObjectAdapter
    • MemberExpression.MemberExpressionPropertyAdapter
    • MetadataBackup
    • MosaicViewProperties
    • MosaicViewProperties.HoverDimensionEnum
    • MosaicViewProperties.ShapeEnum
    • MosaicViewProperties.TypeEnum
    • Node
    • NotificationEndpoint
    • NotificationEndpointBase
    • NotificationEndpointBase.StatusEnum
    • NotificationEndpointBaseLinks
    • NotificationEndpointDiscriminator
    • NotificationEndpoints
    • NotificationEndpointType
    • NotificationEndpointUpdate
    • NotificationEndpointUpdate.StatusEnum
    • NotificationRule
    • NotificationRuleBase
    • NotificationRuleBase.LastRunStatusEnum
    • NotificationRuleBaseLinks
    • NotificationRuleDiscriminator
    • NotificationRules
    • NotificationRuleUpdate
    • NotificationRuleUpdate.StatusEnum
    • ObjectExpression
    • OnboardingRequest
    • OnboardingResponse
    • OptionStatement
    • OptionStatement.OptionStatementAssignmentAdapter
    • Organization
    • Organization.StatusEnum
    • OrganizationLinks
    • Organizations
    • Package
    • PackageClause
    • PagerDutyNotificationEndpoint
    • PagerDutyNotificationRule
    • PagerDutyNotificationRuleBase
    • PagerDutyNotificationRuleBase.TypeEnum
    • ParenExpression
    • ParenExpression.ParenExpressionExpressionAdapter
    • PasswordResetBody
    • PatchBucketRequest
    • PatchDashboardRequest
    • PatchOrganizationRequest
    • PatchRetentionRule
    • PatchRetentionRule.TypeEnum
    • PatchStackRequest
    • PatchStackRequestAdditionalResources
    • Permission
    • Permission.ActionEnum
    • PermissionResource
    • PipeExpression
    • PipeExpression.PipeExpressionArgumentAdapter
    • PipeLiteral
    • PostBucketRequest
    • PostOrganizationRequest
    • PostRestoreKVResponse
    • PostStackRequest
    • PostUser
    • PostUser.StatusEnum
    • Property
    • Property.PropertyKeyAdapter
    • Property.PropertyValueAdapter
    • PropertyKey
    • Query
    • Query.TypeEnum
    • QueryEditMode
    • QueryVariableProperties
    • QueryVariableProperties.TypeEnum
    • QueryVariablePropertiesValues
    • RangeThreshold
    • RangeThreshold.TypeEnum
    • Ready
    • Ready.StatusEnum
    • RegexpLiteral
    • RemoteConnection
    • RemoteConnectionCreationRequest
    • RemoteConnections
    • RemoteConnectionUpdateRequest
    • RenamableField
    • Replication
    • ReplicationCreationRequest
    • Replications
    • ReplicationUpdateRequest
    • ResourceMember
    • ResourceMember.RoleEnum
    • ResourceMembers
    • ResourceOwner
    • ResourceOwner.RoleEnum
    • ResourceOwners
    • RestoredBucketMappings
    • RetentionPolicyManifest
    • ReturnStatement
    • ReturnStatement.ReturnStatementArgumentAdapter
    • Routes
    • RoutesExternal
    • RoutesQuery
    • RoutesSystem
    • RuleStatusLevel
    • Run
    • Run.StatusEnum
    • RunLinks
    • RunManually
    • Runs
    • ScatterViewProperties
    • ScatterViewProperties.ShapeEnum
    • ScatterViewProperties.TypeEnum
    • SchemaType
    • ScraperTargetRequest
    • ScraperTargetRequest.TypeEnum
    • ScraperTargetResponse
    • ScraperTargetResponseLinks
    • ScraperTargetResponses
    • Script
    • ScriptCreateRequest
    • ScriptInvocationParams
    • ScriptLanguage
    • Scripts
    • ScriptUpdateRequest
    • SecretKeys
    • SecretKeysResponse
    • SecretKeysResponseLinks
    • ShardGroupManifest
    • ShardManifest
    • ShardOwner
    • SimpleTableViewProperties
    • SimpleTableViewProperties.ShapeEnum
    • SimpleTableViewProperties.TypeEnum
    • SingleStatViewProperties
    • SingleStatViewProperties.ShapeEnum
    • SingleStatViewProperties.TypeEnum
    • SlackNotificationEndpoint
    • SlackNotificationRule
    • SlackNotificationRuleBase
    • SlackNotificationRuleBase.TypeEnum
    • SMTPNotificationRule
    • SMTPNotificationRuleBase
    • SMTPNotificationRuleBase.TypeEnum
    • Source
    • Source.LanguagesEnum
    • Source.TypeEnum
    • SourceLinks
    • Sources
    • Stack
    • StackAssociations
    • StackEvents
    • StackLinks
    • StackResources
    • Statement
    • StaticLegend
    • StatusRule
    • StringLiteral
    • SubscriptionManifest
    • TableViewProperties
    • TableViewProperties.ShapeEnum
    • TableViewProperties.TypeEnum
    • TableViewPropertiesTableOptions
    • TableViewPropertiesTableOptions.WrappingEnum
    • TagRule
    • TagRule.OperatorEnum
    • TaskCreateRequest
    • TaskLinks
    • Tasks
    • TaskStatusType
    • TaskType
    • TaskType.LastRunStatusEnum
    • TaskUpdateRequest
    • Telegraf
    • TelegrafLinks
    • TelegrafPlugin
    • TelegrafPlugin.TypeEnum
    • TelegrafPluginRequest
    • TelegrafPluginRequestPlugins
    • TelegrafPlugins
    • TelegrafRequest
    • TelegrafRequestMetadata
    • Telegrafs
    • TelegramNotificationEndpoint
    • TelegramNotificationRule
    • TelegramNotificationRuleBase
    • TelegramNotificationRuleBase.ParseModeEnum
    • TelegramNotificationRuleBase.TypeEnum
    • TemplateApply
    • TemplateApplyRemotes
    • TemplateApplyTemplate
    • TemplateChart
    • TemplateChart.TemplateChartPropertiesAdapter
    • TemplateExportByID
    • TemplateExportByIDOrgIDs
    • TemplateExportByIDResourceFilters
    • TemplateExportByIDResources
    • TemplateKind
    • TemplateSummary
    • TemplateSummaryDiff
    • TemplateSummaryDiffBuckets
    • TemplateSummaryDiffBucketsNewOld
    • TemplateSummaryDiffChecks
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksNewAdapter
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksOldAdapter
    • TemplateSummaryDiffDashboards
    • TemplateSummaryDiffDashboardsNewOld
    • TemplateSummaryDiffLabelMappings
    • TemplateSummaryDiffLabels
    • TemplateSummaryDiffLabelsNewOld
    • TemplateSummaryDiffNotificationEndpoints
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsNewAdapter
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsOldAdapter
    • TemplateSummaryDiffNotificationRules
    • TemplateSummaryDiffNotificationRulesNewOld
    • TemplateSummaryDiffTasks
    • TemplateSummaryDiffTasksNewOld
    • TemplateSummaryDiffTelegrafConfigs
    • TemplateSummaryDiffVariables
    • TemplateSummaryDiffVariablesNewOld
    • TemplateSummaryDiffVariablesNewOld.TemplateSummary_Diff_variables_new_oldArgsAdapter
    • TemplateSummaryErrors
    • TemplateSummaryLabel
    • TemplateSummaryLabelProperties
    • TemplateSummarySummary
    • TemplateSummarySummaryBuckets
    • TemplateSummarySummaryDashboards
    • TemplateSummarySummaryLabelMappings
    • TemplateSummarySummaryNotificationRules
    • TemplateSummarySummaryStatusRules
    • TemplateSummarySummaryTagRules
    • TemplateSummarySummaryTasks
    • TemplateSummarySummaryVariables
    • TemplateSummarySummaryVariables.TemplateSummary_summary_variablesArgumentsAdapter
    • TestStatement
    • Threshold
    • ThresholdBase
    • ThresholdCheck
    • ThresholdCheck.TypeEnum
    • ThresholdCheckTags
    • UnaryExpression
    • UnaryExpression.UnaryExpressionArgumentAdapter
    • UnsignedIntegerLiteral
    • User
    • User.StatusEnum
    • UserLinks
    • Users
    • UsersLinks
    • Variable
    • Variable.VariableArgumentsAdapter
    • VariableAssignment
    • VariableAssignment.VariableAssignmentInitAdapter
    • VariableLinks
    • VariableProperties
    • Variables
    • View
    • View.ViewPropertiesAdapter
    • ViewLinks
    • ViewProperties
    • Views
    • WritePrecision
    • XYGeom
    • XYViewProperties
    • XYViewProperties.HoverDimensionEnum
    • XYViewProperties.PositionEnum
    • XYViewProperties.ShapeEnum
    • XYViewProperties.TypeEnum
  • InfluxDB.Client.Api.Service
    • AuthorizationsService
    • BackupService
    • BucketsService
    • CellsService
    • ChecksService
    • ConfigService
    • DashboardsService
    • DBRPsService
    • DeleteService
    • HealthService
    • IAuthorizationsService
    • IBackupService
    • IBucketsService
    • ICellsService
    • IChecksService
    • IConfigService
    • IDashboardsService
    • IDBRPsService
    • IDeleteService
    • IHealthService
    • IInvokableScriptsService
    • ILabelsService
    • ILegacyAuthorizationsService
    • IMetricsService
    • INotificationEndpointsService
    • INotificationRulesService
    • InvokableScriptsService
    • IOrganizationsService
    • IPingService
    • IQueryService
    • IReadyService
    • IRemoteConnectionsService
    • IReplicationsService
    • IResourcesService
    • IRestoreService
    • IRoutesService
    • IRulesService
    • IScraperTargetsService
    • ISecretsService
    • ISetupService
    • ISigninService
    • ISignoutService
    • ISourcesService
    • ITasksService
    • ITelegrafPluginsService
    • ITelegrafsService
    • ITemplatesService
    • IUsersService
    • IVariablesService
    • IViewsService
    • IWriteService
    • LabelsService
    • LegacyAuthorizationsService
    • MetricsService
    • NotificationEndpointsService
    • NotificationRulesService
    • OrganizationsService
    • PingService
    • QueryService
    • ReadyService
    • RemoteConnectionsService
    • ReplicationsService
    • ResourcesService
    • RestoreService
    • RoutesService
    • RulesService
    • ScraperTargetsService
    • SecretsService
    • SetupService
    • SigninService
    • SignoutService
    • SourcesService
    • TasksService
    • TelegrafPluginsService
    • TelegrafsService
    • TemplatesService
    • UsersService
    • VariablesService
    • ViewsService
    • WriteService
  • InfluxDB.Client.Core
    • Arguments
    • Column
    • LogLevel
    • Measurement
  • InfluxDB.Client.Core.Exceptions
    • BadGatewayException
    • BadRequestException
    • ForbiddenException
    • HttpException
    • HttpNotImplementedException
    • InfluxException
    • InternalServerErrorException
    • MethodNotAllowedException
    • NotAcceptableException
    • NotFoundException
    • PaymentRequiredException
    • ProxyAuthenticationRequiredException
    • RequestEntityTooLargeException
    • RequestTimeoutException
    • ServiceUnavailableException
    • TooManyRequestsException
    • UnauthorizedException
    • UnprocessableEntityException
  • InfluxDB.Client.Core.Flux.Domain
    • FluxColumn
    • FluxRecord
    • FluxTable
  • InfluxDB.Client.Core.Flux.Exceptions
    • FluxCsvParserException
    • FluxQueryException
  • InfluxDB.Client.Core.Flux.Serialization
    • AnnotatedCsvParser
    • IAnnotatedCsvParser
  • InfluxDB.Client.Domain
    • FindOptions
  • InfluxDB.Client.Flux
    • FluxClient
    • FluxClientFactory
    • FluxConnectionOptions
    • FluxConnectionOptions.AuthenticationType
    • IFluxClient
  • InfluxDB.Client.Linq
    • DefaultMemberNameResolver
    • IMemberNameResolver
    • InfluxDBQueryable<T>
    • MemberType
    • QueryableExtensions
    • QueryableOptimizerSettings
  • InfluxDB.Client.Writes
    • AbstractWriteEvent
    • InfluxDBEventArgs
    • PointData
    • PointData.Builder
    • PointSettings
    • WriteErrorEvent
    • WriteRetriableErrorEvent
    • WriteRuntimeExceptionEvent
    • WriteSuccessEvent

Class QueryService

Represents a collection of functions to interact with the API endpoints

Inheritance
System.Object
QueryService
Implements
IQueryService
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class QueryService : object, IQueryService, IApiAccessor

Constructors

QueryService(Configuration)

Initializes a new instance of the QueryService class using Configuration object

Declaration
public QueryService(Configuration configuration = null)
Parameters
Type Name Description
InfluxDB.Client.Api.Client.Configuration configuration

An instance of Configuration

QueryService(String)

Initializes a new instance of the QueryService class.

Declaration
public QueryService(string basePath)
Parameters
Type Name Description
System.String basePath

Properties

Configuration

Gets or sets the configuration object

Declaration
public Configuration Configuration { get; set; }
Property Value
Type Description
InfluxDB.Client.Api.Client.Configuration

An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration
public void AddDefaultHeader(string key, string value)
Parameters
Type Name Description
System.String key

Header field name.

System.String value

Header field value.

DefaultHeader()

Gets the default header.

Declaration
public IDictionary<string, string> DefaultHeader()
Returns
Type Description
IDictionary<System.String, System.String>

Dictionary of HTTP header

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
System.String

The base path

GetQuerySuggestions(String)

Retrieve query suggestions

Declaration
public FluxSuggestions GetQuerySuggestions(string zapTraceSpan = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
FluxSuggestions

FluxSuggestions

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsAsync(String, CancellationToken)

Retrieve query suggestions

Declaration
public async System.Threading.Tasks.Task<FluxSuggestions> GetQuerySuggestionsAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<FluxSuggestions>

Task of FluxSuggestions

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsAsyncWithHttpInfo(String, CancellationToken)

Retrieve query suggestions

Declaration
public async System.Threading.Tasks.Task<ApiResponse<FluxSuggestions>> GetQuerySuggestionsAsyncWithHttpInfo(string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<FluxSuggestions>>

Task of ApiResponse (FluxSuggestions)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsAsyncWithIRestResponse(String, CancellationToken)

Retrieve query suggestions

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetQuerySuggestionsAsyncWithIRestResponse(string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (FluxSuggestions)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsName(String, String)

Retrieve query suggestions for a branching suggestion

Declaration
public FluxSuggestion GetQuerySuggestionsName(string name, string zapTraceSpan = null)
Parameters
Type Name Description
System.String name

The name of the branching suggestion.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
FluxSuggestion

FluxSuggestion

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsNameAsync(String, String, CancellationToken)

Retrieve query suggestions for a branching suggestion

Declaration
public async System.Threading.Tasks.Task<FluxSuggestion> GetQuerySuggestionsNameAsync(string name, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

The name of the branching suggestion.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<FluxSuggestion>

Task of FluxSuggestion

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsNameAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve query suggestions for a branching suggestion

Declaration
public async System.Threading.Tasks.Task<ApiResponse<FluxSuggestion>> GetQuerySuggestionsNameAsyncWithHttpInfo(string name, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

The name of the branching suggestion.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<FluxSuggestion>>

Task of ApiResponse (FluxSuggestion)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsNameAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve query suggestions for a branching suggestion

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetQuerySuggestionsNameAsyncWithIRestResponse(string name, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

The name of the branching suggestion.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (FluxSuggestion)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsNameWithHttpInfo(String, String)

Retrieve query suggestions for a branching suggestion

Declaration
public ApiResponse<FluxSuggestion> GetQuerySuggestionsNameWithHttpInfo(string name, string zapTraceSpan = null)
Parameters
Type Name Description
System.String name

The name of the branching suggestion.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<FluxSuggestion>

ApiResponse of FluxSuggestion

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsNameWithIRestResponse(String, String)

Retrieve query suggestions for a branching suggestion

Declaration
public RestResponse GetQuerySuggestionsNameWithIRestResponse(string name, string zapTraceSpan = null)
Parameters
Type Name Description
System.String name

The name of the branching suggestion.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of FluxSuggestion

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsNameWithIRestResponseAsync(String, String, CancellationToken)

Retrieve query suggestions for a branching suggestion

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetQuerySuggestionsNameWithIRestResponseAsync(string name, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

The name of the branching suggestion.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of FluxSuggestion

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsNameWithRestRequest(String, String)

Retrieve query suggestions for a branching suggestion

Declaration
public RestRequest GetQuerySuggestionsNameWithRestRequest(string name, string zapTraceSpan = null)
Parameters
Type Name Description
System.String name

The name of the branching suggestion.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of FluxSuggestion

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsWithHttpInfo(String)

Retrieve query suggestions

Declaration
public ApiResponse<FluxSuggestions> GetQuerySuggestionsWithHttpInfo(string zapTraceSpan = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<FluxSuggestions>

ApiResponse of FluxSuggestions

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsWithIRestResponse(String)

Retrieve query suggestions

Declaration
public RestResponse GetQuerySuggestionsWithIRestResponse(string zapTraceSpan = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of FluxSuggestions

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsWithIRestResponseAsync(String, CancellationToken)

Retrieve query suggestions

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetQuerySuggestionsWithIRestResponseAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of FluxSuggestions

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetQuerySuggestionsWithRestRequest(String)

Retrieve query suggestions

Declaration
public RestRequest GetQuerySuggestionsWithRestRequest(string zapTraceSpan = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of FluxSuggestions

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQuery(String, String, String, String, String, Query)

Query data Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Declaration
public string PostQuery(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String acceptEncoding

Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

System.String contentType

(optional)

System.String org

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)

System.String orgID

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)

Query query

Flux query or specification to execute (optional)

Returns
Type Description
System.String

string

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAnalyze(String, String, Query)

Analyze a Flux query

Declaration
public AnalyzeQueryResponse PostQueryAnalyze(string zapTraceSpan = null, string contentType = null, Query query = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

Query query

Flux query to analyze (optional)

Returns
Type Description
AnalyzeQueryResponse

AnalyzeQueryResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAnalyzeAsync(String, String, Query, CancellationToken)

Analyze a Flux query

Declaration
public async System.Threading.Tasks.Task<AnalyzeQueryResponse> PostQueryAnalyzeAsync(string zapTraceSpan = null, string contentType = null, Query query = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

Query query

Flux query to analyze (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<AnalyzeQueryResponse>

Task of AnalyzeQueryResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAnalyzeAsyncWithHttpInfo(String, String, Query, CancellationToken)

Analyze a Flux query

Declaration
public async System.Threading.Tasks.Task<ApiResponse<AnalyzeQueryResponse>> PostQueryAnalyzeAsyncWithHttpInfo(string zapTraceSpan = null, string contentType = null, Query query = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

Query query

Flux query to analyze (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<AnalyzeQueryResponse>>

Task of ApiResponse (AnalyzeQueryResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAnalyzeAsyncWithIRestResponse(String, String, Query, CancellationToken)

Analyze a Flux query

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostQueryAnalyzeAsyncWithIRestResponse(string zapTraceSpan = null, string contentType = null, Query query = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

Query query

Flux query to analyze (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (AnalyzeQueryResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAnalyzeWithHttpInfo(String, String, Query)

Analyze a Flux query

Declaration
public ApiResponse<AnalyzeQueryResponse> PostQueryAnalyzeWithHttpInfo(string zapTraceSpan = null, string contentType = null, Query query = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

Query query

Flux query to analyze (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<AnalyzeQueryResponse>

ApiResponse of AnalyzeQueryResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAnalyzeWithIRestResponse(String, String, Query)

Analyze a Flux query

Declaration
public RestResponse PostQueryAnalyzeWithIRestResponse(string zapTraceSpan = null, string contentType = null, Query query = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

Query query

Flux query to analyze (optional)

Returns
Type Description
RestResponse

ApiResponse of AnalyzeQueryResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAnalyzeWithIRestResponseAsync(String, String, Query, CancellationToken)

Analyze a Flux query

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostQueryAnalyzeWithIRestResponseAsync(string zapTraceSpan = null, string contentType = null, Query query = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

Query query

Flux query to analyze (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of AnalyzeQueryResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAnalyzeWithRestRequest(String, String, Query)

Analyze a Flux query

Declaration
public RestRequest PostQueryAnalyzeWithRestRequest(string zapTraceSpan = null, string contentType = null, Query query = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

Query query

Flux query to analyze (optional)

Returns
Type Description
RestRequest

ApiResponse of AnalyzeQueryResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAst(String, String, LanguageRequest)

Generate an Abstract Syntax Tree (AST) from a query Analyzes flux query and generates a query specification.

Declaration
public ASTResponse PostQueryAst(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

LanguageRequest languageRequest

Analyzed Flux query to generate abstract syntax tree. (optional)

Returns
Type Description
ASTResponse

ASTResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAstAsync(String, String, LanguageRequest, CancellationToken)

Generate an Abstract Syntax Tree (AST) from a query Analyzes flux query and generates a query specification.

Declaration
public async System.Threading.Tasks.Task<ASTResponse> PostQueryAstAsync(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

LanguageRequest languageRequest

Analyzed Flux query to generate abstract syntax tree. (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<ASTResponse>

Task of ASTResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAstAsyncWithHttpInfo(String, String, LanguageRequest, CancellationToken)

Generate an Abstract Syntax Tree (AST) from a query Analyzes flux query and generates a query specification.

Declaration
public async System.Threading.Tasks.Task<ApiResponse<ASTResponse>> PostQueryAstAsyncWithHttpInfo(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

LanguageRequest languageRequest

Analyzed Flux query to generate abstract syntax tree. (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ASTResponse>>

Task of ApiResponse (ASTResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAstAsyncWithIRestResponse(String, String, LanguageRequest, CancellationToken)

Generate an Abstract Syntax Tree (AST) from a query Analyzes flux query and generates a query specification.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostQueryAstAsyncWithIRestResponse(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

LanguageRequest languageRequest

Analyzed Flux query to generate abstract syntax tree. (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (ASTResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAstWithHttpInfo(String, String, LanguageRequest)

Generate an Abstract Syntax Tree (AST) from a query Analyzes flux query and generates a query specification.

Declaration
public ApiResponse<ASTResponse> PostQueryAstWithHttpInfo(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

LanguageRequest languageRequest

Analyzed Flux query to generate abstract syntax tree. (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<ASTResponse>

ApiResponse of ASTResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAstWithIRestResponse(String, String, LanguageRequest)

Generate an Abstract Syntax Tree (AST) from a query Analyzes flux query and generates a query specification.

Declaration
public RestResponse PostQueryAstWithIRestResponse(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

LanguageRequest languageRequest

Analyzed Flux query to generate abstract syntax tree. (optional)

Returns
Type Description
RestResponse

ApiResponse of ASTResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAstWithIRestResponseAsync(String, String, LanguageRequest, CancellationToken)

Generate an Abstract Syntax Tree (AST) from a query Analyzes flux query and generates a query specification.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostQueryAstWithIRestResponseAsync(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

LanguageRequest languageRequest

Analyzed Flux query to generate abstract syntax tree. (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of ASTResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAstWithRestRequest(String, String, LanguageRequest)

Generate an Abstract Syntax Tree (AST) from a query Analyzes flux query and generates a query specification.

Declaration
public RestRequest PostQueryAstWithRestRequest(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String contentType

(optional)

LanguageRequest languageRequest

Analyzed Flux query to generate abstract syntax tree. (optional)

Returns
Type Description
RestRequest

ApiResponse of ASTResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAsync(String, String, String, String, String, Query, CancellationToken)

Query data Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Declaration
public async System.Threading.Tasks.Task<string> PostQueryAsync(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String acceptEncoding

Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

System.String contentType

(optional)

System.String org

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)

System.String orgID

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)

Query query

Flux query or specification to execute (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<System.String>

Task of string

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAsyncWithHttpInfo(String, String, String, String, String, Query, CancellationToken)

Query data Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Declaration
public async System.Threading.Tasks.Task<ApiResponse<string>> PostQueryAsyncWithHttpInfo(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String acceptEncoding

Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

System.String contentType

(optional)

System.String org

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)

System.String orgID

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)

Query query

Flux query or specification to execute (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.String>>

Task of ApiResponse (string)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryAsyncWithIRestResponse(String, String, String, String, String, Query, CancellationToken)

Query data Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostQueryAsyncWithIRestResponse(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String acceptEncoding

Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

System.String contentType

(optional)

System.String org

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)

System.String orgID

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)

Query query

Flux query or specification to execute (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

Task of RestResponse (string)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryWithHttpInfo(String, String, String, String, String, Query)

Query data Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Declaration
public ApiResponse<string> PostQueryWithHttpInfo(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String acceptEncoding

Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

System.String contentType

(optional)

System.String org

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)

System.String orgID

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)

Query query

Flux query or specification to execute (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<System.String>

ApiResponse of string

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryWithIRestResponse(String, String, String, String, String, Query)

Query data Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Declaration
public RestResponse PostQueryWithIRestResponse(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String acceptEncoding

Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

System.String contentType

(optional)

System.String org

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)

System.String orgID

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)

Query query

Flux query or specification to execute (optional)

Returns
Type Description
RestResponse

ApiResponse of string

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryWithIRestResponseAsync(String, String, String, String, String, Query, CancellationToken)

Query data Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostQueryWithIRestResponseAsync(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String acceptEncoding

Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

System.String contentType

(optional)

System.String org

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)

System.String orgID

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)

Query query

Flux query or specification to execute (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<RestResponse>

ApiResponse of string

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostQueryWithRestRequest(String, String, String, String, String, Query)

Query data Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Declaration
public RestRequest PostQueryWithRestRequest(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String acceptEncoding

Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)

System.String contentType

(optional)

System.String org

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)

System.String orgID

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)

Query query

Flux query or specification to execute (optional)

Returns
Type Description
RestRequest

ApiResponse of string

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

SetBasePath(String)

Sets the base path of the API client.

Declaration
public void SetBasePath(string basePath)
Parameters
Type Name Description
System.String basePath

Implements

IQueryService
In This Article
Back to top Generated by DocFX