Function createDirectAccessAgentBenchmark

  • Starts a background benchmark task that measures the throughput and latency of a Direct Access agent. Use the returned benchmarkId to monitor progress and retrieve performance metrics for capacity planning or performance optimization. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

    Parameters

    • agentId: string

      The agent ID

    • query: {
          description?: string;
          force?: boolean;
          gigaBytesToTransfer?: number;
          name?: string;
      }

      an object with query parameters

      • Optionaldescription?: string

        The description for the benchmark task.

      • Optionalforce?: boolean

        Forces the benchmark to start regardless of the state of the agent. Does not override QCS resource limits. Use with caution.

      • OptionalgigaBytesToTransfer?: number

        The volume of data in GB to transfer during the throughput measurement part of the benchmark.

      • Optionalname?: string

        The name to assign to the benchmark task.

    • Optionaloptions: ApiCallOptions

    Returns Promise<CreateDirectAccessAgentBenchmarkHttpResponse>

    CreateDirectAccessAgentBenchmarkHttpError

Settings
Member Visibility