Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. redis
  6. getKeyScanJob
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.redis.getKeyScanJob

volcenginecc logo
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::Redis::KeyScanJob

    Using getKeyScanJob

    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 getKeyScanJob(args: GetKeyScanJobArgs, opts?: InvokeOptions): Promise<GetKeyScanJobResult>
function getKeyScanJobOutput(args: GetKeyScanJobOutputArgs, opts?: InvokeOutputOptions): Output<GetKeyScanJobResult>
    def get_key_scan_job(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetKeyScanJobResult
def get_key_scan_job_output(id: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetKeyScanJobResult]
    func LookupKeyScanJob(ctx *Context, args *LookupKeyScanJobArgs, opts ...InvokeOption) (*LookupKeyScanJobResult, error)
func LookupKeyScanJobOutput(ctx *Context, args *LookupKeyScanJobOutputArgs, opts ...InvokeOption) LookupKeyScanJobResultOutput

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

    public static class GetKeyScanJob 
{
    public static Task<GetKeyScanJobResult> InvokeAsync(GetKeyScanJobArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyScanJobResult> Invoke(GetKeyScanJobInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyScanJobResult> Invoke(GetKeyScanJobInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetKeyScanJobResult> getKeyScanJob(GetKeyScanJobArgs args, InvokeOptions options)
public static Output<GetKeyScanJobResult> getKeyScanJob(GetKeyScanJobArgs args, InvokeOptions options)
public static Output<GetKeyScanJobResult> getKeyScanJob(GetKeyScanJobArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: volcenginecc:redis/getKeyScanJob:getKeyScanJob
  arguments:
    # arguments dictionary
    data "volcenginecc_redis_get_key_scan_job" "name" {
    # arguments
}

    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 string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getKeyScanJob Result

    The following output properties are available:

    CompletedCount int
    Number of shards analyzed.
    CreateTime string
    Task creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    FinishTime string
    Task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID. You can call the DescribeDBInstances API to query basic information for all Redis instances in the target region, including the instance ID.
    JobId string
    Task ID of the scan job.
    ScanKeyNumPerSecond int
    Number of expired keys scanned per second. Value range: integer between 2000 and 100000.
    StartTime string
    Task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    Status string
    Task status. Values: Created, Running, Finished, Failed, Interrupted.
    TimeoutMinutes int
    Scan timeout. Value range: integer between 30 and 1440, unit: minutes.
    TotalCount int
    Total number of shards to analyze.
    CompletedCount int
    Number of shards analyzed.
    CreateTime string
    Task creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    FinishTime string
    Task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID. You can call the DescribeDBInstances API to query basic information for all Redis instances in the target region, including the instance ID.
    JobId string
    Task ID of the scan job.
    ScanKeyNumPerSecond int
    Number of expired keys scanned per second. Value range: integer between 2000 and 100000.
    StartTime string
    Task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    Status string
    Task status. Values: Created, Running, Finished, Failed, Interrupted.
    TimeoutMinutes int
    Scan timeout. Value range: integer between 30 and 1440, unit: minutes.
    TotalCount int
    Total number of shards to analyze.
    completed_count number
    Number of shards analyzed.
    create_time string
    Task creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    finish_time string
    Task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    id string
    Uniquely identifies the resource.
    instance_id string
    Instance ID. You can call the DescribeDBInstances API to query basic information for all Redis instances in the target region, including the instance ID.
    job_id string
    Task ID of the scan job.
    scan_key_num_per_second number
    Number of expired keys scanned per second. Value range: integer between 2000 and 100000.
    start_time string
    Task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    status string
    Task status. Values: Created, Running, Finished, Failed, Interrupted.
    timeout_minutes number
    Scan timeout. Value range: integer between 30 and 1440, unit: minutes.
    total_count number
    Total number of shards to analyze.
    completedCount Integer
    Number of shards analyzed.
    createTime String
    Task creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    finishTime String
    Task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID. You can call the DescribeDBInstances API to query basic information for all Redis instances in the target region, including the instance ID.
    jobId String
    Task ID of the scan job.
    scanKeyNumPerSecond Integer
    Number of expired keys scanned per second. Value range: integer between 2000 and 100000.
    startTime String
    Task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    status String
    Task status. Values: Created, Running, Finished, Failed, Interrupted.
    timeoutMinutes Integer
    Scan timeout. Value range: integer between 30 and 1440, unit: minutes.
    totalCount Integer
    Total number of shards to analyze.
    completedCount number
    Number of shards analyzed.
    createTime string
    Task creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    finishTime string
    Task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID. You can call the DescribeDBInstances API to query basic information for all Redis instances in the target region, including the instance ID.
    jobId string
    Task ID of the scan job.
    scanKeyNumPerSecond number
    Number of expired keys scanned per second. Value range: integer between 2000 and 100000.
    startTime string
    Task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    status string
    Task status. Values: Created, Running, Finished, Failed, Interrupted.
    timeoutMinutes number
    Scan timeout. Value range: integer between 30 and 1440, unit: minutes.
    totalCount number
    Total number of shards to analyze.
    completed_count int
    Number of shards analyzed.
    create_time str
    Task creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    finish_time str
    Task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID. You can call the DescribeDBInstances API to query basic information for all Redis instances in the target region, including the instance ID.
    job_id str
    Task ID of the scan job.
    scan_key_num_per_second int
    Number of expired keys scanned per second. Value range: integer between 2000 and 100000.
    start_time str
    Task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    status str
    Task status. Values: Created, Running, Finished, Failed, Interrupted.
    timeout_minutes int
    Scan timeout. Value range: integer between 30 and 1440, unit: minutes.
    total_count int
    Total number of shards to analyze.
    completedCount Number
    Number of shards analyzed.
    createTime String
    Task creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    finishTime String
    Task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID. You can call the DescribeDBInstances API to query basic information for all Redis instances in the target region, including the instance ID.
    jobId String
    Task ID of the scan job.
    scanKeyNumPerSecond Number
    Number of expired keys scanned per second. Value range: integer between 2000 and 100000.
    startTime String
    Task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).
    status String
    Task status. Values: Created, Running, Finished, Failed, Interrupted.
    timeoutMinutes Number
    Scan timeout. Value range: integer between 30 and 1440, unit: minutes.
    totalCount Number
    Total number of shards to analyze.

    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.60
    published on Thursday, Sep 3, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial