You need to enable JavaScript to run this app.
文档中心
AI 数据湖服务

AI 数据湖服务

复制全文
下载 pdf
任务管理
GetTaskInstance - 获取任务实例详情
复制全文
下载 pdf
GetTaskInstance - 获取任务实例详情
获取任务实例详情​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetTaskInstance​
要执行的操作,取值:GetTaskInstance。​
​
Version string 必选 示例值:2025-08-15​
API的版本,取值:2025-08-15。​
​
ClientToken string 可选 示例值:uuid-xxxxxx​
客户端token​
​
TaskInstanceId string 必选 示例值:ti-uuid​
任务实例Id​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
JobId string 示例值:123456​
底层 Job Id​
​
Status string 示例值:Processing​
任务状态。Created(已创建)/Submitting(提交中)/ResourceInitializing(启动中)/Processing(处理中)/Completed(已完成)/Cancelled(已取消)/Failed(运行失败)/SubmitFailed(提交失败)/AnalysisFailed(解析失败)​
​
TaskId string 示例值:t-uuid​
实例所属任务ID​
​
OwnerId long 示例值:123456​
创建者子账号 Id​
​
RunEnvs object[] 示例值:[ { "Key": "ray.xxx", "Value": "b" } ]​
执行时追加/覆盖环境变量​
Key string 示例值:name1​
Key​
​
Value string 示例值:value1​
Value​
​
​
CrossVpc object 示例值:--​
打通 vpc 所需参数​
VpcId string 示例值:vpc-xxxxxx​
VPC ID。​
​
SubnetIds object[] 示例值:{ "Name": "A", "Value": "subnet-a" }​
子网 ID list, 键为可用区(A/B/C/D/E/...), 值为子网 ID. 同时输入 SubnetIds 时,本参数无效. 作为返回值时,优先参考本参数.​
Key string 示例值:name1​
Key​
​
Value string 示例值:value1​
Value​
​
​
SecurityGroupId string 示例值:sg-xxxxxx​
VPC 所属安全组 ID​
​
EnableDnsResolve boolean 示例值:true​
访问 VPC 下 PrivateZone/PrivateLink 域名​
​
​
Priority integer 示例值:1​
任务优先级, 0(最低)~9(最高), 优先级>=3的任务可能抢占优先级<=2的任务​
​
TaskType string 示例值:Daft​
任务类型​
​
TosMount object 示例值:--​
tos 加载参数​
AccessKey string 示例值:AKxxxxxx​
ak​
​
MountType string​
MountType​
​
SecretKey string 示例值:xxxxxx==​
密码,只写入,不返回。更新时不填写则不更新​
​
TosMountPaths object[] 示例值:--​
TosMountPaths​
Source string 示例值:tos://test-bucket/test​
TOS 路径​
​
MountPath string 示例值:/mnt/test​
挂载路径​
​
​
​
AccountId long 示例值:123456​
主账号 Id​
​
Initiator object 示例值:--​
启动任务实例者相关信息​
InitiatorId string 示例值:123456​
作业实例启动者 Id,例如 UserId/WorkflowInstanceId​
​
InitiatorName string 示例值:user123​
作业实例启动者 Name​
​
​
OwnerName string 示例值:name​
创建者子账号 name​
​
CreateTime string 示例值:2025-01-01T01:01:01Z​
创建时间,参照《ISO 8601-2:2019》标准​
​
Entrypoint string 示例值:python /opt/main.py​
执行时覆盖的入口命令​
​
FinishTime string 示例值:2025-01-01T01:01:01Z​
结束时间,参照《ISO 8601-2:2019》标准​
​
Permission string 示例值:Admin​
当前用户对任务定义的权限角色​
​
ResourceId string 示例值:resource_xxxxxx​
队列资源Id​
​
RunOwnerId long 示例值:123456​
执行者子账号 Id​
​
UpdateTime string 示例值:2025-01-01T01:01:01Z​
更新时间,参照《ISO 8601-2:2019》标准​
​
TriggerType string 示例值:Manual​
触发方式, Manual-手动触发; Cron-定时触发; Workflow-工作流触发​
​
PythonResourceConfig object 示例值:--​
Python资源配置​
CpuNum float 示例值:1.1​
CPU 数量​
​
GpuNum float 示例值:0.1​
GPU 数量,默认 0.0​
​
Replicas integer 示例值:1​
运行实例数量,默认 1​
​
EnableMGpu boolean 示例值:false​
开启 mGPU 功能。开启后将使用 MGpuCorePercentage 和 MGpuMemorySize 参数、忽略 GpuNum 参数​
​
MemorySize float 示例值:1.1​
内存大小,单位 Gi,默认为 CpuNum * 4​
​
MGpuMemorySize integer 示例值:1024​
mGPU 使用内存大小,单位 MiB,开启 mGPU 时必须大于 256MiB​
​
SharedMemorySize integer 示例值:2​
共享内存大小,单位 Gi。仅 Python 任务生效;未设置时 EMR 侧默认按任务内存的 70% 分配;上限为任务内存,必须为整数​
​
MGpuCorePercentage integer 示例值:30​
mGPU 使用核心百分比,开启 mGPU 时范围为 5 ~ 100​
​
​
RunOwnerName string 示例值:name​
运行者子账号 name​
​
CancelOwnerId long 示例值:123456​
取消者子账号 Id​
​
NasMountPaths object[] 示例值:--​
nas 加载参数​
MountPath string 示例值:/test/nas/dst​
挂载到Pod中的路径​
​
VolumePath string 示例值:/test/nas/src​
NAS文件系统待挂载的路径(NAS中的原路径)​
​
FileSystemId string 示例值:nas-uuid​
NAS文件系统id​
​
AccessPointId string 示例值:nas-access-point-uuid​
接入点Id​
​
​
TaskInstanceId string 示例值:ti-uuid​
任务实例ID​
​
TimeoutMinutes integer 示例值:10​
任务超时分钟数,超时后会自动 stop,默认 0 不开启​
​
CancelOwnerName string 示例值:name​
取消者子账号 name​
​
VepfsMountPaths object[] 示例值:--​
vepfs 加载参数​
MountPath string 示例值:/mnt/vepfs​
挂载到Pod中的路径​
​
VolumePath string 示例值:/folder1/​
vePFS文件系统待挂载的路径(vePFS中的原路径)​
​
FileSystemId string 示例值:vepfs-xxxxxx​
vePFS文件系统id​
​
AccessPointId string 示例值:ap-xxx​
vePFS 接入点 Id​
​
​
DatasetMountPaths object[] 示例值:--​
数据集加载参数​
MountPath string 示例值:/test/data/dst​
挂载到 Pod 中的路径​
​
DatasetName string 示例值:ds-uuid​
数据集 id​
​
​
StateChangeReason string 示例值:Failed reason​
最终状态失败原因​
​
DaftResourceConfig object 示例值:--​
Daft资源配置​
Replicas integer 示例值:1​
Daft worker 实例数,默认 1​
​
EnableMGpu boolean 示例值:false​
DaftWorker 开启 mGPU 功能。开启后将使用 WorkerMGpuCorePercentage 和 WorkerMGpuMemorySize 参数、忽略 WorkerGpuNum 参数​
​
HeadCpuNum float 示例值:1.2​
DaftHead cpu 数量,默认与 WorkerCpuNum 一致​
​
MaxReplicas integer 示例值:1​
Daft Worker 最大实例数,默认和 Replicas 相同​
​
MinReplicas integer 示例值:1​
Daft Worker 最小实例数,默认和 Replicas 相同​
​
WorkerCpuNum float 示例值:1.2​
DaftWorker cpu 数量​
​
WorkerGpuNum float 示例值:0.1​
DaftWorker gpu 数量,默认 0​
​
HeadMemorySize float 示例值:1.2​
DaftHead memory 容量,单位 Gi,默认与 WorkerMemorySize 一致​
​
ResourceSpecId string 示例值:spec_uuid​
队列资源规格Id​
​
DaftWorkerGroups object[] 示例值:--​
DaftWorkerGroups,如果设置则至少包含一个 WorkerGroup,将忽略 DaftResourceConfig 下的 WorkerCpuNum、WorkerMemorySize、WorkerGpuNum、Replicas 参数​
Replicas integer 示例值:1​
Daft worker 实例数,默认 1​
​
EnableMGpu boolean 示例值:false​
DaftWorker 开启 mGPU 功能。开启后将使用 WorkerMGpuCorePercentage 和 WorkerMGpuMemorySize 参数、忽略 WorkerGpuNum 参数​
​
MaxReplicas integer 示例值:1​
Daft Worker 最大实例数,默认和 Replicas 相同​
​
MinReplicas integer 示例值:1​
Daft Worker 最小实例数,默认和 Replicas 相同​
​
WorkerCpuNum float 示例值:1.2​
DaftWorker cpu 数量​
​
WorkerGpuNum float 示例值:0.1​
DaftWorker gpu 数量,默认 0​
​
ResourceSpecId string 示例值:spec_uuid​
队列资源规格Id​
​
WorkerGroupName string 示例值:worker_group_name​
WorkerGroupName​
​
WorkerMemorySize float 示例值:1.2​
DaftWorker memory 容量,单位 Gi​
​
WorkerMGpuMemorySize integer 示例值:1024​
mGPU 使用内存大小,单位 MiB,开启 mGPU 时必须大于 256MiB​
​
WorkerMGpuCorePercentage integer 示例值:30​
mGPU 使用核心百分比,开启 mGPU 时范围为 5 ~ 99​
​
​
WorkerMemorySize float 示例值:1.2​
DaftWorker memory 容量,单位 Gi​
​
WorkerMGpuMemorySize integer 示例值:1024​
mGPU 使用内存大小,单位 MiB,开启 mGPU 时必须大于 256MiB​
​
EnableMultiWorkerGroup boolean 示例值:false​
启用 DaftWorkerGroups 参数,将忽略 DaftResourceConfig 下的 WorkerCpuNum、WorkerMemorySize、WorkerGpuNum、Replicas 参数​
​
WorkerMGpuCorePercentage integer 示例值:30​
mGPU 使用核心百分比,开启 mGPU 时范围为 5 ~ 100​
​
​
DatasetCodeReviewId string 示例值:cr-uuid​
数据集代码审核 id​
​
ResourceSpecGroupId string 示例值:0​
队列资源规格组Id​
​
​
​
请求示例​
​
POST https://open.volcengineapi.com​
{​
"ClientToken": "uuid-xxxxxx",​
"TaskInstanceId": "i-uuid"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2025112517171916523424715172A308",​
"Action": "GetTaskInstance",​
"Version": "2025-08-15",​
"Service": "las_ai_qa",​
"Region": "cn-beijing"​
},​
"Result": {​
"Status": "FR",​
"TaskId": "t-uuid",​
"OwnerId": 123456,​
"CrossVpc": {​
"VpcId": "vpc-xxxxxx",​
"SubnetIds": [​
{​
"Key": "name1",​
"Value": "value1"​
}​
],​
"SecurityGroupId": "sg-xxxxxx"​
},​
"TaskType": "Daft",​
"TosMount": {​
"AccessKey": "AKxxxxxx",​
"SecretKey": "xxxxxx==",​
"TosMountPaths": [​
{​
"Source": "tos://test-bucket/test",​
"MountPath": "/mnt/test"​
}​
]​
},​
"AccountId": 123456,​
"CreateTime": "2025-01-01T01:01:01Z",​
"FinishTime": "2025-01-01T01:01:01Z",​
"ResourceId": "resource_xxxxxx",​
"RunOwnerId": 123456,​
"UpdateTime": "2025-01-01T01:01:01Z",​
"TriggerType": "Manual",​
"CancelOwnerId": 123456,​
"TaskInstanceId": "i-uuid",​
"TimeoutMinutes": 10,​
"VepfsMountPaths": [​
{​
"MountPath": "/mnt/vepfs",​
"VolumePath": "/folder1/",​
"FileSystemId": "vepfs-xxxxxx"​
}​
],​
"StateChangeReason": "Failed reason",​
"DaftResourceConfig": {​
"Replicas": 1,​
"HeadCpuNum": 1.2,​
"WorkerCpuNum": 1.2,​
"WorkerGpuNum": 0.1,​
"HeadMemorySize": 1.2,​
"WorkerMemorySize": 1.2​
},​
"SparkResourceConfig": {​
"Replicas": 1,​
"DriverCpuNum": 1,​
"DriverGpuNum": 0.1,​
"ExecutorCpuNum": 1,​
"ExecutorGpuNum": 0.1,​
"DriverMemorySize": 4,​
"ExecutorMemorySize": 4​
},​
"PythonResourceConfig": {​
"CpuNum": 1.1,​
"GpuNum": 0.1,​
"Replicas": 1,​
"MemorySize": 1.1​
}​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
IllegalArgument​
非法参数​
非法参数​
400​
DryRunOperation​
The request is validated by a dryrun operation.​
该请求通过 dryrun 操作进行验证。​
400​
InvalidRequestParam​
Invalid request param {}, cause {}​
非法请求参数 {}, 原因 {}​
400​
InvalidParameter​
The specified parameter {} is invalid.​
指定的参数 {} 无效。​
400​
MissingParameter​
The required parameter {} is missing.​
缺少必需的参数 {}。​
400​
InvalidRequest​
TaskInstanceId 不存在 Daft-8057167b-203c-4ec0-a761-f18c3d8ae23d​
任务实例不存在​
500​
InternalError​
The request has failed due to an unknown error.​
由于未知错误,请求失败。​
​
​
最近更新时间:2026.10.15 20:22:01
这个页面对您有帮助吗?
有用
有用
无用
无用