You need to enable JavaScript to run this app.
文档中心
向量数据库VikingDB

向量数据库VikingDB

复制全文
下载 pdf
任务(Task)
ListVikingdbTask
复制全文
下载 pdf
ListVikingdbTask

概述

获取多个任务(Task)的信息,最多一次性返回 20 条。

方法定义

Go SDK 通过 vikingdb.New(sess) 创建的客户端实例调用 ListVikingdbTask(input) 方法发起任务列表查询请求,input 参数类型为 vikingdb.ListVikingdbTaskInput,包含任务列表查询所需的参数。

请求参数

参数

类型

是否必填

描述

ProjectName

string

否

项目名称

CollectionName

string

2选1

数据集名称

ResourceId

string

数据集资源ID。请求必须指定ResourceId和CollectionName其中之一。

TaskStatus

string

是

任务状态,见下

TaskType

string

是

任务类型,见下

PageNumber

int

否

翻页页码。起始为1。

PageSize

int

否

翻页每页的大小。

返回参数

字段

类型

子字段说明

Tasks

[]TaskForListVikingdbTaskOutput

任务列表

PageSize

int

PageNumber

int

TotalCount

int

  • List

属性

类型

说明

TaskId

string

任务ID

TaskConfig

TaskConfigForListVikingdbTaskOutput

CollectionName

string

ExportAll

bool

TaskType

string

任务类型

TaskStatus

string

任务状态

UpdatePerson

string

任务更新人

UpdateTime

string

任务信息更新时间

CreateTime

string

任务信息创建时间

TaskProcessInfo

TaskProcessInfoForListVikingdbTaskOutput

任务处理信息,见下

  • TaskType 类型包括

TaskType
data_import

说明
数据导入任务

data_export

数据导出任务

filter_update

数据过滤更新任务

filter_delete

数据过滤删除任务

  • TaskStatus 任务状态包括

init

queued

running

done

fail

初始化中

排队中

执行中

完成

失败

  • TaskProcessInfoForListVikingdbTaskOutput 包括

字段

类型

说明

TaskProgress

string

任务进度,例如 50%

ErrorMessage

string

任务错误信息

SampleData

[]SampleDataForGetVikingdbTaskOutput

采样5条数据用于展示

SampleTimestamp

int

采样时间戳,后写入的数据不会被处理

ScanDataCount

int

当前扫描数据量

TotalDataCount

int

collection 数据总条数(预估)

TotalFilterCount

int

已经过滤出的数据

示例

运行示例前,请完成以下准备:

  • 按“安装与 client 初始化”文档安装 VikingDB V2 Go SDK;将完整代码保存为 main.go 后执行 go run main.go。
  • AK/SK 在火山引擎控制台“密钥管理”中创建;Host 和 Region 取自地域和访问域名,并按代码读取方式配置相应环境变量。
  • Collection、Index 名称从 VikingDB 控制台对应资源详情获取,Task ID 使用创建或查询任务接口返回的 ID。请将代码中的 <YOUR_...> 占位符全部替换为真实值。
  • 若示例包含 TOS 路径,请从 TOS 控制台确认桶名和对象路径,并替换为真实的 <YOUR_BUCKET_NAME>/<YOUR_TOS_PATH>。
package main

import (
    "fmt"
    "os"

    "github.com/volcengine/volcengine-go-sdk/service/vikingdb"
    "github.com/volcengine/volcengine-go-sdk/volcengine"
    "github.com/volcengine/volcengine-go-sdk/volcengine/credentials"
    "github.com/volcengine/volcengine-go-sdk/volcengine/session"
)

func main() {
    var (
       accessKey = os.Getenv("VIKINGDB_AK")
       secretKey = os.Getenv("VIKINGDB_SK")
       region    = "cn-beijing"
    )

    config := volcengine.NewConfig().
       WithRegion(region).
       WithCredentials(credentials.NewStaticCredentials(accessKey, secretKey, ""))

    sess, err := session.NewSession(config)
    if err != nil {
       panic(err)
    }
    svc := vikingdb.New(sess)

    input := &vikingdb.ListVikingdbTaskInput{
       ProjectName:    volcengine.String("default"),
       CollectionName: volcengine.String("<YOUR_COLLECTION_NAME>"),
       TaskStatus:    volcengine.String("done"),
       TaskType:      volcengine.String("data_import"),
    }

    resp, err := svc.ListVikingdbTask(input)
    if err != nil {
       panic(err)
    }

    fmt.Println(*resp.TotalCount)
    for _, task := range resp.Tasks {
       fmt.Println(*task.TaskId, *task.TaskStatus)
    }
}

使用说明修正

Go 示例的 ListVikingdbTaskInput 同时设置 TaskStatus: "done" 和 TaskType: "data_import",与参数表一致;可按业务替换为其他已支持枚举值。

最近更新时间:2026.09.08 12:03:01
这个页面对您有帮助吗?
有用
有用
无用
无用