bytepluscc.tls.getScheduleSqlTask

bytepluscc v0.0.21, Apr 2 26

Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getScheduleSqlTask

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getScheduleSqlTask(args: GetScheduleSqlTaskArgs, opts?: InvokeOptions): Promise<GetScheduleSqlTaskResult>
function getScheduleSqlTaskOutput(args: GetScheduleSqlTaskOutputArgs, opts?: InvokeOptions): Output<GetScheduleSqlTaskResult>

def get_schedule_sql_task(id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetScheduleSqlTaskResult
def get_schedule_sql_task_output(id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetScheduleSqlTaskResult]

func LookupScheduleSqlTask(ctx *Context, args *LookupScheduleSqlTaskArgs, opts ...InvokeOption) (*LookupScheduleSqlTaskResult, error)
func LookupScheduleSqlTaskOutput(ctx *Context, args *LookupScheduleSqlTaskOutputArgs, opts ...InvokeOption) LookupScheduleSqlTaskResultOutput

> Note: This function is named LookupScheduleSqlTask in the Go SDK.

public static class GetScheduleSqlTask 
{
    public static Task<GetScheduleSqlTaskResult> InvokeAsync(GetScheduleSqlTaskArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleSqlTaskResult> Invoke(GetScheduleSqlTaskInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetScheduleSqlTaskResult> getScheduleSqlTask(GetScheduleSqlTaskArgs args, InvokeOptions options)
public static Output<GetScheduleSqlTaskResult> getScheduleSqlTask(GetScheduleSqlTaskArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:tls/getScheduleSqlTask:getScheduleSqlTask
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getScheduleSqlTask Result

The following output properties are available:

CreatedTime int: Creation time (seconds-level Unix timestamp).
Description string: Brief description of the scheduled SQL analysis task. Characters <>, ', , and \ are not supported. Length: 0–64 characters.
DestProjectId string: Target log project ID.
DestRegion string: Region of the target log topic. The default is the current region.
DestTopicId string: Target log topic ID for storing scheduled SQL analysis result data.
DestTopicName string: Target log topic name.
Id string: Uniquely identifies the resource.
ProcessEndTime int: End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.
ProcessSqlDelay int: Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.
ProcessStartTime int: Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.
ProcessTimeWindow string: SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.
Query string: The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.
RequestCycle Byteplus.GetScheduleSqlTaskRequestCycle: Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.
SourceProjectId string: Source log project ID.
SourceProjectName string: Source log project name.
SourceTopicId string: ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.
SourceTopicName string: Source log topic name.
Status int: Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.
TaskId string: Task ID.
TaskName string: Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.
TaskType int: Task type: 0 means log to log; 1 means log to metric.
UpdatedTime int: Modification time (seconds-level Unix timestamp).

CreatedTime int: Creation time (seconds-level Unix timestamp).
Description string: Brief description of the scheduled SQL analysis task. Characters <>, ', , and \ are not supported. Length: 0–64 characters.
DestProjectId string: Target log project ID.
DestRegion string: Region of the target log topic. The default is the current region.
DestTopicId string: Target log topic ID for storing scheduled SQL analysis result data.
DestTopicName string: Target log topic name.
Id string: Uniquely identifies the resource.
ProcessEndTime int: End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.
ProcessSqlDelay int: Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.
ProcessStartTime int: Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.
ProcessTimeWindow string: SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.
Query string: The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.
RequestCycle GetScheduleSqlTaskRequestCycle: Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.
SourceProjectId string: Source log project ID.
SourceProjectName string: Source log project name.
SourceTopicId string: ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.
SourceTopicName string: Source log topic name.
Status int: Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.
TaskId string: Task ID.
TaskName string: Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.
TaskType int: Task type: 0 means log to log; 1 means log to metric.
UpdatedTime int: Modification time (seconds-level Unix timestamp).

createdTime Integer: Creation time (seconds-level Unix timestamp).
description String: Brief description of the scheduled SQL analysis task. Characters <>, ', , and \ are not supported. Length: 0–64 characters.
destProjectId String: Target log project ID.
destRegion String: Region of the target log topic. The default is the current region.
destTopicId String: Target log topic ID for storing scheduled SQL analysis result data.
destTopicName String: Target log topic name.
id String: Uniquely identifies the resource.
processEndTime Integer: End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.
processSqlDelay Integer: Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.
processStartTime Integer: Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.
processTimeWindow String: SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.
query String: The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.
requestCycle GetScheduleSqlTaskRequestCycle: Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.
sourceProjectId String: Source log project ID.
sourceProjectName String: Source log project name.
sourceTopicId String: ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.
sourceTopicName String: Source log topic name.
status Integer: Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.
taskId String: Task ID.
taskName String: Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.
taskType Integer: Task type: 0 means log to log; 1 means log to metric.
updatedTime Integer: Modification time (seconds-level Unix timestamp).

createdTime number: Creation time (seconds-level Unix timestamp).
description string: Brief description of the scheduled SQL analysis task. Characters <>, ', , and \ are not supported. Length: 0–64 characters.
destProjectId string: Target log project ID.
destRegion string: Region of the target log topic. The default is the current region.
destTopicId string: Target log topic ID for storing scheduled SQL analysis result data.
destTopicName string: Target log topic name.
id string: Uniquely identifies the resource.
processEndTime number: End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.
processSqlDelay number: Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.
processStartTime number: Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.
processTimeWindow string: SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.
query string: The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.
requestCycle GetScheduleSqlTaskRequestCycle: Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.
sourceProjectId string: Source log project ID.
sourceProjectName string: Source log project name.
sourceTopicId string: ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.
sourceTopicName string: Source log topic name.
status number: Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.
taskId string: Task ID.
taskName string: Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.
taskType number: Task type: 0 means log to log; 1 means log to metric.
updatedTime number: Modification time (seconds-level Unix timestamp).

created_time int: Creation time (seconds-level Unix timestamp).
description str: Brief description of the scheduled SQL analysis task. Characters <>, ', , and \ are not supported. Length: 0–64 characters.
dest_project_id str: Target log project ID.
dest_region str: Region of the target log topic. The default is the current region.
dest_topic_id str: Target log topic ID for storing scheduled SQL analysis result data.
dest_topic_name str: Target log topic name.
id str: Uniquely identifies the resource.
process_end_time int: End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.
process_sql_delay int: Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.
process_start_time int: Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.
process_time_window str: SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.
query str: The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.
request_cycle GetScheduleSqlTaskRequestCycle: Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.
source_project_id str: Source log project ID.
source_project_name str: Source log project name.
source_topic_id str: ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.
source_topic_name str: Source log topic name.
status int: Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.
task_id str: Task ID.
task_name str: Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.
task_type int: Task type: 0 means log to log; 1 means log to metric.
updated_time int: Modification time (seconds-level Unix timestamp).

createdTime Number: Creation time (seconds-level Unix timestamp).
description String: Brief description of the scheduled SQL analysis task. Characters <>, ', , and \ are not supported. Length: 0–64 characters.
destProjectId String: Target log project ID.
destRegion String: Region of the target log topic. The default is the current region.
destTopicId String: Target log topic ID for storing scheduled SQL analysis result data.
destTopicName String: Target log topic name.
id String: Uniquely identifies the resource.
processEndTime Number: End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.
processSqlDelay Number: Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.
processStartTime Number: Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.
processTimeWindow String: SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.
query String: The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.
requestCycle Property Map: Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.
sourceProjectId String: Source log project ID.
sourceProjectName String: Source log project name.
sourceTopicId String: ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.
sourceTopicName String: Source log topic name.
status Number: Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.
taskId String: Task ID.
taskName String: Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.
taskType Number: Task type: 0 means log to log; 1 means log to metric.
updatedTime Number: Modification time (seconds-level Unix timestamp).

Supporting Types

GetScheduleSqlTaskRequestCycle

CronTab string: Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
CronTimeZone string: If Type is set to Cron, you must also set the time zone.
Time int: Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.
Type string: Scheduling period type. Options: Period, Fixed, Cron.

CronTab string: Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
CronTimeZone string: If Type is set to Cron, you must also set the time zone.
Time int: Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.
Type string: Scheduling period type. Options: Period, Fixed, Cron.

cronTab String: Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
cronTimeZone String: If Type is set to Cron, you must also set the time zone.
time Integer: Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.
type String: Scheduling period type. Options: Period, Fixed, Cron.

cronTab string: Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
cronTimeZone string: If Type is set to Cron, you must also set the time zone.
time number: Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.
type string: Scheduling period type. Options: Period, Fixed, Cron.

cron_tab str: Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
cron_time_zone str: If Type is set to Cron, you must also set the time zone.
time int: Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.
type str: Scheduling period type. Options: Period, Fixed, Cron.

cronTab String: Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
cronTimeZone String: If Type is set to Cron, you must also set the time zone.
time Number: Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.
type String: Scheduling period type. Options: Period, Fixed, Cron.