Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. tls
  6. DownloadTask
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.tls.DownloadTask

volcenginecc logo
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Log download task, used to export log data retrieved from a log topic as a file for user download.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const example = new volcenginecc.tls.DownloadTask("Example", {
    topicId: "22fca26e-xxxxx-a3ca-a9bb6d3fb9bd",
    taskName: "task-saie",
    query: "",
    startTime: 1767196800000,
    endTime: 1783585260783,
    compression: "gzip",
    dataFormat: "json",
    limit: 2000,
    sort: "desc",
    taskType: 0,
    allowIncomplete: false,
    logContextInfos: {
        source: "",
        context_flow: "",
        package_offset: 0,
    },
    mustComplete: true,
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

example = volcenginecc.tls.DownloadTask("Example",
    topic_id="22fca26e-xxxxx-a3ca-a9bb6d3fb9bd",
    task_name="task-saie",
    query="",
    start_time=int(1767196800000),
    end_time=int(1783585260783),
    compression="gzip",
    data_format="json",
    limit=2000,
    sort="desc",
    task_type=0,
    allow_incomplete=False,
    log_context_infos={
        "source": "",
        "context_flow": "",
        "package_offset": 0,
    },
    must_complete=True)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tls"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.NewDownloadTask(ctx, "Example", &tls.DownloadTaskArgs{
			TopicId:         pulumi.String("22fca26e-xxxxx-a3ca-a9bb6d3fb9bd"),
			TaskName:        pulumi.String("task-saie"),
			Query:           pulumi.String(""),
			StartTime:       pulumi.Int(1767196800000),
			EndTime:         pulumi.Int(1783585260783),
			Compression:     pulumi.String("gzip"),
			DataFormat:      pulumi.String("json"),
			Limit:           pulumi.Int(2000),
			Sort:            pulumi.String("desc"),
			TaskType:        pulumi.Int(0),
			AllowIncomplete: pulumi.Bool(false),
			LogContextInfos: &tls.DownloadTaskLogContextInfosArgs{
				Source:         pulumi.String(""),
				Context_flow:   "",
				Package_offset: 0,
			},
			MustComplete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var example = new Volcenginecc.Tls.DownloadTask("Example", new()
    {
        TopicId = "22fca26e-xxxxx-a3ca-a9bb6d3fb9bd",
        TaskName = "task-saie",
        Query = "",
        StartTime = 1767196800000,
        EndTime = 1783585260783,
        Compression = "gzip",
        DataFormat = "json",
        Limit = 2000,
        Sort = "desc",
        TaskType = 0,
        AllowIncomplete = false,
        LogContextInfos = new Volcenginecc.Tls.Inputs.DownloadTaskLogContextInfosArgs
        {
            Source = "",
            Context_flow = "",
            Package_offset = 0,
        },
        MustComplete = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.tls.DownloadTask;
import com.volcengine.volcenginecc.tls.DownloadTaskArgs;
import com.pulumi.volcenginecc.tls.inputs.DownloadTaskLogContextInfosArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DownloadTask("example", DownloadTaskArgs.builder()
            .topicId("22fca26e-xxxxx-a3ca-a9bb6d3fb9bd")
            .taskName("task-saie")
            .query("")
            .startTime(1767196800000)
            .endTime(1783585260783)
            .compression("gzip")
            .dataFormat("json")
            .limit(2000)
            .sort("desc")
            .taskType(0)
            .allowIncomplete(false)
            .logContextInfos(DownloadTaskLogContextInfosArgs.builder()
                .source("")
                .context_flow("")
                .package_offset(0)
                .build())
            .mustComplete(true)
            .build());

    }
}

    resources:
  example:
    type: volcenginecc:tls:DownloadTask
    name: Example
    properties:
      topicId: 22fca26e-xxxxx-a3ca-a9bb6d3fb9bd
      taskName: task-saie
      query: ""
      startTime: 1.7671968e+12
      endTime: 1.783585260783e+12
      compression: gzip
      dataFormat: json
      limit: 2000
      sort: desc
      taskType: 0
      allowIncomplete: false
      logContextInfos:
        source: ""
        context_flow: ""
        package_offset: 0
      mustComplete: true

    pulumi {
  required_providers {
    volcenginecc = {
      source = "pulumi/volcenginecc"
    }
  }
}

resource "volcenginecc_tls_downloadtask" "Example" {
  topic_id         = "22fca26e-xxxxx-a3ca-a9bb6d3fb9bd"
  task_name        = "task-saie"
  query            = ""
  start_time       = 1767196800000
  end_time         = 1783585260783
  compression      = "gzip"
  data_format      = "json"
  limit            = 2000
  sort             = "desc"
  task_type        = 0
  allow_incomplete = false
  log_context_infos = {
    source         = ""
    context_flow   = ""
    package_offset = 0
  }
  must_complete = true
}

    Create DownloadTask Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DownloadTask(name: string, args: DownloadTaskArgs, opts?: CustomResourceOptions);
    @overload
def DownloadTask(resource_name: str,
                 args: DownloadTaskArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def DownloadTask(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 sort: Optional[str] = None,
                 task_name: Optional[str] = None,
                 data_format: Optional[str] = None,
                 end_time: Optional[int] = None,
                 topic_id: Optional[str] = None,
                 limit: Optional[int] = None,
                 compression: Optional[str] = None,
                 start_time: Optional[int] = None,
                 end_time_str: Optional[str] = None,
                 allow_incomplete: Optional[bool] = None,
                 must_complete: Optional[bool] = None,
                 start_time_str: Optional[str] = None,
                 log_context_infos: Optional[DownloadTaskLogContextInfosArgs] = None,
                 task_type: Optional[int] = None,
                 query: Optional[str] = None)
    func NewDownloadTask(ctx *Context, name string, args DownloadTaskArgs, opts ...ResourceOption) (*DownloadTask, error)
    public DownloadTask(string name, DownloadTaskArgs args, CustomResourceOptions? opts = null)
    public DownloadTask(String name, DownloadTaskArgs args)
public DownloadTask(String name, DownloadTaskArgs args, CustomResourceOptions options)

    type: volcenginecc:tls:DownloadTask
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_tls_download_task" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DownloadTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DownloadTaskArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DownloadTaskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DownloadTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DownloadTaskArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var downloadTaskResource = new Volcenginecc.Tls.DownloadTask("downloadTaskResource", new()
{
    Sort = "string",
    TaskName = "string",
    DataFormat = "string",
    EndTime = 0,
    TopicId = "string",
    Limit = 0,
    Compression = "string",
    StartTime = 0,
    EndTimeStr = "string",
    AllowIncomplete = false,
    MustComplete = false,
    StartTimeStr = "string",
    LogContextInfos = new Volcenginecc.Tls.Inputs.DownloadTaskLogContextInfosArgs
    {
        ContextFlow = "string",
        PackageOffset = 0,
        Source = "string",
    },
    TaskType = 0,
    Query = "string",
});

    example, err := tls.NewDownloadTask(ctx, "downloadTaskResource", &tls.DownloadTaskArgs{
	Sort:            pulumi.String("string"),
	TaskName:        pulumi.String("string"),
	DataFormat:      pulumi.String("string"),
	EndTime:         pulumi.Int(0),
	TopicId:         pulumi.String("string"),
	Limit:           pulumi.Int(0),
	Compression:     pulumi.String("string"),
	StartTime:       pulumi.Int(0),
	EndTimeStr:      pulumi.String("string"),
	AllowIncomplete: pulumi.Bool(false),
	MustComplete:    pulumi.Bool(false),
	StartTimeStr:    pulumi.String("string"),
	LogContextInfos: &tls.DownloadTaskLogContextInfosArgs{
		ContextFlow:   pulumi.String("string"),
		PackageOffset: pulumi.Int(0),
		Source:        pulumi.String("string"),
	},
	TaskType: pulumi.Int(0),
	Query:    pulumi.String("string"),
})

    resource "volcenginecc_tls_download_task" "downloadTaskResource" {
  lifecycle {
    create_before_destroy = true
  }
  sort             = "string"
  task_name        = "string"
  data_format      = "string"
  end_time         = 0
  topic_id         = "string"
  limit            = 0
  compression      = "string"
  start_time       = 0
  end_time_str     = "string"
  allow_incomplete = false
  must_complete    = false
  start_time_str   = "string"
  log_context_infos = {
    context_flow   = "string"
    package_offset = 0
    source         = "string"
  }
  task_type = 0
  query     = "string"
}

    var downloadTaskResource = new DownloadTask("downloadTaskResource", DownloadTaskArgs.builder()
    .sort("string")
    .taskName("string")
    .dataFormat("string")
    .endTime(0)
    .topicId("string")
    .limit(0)
    .compression("string")
    .startTime(0)
    .endTimeStr("string")
    .allowIncomplete(false)
    .mustComplete(false)
    .startTimeStr("string")
    .logContextInfos(DownloadTaskLogContextInfosArgs.builder()
        .contextFlow("string")
        .packageOffset(0)
        .source("string")
        .build())
    .taskType(0)
    .query("string")
    .build());

    download_task_resource = volcenginecc.tls.DownloadTask("downloadTaskResource",
    sort="string",
    task_name="string",
    data_format="string",
    end_time=0,
    topic_id="string",
    limit=0,
    compression="string",
    start_time=0,
    end_time_str="string",
    allow_incomplete=False,
    must_complete=False,
    start_time_str="string",
    log_context_infos={
        "context_flow": "string",
        "package_offset": 0,
        "source": "string",
    },
    task_type=0,
    query="string")

    const downloadTaskResource = new volcenginecc.tls.DownloadTask("downloadTaskResource", {
    sort: "string",
    taskName: "string",
    dataFormat: "string",
    endTime: 0,
    topicId: "string",
    limit: 0,
    compression: "string",
    startTime: 0,
    endTimeStr: "string",
    allowIncomplete: false,
    mustComplete: false,
    startTimeStr: "string",
    logContextInfos: {
        contextFlow: "string",
        packageOffset: 0,
        source: "string",
    },
    taskType: 0,
    query: "string",
});

    type: volcenginecc:tls:DownloadTask
properties:
    allowIncomplete: false
    compression: string
    dataFormat: string
    endTime: 0
    endTimeStr: string
    limit: 0
    logContextInfos:
        contextFlow: string
        packageOffset: 0
        source: string
    mustComplete: false
    query: string
    sort: string
    startTime: 0
    startTimeStr: string
    taskName: string
    taskType: 0
    topicId: string

    DownloadTask Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DownloadTask resource accepts the following input properties:

    Compression string
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    DataFormat string
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    EndTime int
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    Limit int
    Number of original log entries downloaded, or number of rows in the analysis result.
    Sort string
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    StartTime int
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    TaskName string
    Download task name. Length range: 1–63 characters.
    TopicId string
    Log topic ID to which the download task belongs.
    AllowIncomplete bool
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    EndTimeStr string
    Query end time.
    LogContextInfos Volcengine.DownloadTaskLogContextInfos
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    MustComplete bool
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    Query string
    Query statement for analysis, with a maximum length of 4 KiB.
    StartTimeStr string
    Query start time.
    TaskType int
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    Compression string
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    DataFormat string
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    EndTime int
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    Limit int
    Number of original log entries downloaded, or number of rows in the analysis result.
    Sort string
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    StartTime int
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    TaskName string
    Download task name. Length range: 1–63 characters.
    TopicId string
    Log topic ID to which the download task belongs.
    AllowIncomplete bool
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    EndTimeStr string
    Query end time.
    LogContextInfos DownloadTaskLogContextInfosArgs
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    MustComplete bool
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    Query string
    Query statement for analysis, with a maximum length of 4 KiB.
    StartTimeStr string
    Query start time.
    TaskType int
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    compression string
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    data_format string
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    end_time number
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    limit number
    Number of original log entries downloaded, or number of rows in the analysis result.
    sort string
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    start_time number
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    task_name string
    Download task name. Length range: 1–63 characters.
    topic_id string
    Log topic ID to which the download task belongs.
    allow_incomplete bool
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    end_time_str string
    Query end time.
    log_context_infos object
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    must_complete bool
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query string
    Query statement for analysis, with a maximum length of 4 KiB.
    start_time_str string
    Query start time.
    task_type number
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    compression String
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    dataFormat String
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    endTime Integer
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    limit Integer
    Number of original log entries downloaded, or number of rows in the analysis result.
    sort String
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    startTime Integer
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    taskName String
    Download task name. Length range: 1–63 characters.
    topicId String
    Log topic ID to which the download task belongs.
    allowIncomplete Boolean
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    endTimeStr String
    Query end time.
    logContextInfos DownloadTaskLogContextInfos
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    mustComplete Boolean
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query String
    Query statement for analysis, with a maximum length of 4 KiB.
    startTimeStr String
    Query start time.
    taskType Integer
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    compression string
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    dataFormat string
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    endTime number
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    limit number
    Number of original log entries downloaded, or number of rows in the analysis result.
    sort string
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    startTime number
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    taskName string
    Download task name. Length range: 1–63 characters.
    topicId string
    Log topic ID to which the download task belongs.
    allowIncomplete boolean
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    endTimeStr string
    Query end time.
    logContextInfos DownloadTaskLogContextInfos
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    mustComplete boolean
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query string
    Query statement for analysis, with a maximum length of 4 KiB.
    startTimeStr string
    Query start time.
    taskType number
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    compression str
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    data_format str
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    end_time int
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    limit int
    Number of original log entries downloaded, or number of rows in the analysis result.
    sort str
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    start_time int
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    task_name str
    Download task name. Length range: 1–63 characters.
    topic_id str
    Log topic ID to which the download task belongs.
    allow_incomplete bool
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    end_time_str str
    Query end time.
    log_context_infos DownloadTaskLogContextInfosArgs
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    must_complete bool
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query str
    Query statement for analysis, with a maximum length of 4 KiB.
    start_time_str str
    Query start time.
    task_type int
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    compression String
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    dataFormat String
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    endTime Number
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    limit Number
    Number of original log entries downloaded, or number of rows in the analysis result.
    sort String
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    startTime Number
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    taskName String
    Download task name. Length range: 1–63 characters.
    topicId String
    Log topic ID to which the download task belongs.
    allowIncomplete Boolean
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    endTimeStr String
    Query end time.
    logContextInfos Property Map
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    mustComplete Boolean
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query String
    Query statement for analysis, with a maximum length of 4 KiB.
    startTimeStr String
    Query start time.
    taskType Number
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DownloadTask resource produces the following output properties:

    CreateTime string
    Download task creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    LogCount int
    Number of log entries included in the download task.
    LogSize int
    Total size of logs included in the download task, in bytes.
    TaskId string
    Download task ID.
    TaskStatus string
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    CreateTime string
    Download task creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    LogCount int
    Number of log entries included in the download task.
    LogSize int
    Total size of logs included in the download task, in bytes.
    TaskId string
    Download task ID.
    TaskStatus string
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    create_time string
    Download task creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    log_count number
    Number of log entries included in the download task.
    log_size number
    Total size of logs included in the download task, in bytes.
    task_id string
    Download task ID.
    task_status string
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    createTime String
    Download task creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    logCount Integer
    Number of log entries included in the download task.
    logSize Integer
    Total size of logs included in the download task, in bytes.
    taskId String
    Download task ID.
    taskStatus String
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    createTime string
    Download task creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    logCount number
    Number of log entries included in the download task.
    logSize number
    Total size of logs included in the download task, in bytes.
    taskId string
    Download task ID.
    taskStatus string
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    create_time str
    Download task creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    log_count int
    Number of log entries included in the download task.
    log_size int
    Total size of logs included in the download task, in bytes.
    task_id str
    Download task ID.
    task_status str
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    createTime String
    Download task creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    logCount Number
    Number of log entries included in the download task.
    logSize Number
    Total size of logs included in the download task, in bytes.
    taskId String
    Download task ID.
    taskStatus String
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.

    Look up Existing DownloadTask Resource

    Get an existing DownloadTask resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DownloadTaskState, opts?: CustomResourceOptions): DownloadTask
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_incomplete: Optional[bool] = None,
        compression: Optional[str] = None,
        create_time: Optional[str] = None,
        data_format: Optional[str] = None,
        end_time: Optional[int] = None,
        end_time_str: Optional[str] = None,
        limit: Optional[int] = None,
        log_context_infos: Optional[DownloadTaskLogContextInfosArgs] = None,
        log_count: Optional[int] = None,
        log_size: Optional[int] = None,
        must_complete: Optional[bool] = None,
        query: Optional[str] = None,
        sort: Optional[str] = None,
        start_time: Optional[int] = None,
        start_time_str: Optional[str] = None,
        task_id: Optional[str] = None,
        task_name: Optional[str] = None,
        task_status: Optional[str] = None,
        task_type: Optional[int] = None,
        topic_id: Optional[str] = None) -> DownloadTask
    func GetDownloadTask(ctx *Context, name string, id IDInput, state *DownloadTaskState, opts ...ResourceOption) (*DownloadTask, error)
    public static DownloadTask Get(string name, Input<string> id, DownloadTaskState? state, CustomResourceOptions? opts = null)
    public static DownloadTask get(String name, Output<String> id, DownloadTaskState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:tls:DownloadTask    get:      id: ${id}
    import {
  to = volcenginecc_tls_download_task.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowIncomplete bool
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    Compression string
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    CreateTime string
    Download task creation time.
    DataFormat string
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    EndTime int
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    EndTimeStr string
    Query end time.
    Limit int
    Number of original log entries downloaded, or number of rows in the analysis result.
    LogContextInfos Volcengine.DownloadTaskLogContextInfos
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    LogCount int
    Number of log entries included in the download task.
    LogSize int
    Total size of logs included in the download task, in bytes.
    MustComplete bool
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    Query string
    Query statement for analysis, with a maximum length of 4 KiB.
    Sort string
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    StartTime int
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    StartTimeStr string
    Query start time.
    TaskId string
    Download task ID.
    TaskName string
    Download task name. Length range: 1–63 characters.
    TaskStatus string
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    TaskType int
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    TopicId string
    Log topic ID to which the download task belongs.
    AllowIncomplete bool
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    Compression string
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    CreateTime string
    Download task creation time.
    DataFormat string
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    EndTime int
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    EndTimeStr string
    Query end time.
    Limit int
    Number of original log entries downloaded, or number of rows in the analysis result.
    LogContextInfos DownloadTaskLogContextInfosArgs
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    LogCount int
    Number of log entries included in the download task.
    LogSize int
    Total size of logs included in the download task, in bytes.
    MustComplete bool
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    Query string
    Query statement for analysis, with a maximum length of 4 KiB.
    Sort string
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    StartTime int
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    StartTimeStr string
    Query start time.
    TaskId string
    Download task ID.
    TaskName string
    Download task name. Length range: 1–63 characters.
    TaskStatus string
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    TaskType int
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    TopicId string
    Log topic ID to which the download task belongs.
    allow_incomplete bool
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    compression string
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    create_time string
    Download task creation time.
    data_format string
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    end_time number
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    end_time_str string
    Query end time.
    limit number
    Number of original log entries downloaded, or number of rows in the analysis result.
    log_context_infos object
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    log_count number
    Number of log entries included in the download task.
    log_size number
    Total size of logs included in the download task, in bytes.
    must_complete bool
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query string
    Query statement for analysis, with a maximum length of 4 KiB.
    sort string
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    start_time number
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    start_time_str string
    Query start time.
    task_id string
    Download task ID.
    task_name string
    Download task name. Length range: 1–63 characters.
    task_status string
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    task_type number
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    topic_id string
    Log topic ID to which the download task belongs.
    allowIncomplete Boolean
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    compression String
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    createTime String
    Download task creation time.
    dataFormat String
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    endTime Integer
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    endTimeStr String
    Query end time.
    limit Integer
    Number of original log entries downloaded, or number of rows in the analysis result.
    logContextInfos DownloadTaskLogContextInfos
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    logCount Integer
    Number of log entries included in the download task.
    logSize Integer
    Total size of logs included in the download task, in bytes.
    mustComplete Boolean
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query String
    Query statement for analysis, with a maximum length of 4 KiB.
    sort String
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    startTime Integer
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    startTimeStr String
    Query start time.
    taskId String
    Download task ID.
    taskName String
    Download task name. Length range: 1–63 characters.
    taskStatus String
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    taskType Integer
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    topicId String
    Log topic ID to which the download task belongs.
    allowIncomplete boolean
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    compression string
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    createTime string
    Download task creation time.
    dataFormat string
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    endTime number
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    endTimeStr string
    Query end time.
    limit number
    Number of original log entries downloaded, or number of rows in the analysis result.
    logContextInfos DownloadTaskLogContextInfos
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    logCount number
    Number of log entries included in the download task.
    logSize number
    Total size of logs included in the download task, in bytes.
    mustComplete boolean
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query string
    Query statement for analysis, with a maximum length of 4 KiB.
    sort string
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    startTime number
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    startTimeStr string
    Query start time.
    taskId string
    Download task ID.
    taskName string
    Download task name. Length range: 1–63 characters.
    taskStatus string
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    taskType number
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    topicId string
    Log topic ID to which the download task belongs.
    allow_incomplete bool
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    compression str
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    create_time str
    Download task creation time.
    data_format str
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    end_time int
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    end_time_str str
    Query end time.
    limit int
    Number of original log entries downloaded, or number of rows in the analysis result.
    log_context_infos DownloadTaskLogContextInfosArgs
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    log_count int
    Number of log entries included in the download task.
    log_size int
    Total size of logs included in the download task, in bytes.
    must_complete bool
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query str
    Query statement for analysis, with a maximum length of 4 KiB.
    sort str
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    start_time int
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    start_time_str str
    Query start time.
    task_id str
    Download task ID.
    task_name str
    Download task name. Length range: 1–63 characters.
    task_status str
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    task_type int
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    topic_id str
    Log topic ID to which the download task belongs.
    allowIncomplete Boolean
    Whether to allow approximate results when the query statement cannot be calculated precisely.
    compression String
    Compression format of the exported file. none: no compression. Recommended only for small data volumes. gzip: compress using gzip format. ip: compress using ip format.
    createTime String
    Download task creation time.
    dataFormat String
    Exported file format. Supported values: csv: CSV format. json: JSON format. jsonl: JSONL format.
    endTime Number
    Query end time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    endTimeStr String
    Query end time.
    limit Number
    Number of original log entries downloaded, or number of rows in the analysis result.
    logContextInfos Property Map
    Download the log information required for context queries, including the source host, LogGroup ID, and the log's sequence number within the LogGroup. Set this parameter when TaskType is 2.
    logCount Number
    Number of log entries included in the download task.
    logSize Number
    Total size of logs included in the download task, in bytes.
    mustComplete Boolean
    Whether to use fully accurate query results for download. true: use fully accurate query results to ensure the downloaded log data exactly matches the query conditions. false: full accuracy is not required; allows downloading log data that may not exactly match the query conditions.
    query String
    Query statement for analysis, with a maximum length of 4 KiB.
    sort String
    Log sorting order when only retrieving without analysis. asc: ascending. desc: descending.
    startTime Number
    Query start time, accurate to the millisecond. Unix timestamp format, representing the number of milliseconds since 1970-1-1 00:00:00 UTC.
    startTimeStr String
    Query start time.
    taskId String
    Download task ID.
    taskName String
    Download task name. Length range: 1–63 characters.
    taskStatus String
    Download task status, indicating the generation status of the log archive file. Includes: creating: file is being generated. created_cut: file has been partially generated. success: file has been generated. wait: waiting. fail: failed.
    taskType Number
    Type of logs to download. 0: download search-type logs. 1: download analysis-type logs. 2: download context-type logs.
    topicId String
    Log topic ID to which the download task belongs.

    Supporting Types

    DownloadTaskLogContextInfos, DownloadTaskLogContextInfosArgs

    ContextFlow string
    LogGroup ID to which the log context belongs.
    PackageOffset int
    Specifies the log index in the LogGroup.
    Source string
    Host of the log source.
    ContextFlow string
    LogGroup ID to which the log context belongs.
    PackageOffset int
    Specifies the log index in the LogGroup.
    Source string
    Host of the log source.
    context_flow string
    LogGroup ID to which the log context belongs.
    package_offset number
    Specifies the log index in the LogGroup.
    source string
    Host of the log source.
    contextFlow String
    LogGroup ID to which the log context belongs.
    packageOffset Integer
    Specifies the log index in the LogGroup.
    source String
    Host of the log source.
    contextFlow string
    LogGroup ID to which the log context belongs.
    packageOffset number
    Specifies the log index in the LogGroup.
    source string
    Host of the log source.
    context_flow str
    LogGroup ID to which the log context belongs.
    package_offset int
    Specifies the log index in the LogGroup.
    source str
    Host of the log source.
    contextFlow String
    LogGroup ID to which the log context belongs.
    packageOffset Number
    Specifies the log index in the LogGroup.
    source String
    Host of the log source.

    Import

    $ pulumi import volcenginecc:tls/downloadTask:DownloadTask example "topic_id|task_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.50
    published on Monday, Jul 20, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial