You need to enable JavaScript to run this app.
文档中心
文件存储 vePFS

文件存储 vePFS

复制全文
下载 pdf
数据洞察 V2.1
CreateLensTask - 创建数据洞察任务
复制全文
下载 pdf
CreateLensTask - 创建数据洞察任务
调用 CreateLensTask 接口,创建数据洞察任务。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:CreateLensTask​
要执行的操作,取值:CreateLensTask。​
​
Version string 必选 示例值:2022-01-01​
API的版本,取值:2022-01-01。​
​
LensTaskName string 必选 示例值:test​
数据洞察任务的名称。​
​
LensPolicyId string 必选 示例值:lenspolicy-cnbj********​
关联的数据洞察策略 ID。​
​
FileSystemId string 必选 示例值:vepfs-cnbj********​
关联的文件系统 ID。​
​
Schedule object 可选 示例值:-​
数据洞察任务计划。​
ScheduleType string 必选 示例值:Timed​
数据洞察任务计划类型,取值说明如下:​
  • Timed:周期性任务。​
  • Once:一次性任务。​
​
OnceRunTiming string 可选 示例值:Now​
数据洞察一次性任务执行时间,取值说明如下:​
  • Now:立即执行。​
  • Later:定时执行。​
​
Period integer 可选 示例值:1​
数据洞察任务周期性任务执行周期。​
​
PeriodUnit string 可选 示例值:Day​
数据洞察任务周期性任务执行周期单位,取值说明如下:​
  • Hour:小时。​
  • Day:天。​
  • Week:周。​
  • Month:月。​
​
RunTime long 可选 示例值:1765265717​
数据洞察任务开始时间。​
​
ConflictPolicy string 可选 示例值:Enqueue​
数据洞察任务冲突策略,取值说明如下:​
  • Enqueue:加入排队。​
  • Conflict:冲突终止。​
​
​
TargetInfos object[] 可选 示例值:-​
目标目录信息。​
FilesetId string 可选 示例值:fset-*****​
fileset ID。​
​
RelativePath string 可选 示例值:/test/​
子目录。​
​
​
LensTaskContent string[] 可选 示例值:MetadataExport​
数据洞察任务内容,取值说明如下:​
  • MetadataExport:导出任务。以获取任务执行结果文件为目标的任务为导出任务。​
  • MetadataAnalyze:分析任务。以根据任务执行结果获取分析信息为目标的任务为分析任务。​
  • CapacityStat:容量统计任务。以根据任务执行结果获取容量信息为目标的任务为容量统计任务。​
​
LensExportInfo object 可选 示例值:-​
元数据导出任务信息。​
ExportAttrs string[] 必选 示例值:Path​
数据洞察任务导出指标,取值说明如下:​
  • Inode:Inode。​
  • Mode:文件访问权限。​
  • NLink:链接数。​
  • Size:文件大小。​
  • CreationTime:创建时间。​
  • AccessTime:最后访问时间。​
  • ChangeTime:最后元数据变更时间。​
  • ModifyTime:最后数据修改时间。​
  • Type:文件类型。​
  • Extension:文件扩展名。​
  • Name:文件名称。​
  • Path:文件路径。​
​
ExportPath string 可选 示例值:/test/​
导出目录。​
​
TosBucket string 可选 示例值:tosbucket​
TOS 桶。​
​
TosPrefix string 可选 示例值:/test/​
TOS 路径前缀。​
​
EnableDownload boolean 可选 示例值:-​
是否开启下载。​
​
ResultDownloadUrl string 可选 示例值:-​
导出结果下载链接,该参数仅出现在返回参数。​
​
​
LensAnalysisInfo object 可选 示例值:-​
元数据分析任务信息。​
EnableLensAnalysis boolean 必选 示例值:true​
是否开启任务执行结果分析功能,取值说明如下:​
  • true:开启。​
  • false:不开启。​
说明​
LensTaskContent 参数取值中包含 MetadataAnalyze 时,取值为 ture,否则取值为 false。​
​
AnalysisAttrs string[] 必选 示例值:Inode​
数据洞察任务分析指标,取值说明如下:​
  • Inode:Inode。​
  • Mode:文件访问权限。​
  • NLink:链接数。​
  • Size:文件大小。​
  • CreationTime:创建时间。​
  • AccessTime:最后访问时间。​
  • ChangeTime:最后元数据变更时间。​
  • ModifyTime:最后数据修改时间。​
  • Type:文件类型。​
  • Extension:文件扩展名。​
  • Name:文件名称。​
  • Path:文件路径。​
​
TlsTopicId string 可选 示例值:29fecf9e-878e-4ae3-9990-90785b2d****​
日志服务主题 ID。​
​
TlsProjectId string 可选 示例值:5c7a0de3-6fd3-4a0f-8503-233a7729****​
日志服务项目 ID。​
​
ExpirationTime string 可选 示例值:2025-12-30T14:15:28+08:00​
日志服务过期时间。​
​
​
LensCapacityStatInfo object 可选 示例值:-​
容量统计任务信息。​
FirstLevelSubDir boolean 必选 示例值:-​
是否统计一级目录容量。​
​
SecondLevelSubDir boolean 必选 示例值:-​
是否统计二级目录容量。​
​
EnableDownload boolean 可选 示例值:-​
容量统计结果是否支持下载。​
​
FirstLevelSubDirDownloadUrl string 可选 示例值:-​
一级目录容量统计结果下载链接,该参数仅出现在返回参数。​
​
SecondLevelSubDirDownloadUrl string 可选 示例值:-​
二级目录容量统计结果下载链接,该参数仅出现在返回参数。​
​
ExportPath string 可选 示例值:/test/​
容量统计结果在文件系统侧的导出目录。​
​
TosBucket string 可选 示例值:tosbucket​
容量统计结果导出的 TOS 桶。​
​
TosPrefix string 可选 示例值:/test/​
容量统计结果导出的 TOS 桶前缀。​
​
​
Description string 可选 示例值:for-test​
数据洞察任务的描述信息。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
LensTaskId string 示例值:lenstask-cnbj********​
数据洞察任务 ID。​
​
​
​
请求示例​
​
POST /?Action=CreateLensTask&Version=2022-01-01 HTTP/1.1​
Host: https://api.volcengine.com/api-explorer/?action=CreateLensPolicy&groupName=Lens_Public&serviceCode=vepfs&version=2022-01-01​
Content-Type: application/json; charset=UTF-8​
X-Date: 20251215T093649Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251215/cn-beijing/vepfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"LensTaskName": "test",​
"LensPolicyId": "lenspolicy-cnbj********",​
"FileSystemId": "vepfs-cnbj********"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202512151736550622071560286573B8",​
"Action": "CreateLensTask",​
"Version": "2022-01-01",​
"Service": "vepfs",​
"Region": "cn-beijing"​
},​
"Result": {​
"LensTaskId": "lenstask-cnbj********"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter format is invalid.​
参数格式错误。​
403​
OperationDenied.LimitExceeded_TimedLensTaskNumber​
The number of timed lens task for the specified file system exceeds limit.​
指定的文件系统数据洞察周期性自定义任务数量已经达到上限。​
500​
InternalError​
Service has some internal Error. Pls Contact With Admin.​
内部错误。​
​
​
最近更新时间:2025.12.18 14:02:41
这个页面对您有帮助吗?
有用
有用
无用
无用