1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
查看任务版本详细信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDsTaskVersionInfo。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TaskId | 是 | String | 任务ID 示例值:20230224110309511 |
TaskVersion | 是 | String | 版本 |
ProjectId | 否 | String | 项目id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | TaskVersionDsDTO | 任务版本详情信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看任务版本详情
查看任务版本详情
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDsTaskVersionInfo
<公共请求参数>
{
"TaskId": "abc",
"TaskVersion": "abc"
}
输出示例
{
"Response": {
"Data": {
"VersionId": "abc",
"TaskId": "abc",
"VersionNum": "abc",
"VersionRemark": "abc",
"Creator": "abc",
"CreateTime": "abc",
"UpdateTime": "abc",
"LastSchedulerCommitTime": "abc",
"UsedVersion": 0,
"TaskInfo": {
"TaskId": "abc",
"VirtualTaskId": "abc",
"VirtualFlag": true,
"TaskName": "abc",
"WorkflowId": "abc",
"RealWorkflowId": "abc",
"WorkflowName": "abc",
"FolderId": "abc",
"FolderName": "abc",
"CreateTime": "abc",
"LastUpdate": "abc",
"Status": "abc",
"InCharge": "abc",
"InChargeId": "abc",
"StartTime": "abc",
"EndTime": "abc",
"ExecutionStartTime": "abc",
"ExecutionEndTime": "abc",
"ProjectId": "abc",
"ProjectIdent": "abc",
"ProjectName": "abc",
"CycleType": "abc",
"CycleStep": 0,
"CrontabExpression": "abc",
"DelayTime": 0,
"StartupTime": 0,
"RetryWait": 0,
"Retriable": 0,
"TaskAction": "abc",
"TryLimit": 0,
"RunPriority": 0,
"TaskType": {
"TypeId": 0,
"TypeDesc": "abc",
"CreateTime": "abc",
"SourceServerType": "abc",
"TargetServerType": "abc",
"RunJarName": "abc",
"KillAble": 0,
"TypeSort": "abc",
"InCharge": "abc",
"BrokerParallelism": 0,
"TaskParallelism": 0,
"DoRedoParallelism": 0,
"DowngradePriorityTries": 0,
"RetryWait": 0,
"RetryLimit": 0,
"DefaultAliveWait": 0,
"PollingSeconds": 0,
"ParamList": "abc",
"TaskTypeExtension": [
{
"TaskTypeExtKey": "abc",
"TaskTypeExtValue": {
"TypeId": 0,
"PropName": "abc",
"PropLabel": "abc",
"DefaultFlag": 0,
"VisibleFlag": 0,
"PropDesc": "abc",
"RankId": 0,
"InputType": "abc",
"ValueType": "abc",
"DefaultValue": "abc",
"CandidateValues": "abc",
"IsMandatory": 0,
"MaxValue": 0,
"MinValue": 0,
"ConfLevel": 0,
"CandidateTexts": "abc",
"CopyKey": 0,
"Regex": "abc",
"Tip": "abc"
}
}
],
"FileType": "abc",
"SelectFilePath": true,
"ExcludeCommonLib": true,
"PostHooks": "abc"
},
"BrokerIp": "abc",
"ClusterId": "abc",
"MinDateTime": "abc",
"MaxDateTime": "abc",
"ExecutionTTL": 0,
"SelfDepend": 0,
"LeftCoordinate": 0,
"TopCoordinate": 0,
"TaskExt": {
"TaskId": "abc",
"Properties": [
{
"ParamKey": "abc",
"ParamValue": "abc"
}
],
"DryRunExtAttributes": [
{
"Key": "abc",
"Value": "abc",
"Description": "abc"
}
],
"DryRunParameter": [
{
"Key": "abc",
"Value": "abc",
"Description": "abc"
}
]
},
"Properties": "abc",
"Notes": "abc",
"InstanceInitStrategy": "abc",
"YarnQueue": "abc",
"Alarms": [
{
"AlarmId": "abc",
"TaskId": "abc",
"Status": 0,
"AlarmType": "abc",
"AlarmWay": "abc",
"Creator": "abc",
"AlarmRecipient": "abc",
"AlarmRecipientId": "abc",
"ModifyTime": "abc",
"LastFailTime": "abc",
"LastOverTime": "abc",
"LastAlarmTime": "abc",
"AlarmExt": [
{
"AlarmId": "abc",
"PropName": "abc",
"PropValue": "abc",
"CreateTime": "abc",
"ModifyTime": "abc"
}
],
"CreateTime": "abc"
}
],
"Alarm": "abc",
"ScriptChange": true,
"Submit": true,
"LastSchedulerCommitTime": "abc",
"NormalizedJobStartTime": "abc",
"RecoverFreezeStartTime": "abc",
"SourceServer": "abc",
"TargetServer": "abc",
"Tasks": [
{
"TaskId": "abc",
"VirtualTaskId": "abc",
"VirtualFlag": true,
"TaskName": "abc",
"WorkflowId": "abc",
"RealWorkflowId": "abc",
"WorkflowName": "abc",
"FolderId": "abc",
"FolderName": "abc",
"CreateTime": "abc",
"LastUpdate": "abc",
"Status": "abc",
"InCharge": "abc",
"InChargeId": "abc",
"StartTime": "abc",
"EndTime": "abc",
"ExecutionStartTime": "abc",
"ExecutionEndTime": "abc",
"ProjectId": "abc",
"ProjectIdent": "abc",
"ProjectName": "abc",
"CycleType": "abc",
"CycleStep": 0,
"CrontabExpression": "abc",
"DelayTime": 0,
"StartupTime": 0,
"RetryWait": 0,
"Retriable": 0,
"TaskAction": "abc",
"TryLimit": 0,
"RunPriority": 0,
"TaskType": {
"TypeId": 0,
"TypeDesc": "abc",
"CreateTime": "abc",
"SourceServerType": "abc",
"TargetServerType": "abc",
"RunJarName": "abc",
"KillAble": 0,
"TypeSort": "abc",
"InCharge": "abc",
"BrokerParallelism": 0,
"TaskParallelism": 0,
"DoRedoParallelism": 0,
"DowngradePriorityTries": 0,
"RetryWait": 0,
"RetryLimit": 0,
"DefaultAliveWait": 0,
"PollingSeconds": 0,
"ParamList": "abc",
"TaskTypeExtension": [
{
"TaskTypeExtKey": "abc",
"TaskTypeExtValue": {
"TypeId": 0,
"PropName": "abc",
"PropLabel": "abc",
"DefaultFlag": 0,
"VisibleFlag": 0,
"PropDesc": "abc",
"RankId": 0,
"InputType": "abc",
"ValueType": "abc",
"DefaultValue": "abc",
"CandidateValues": "abc",
"IsMandatory": 0,
"MaxValue": 0,
"MinValue": 0,
"ConfLevel": 0,
"CandidateTexts": "abc",
"CopyKey": 0,
"Regex": "abc",
"Tip": "abc"
}
}
],
"FileType": "abc",
"SelectFilePath": true,
"ExcludeCommonLib": true,
"PostHooks": "abc"
},
"BrokerIp": "abc",
"ClusterId": "abc",
"MinDateTime": "abc",
"MaxDateTime": "abc",
"ExecutionTTL": 0,
"SelfDepend": 0,
"LeftCoordinate": 0,
"TopCoordinate": 0,
"TaskExt": {
"TaskId": "abc",
"Properties": [
{
"ParamKey": "abc",
"ParamValue": "abc"
}
],
"DryRunExtAttributes": [
{
"Key": "abc",
"Value": "abc",
"Description": "abc"
}
]
},
"Properties": "abc",
"Notes": "abc",
"InstanceInitStrategy": "abc",
"YarnQueue": "abc",
"Alarms": [
{
"AlarmId": "abc",
"TaskId": "abc",
"Status": 0,
"AlarmType": "abc",
"AlarmWay": "abc",
"Creator": "abc",
"AlarmRecipient": "abc",
"AlarmRecipientId": "abc",
"ModifyTime": "abc",
"LastFailTime": "abc",
"LastOverTime": "abc",
"LastAlarmTime": "abc",
"AlarmExt": [
{
"AlarmId": "abc",
"PropName": "abc",
"PropValue": "abc",
"CreateTime": "abc",
"ModifyTime": "abc"
}
],
"CreateTime": "abc"
}
],
"Alarm": "abc",
"ScriptChange": true,
"Submit": true,
"LastSchedulerCommitTime": "abc",
"NormalizedJobStartTime": "abc",
"RecoverFreezeStartTime": "abc",
"SourceServer": "abc",
"TargetServer": "abc",
"Tasks": [
{
"TaskId": "abc",
"VirtualTaskId": "abc",
"VirtualFlag": true,
"TaskName": "abc",
"WorkflowId": "abc",
"RealWorkflowId": "abc",
"WorkflowName": "abc",
"FolderId": "abc",
"FolderName": "abc",
"CreateTime": "abc",
"LastUpdate": "abc",
"Status": "abc",
"InCharge": "abc",
"InChargeId": "abc",
"StartTime": "abc",
"EndTime": "abc",
"ExecutionStartTime": "abc",
"ExecutionEndTime": "abc",
"ProjectId": "abc",
"ProjectIdent": "abc",
"ProjectName": "abc",
"CycleType": "abc",
"CycleStep": 0,
"CrontabExpression": "abc",
"DelayTime": 0,
"StartupTime": 0,
"RetryWait": 0,
"Retriable": 0,
"TaskAction": "abc",
"TryLimit": 0,
"RunPriority": 0,
"TaskType": {
"TypeId": 0,
"TypeDesc": "abc",
"CreateTime": "abc",
"SourceServerType": "abc",
"TargetServerType": "abc",
"RunJarName": "abc",
"KillAble": 0,
"TypeSort": "abc",
"InCharge": "abc",
"BrokerParallelism": 0,
"TaskParallelism": 0,
"DoRedoParallelism": 0,
"DowngradePriorityTries": 0,
"RetryWait": 0,
"RetryLimit": 0,
"DefaultAliveWait": 0,
"PollingSeconds": 0,
"ParamList": "abc",
"TaskTypeExtension": [
{
"TaskTypeExtKey": "abc",
"TaskTypeExtValue": {
"TypeId": 0,
"PropName": "abc",
"PropLabel": "abc",
"DefaultFlag": 0,
"VisibleFlag": 0,
"PropDesc": "abc",
"RankId": 0,
"InputType": "abc",
"ValueType": "abc",
"DefaultValue": "abc",
"CandidateValues": "abc",
"IsMandatory": 0,
"MaxValue": 0,
"MinValue": 0,
"ConfLevel": 0,
"CandidateTexts": "abc",
"CopyKey": 0,
"Regex": "abc",
"Tip": "abc"
}
}
],
"FileType": "abc",
"SelectFilePath": true,
"ExcludeCommonLib": true,
"PostHooks": "abc"
},
"BrokerIp": "abc",
"ClusterId": "abc",
"MinDateTime": "abc",
"MaxDateTime": "abc",
"ExecutionTTL": 0,
"SelfDepend": 0,
"LeftCoordinate": 0,
"TopCoordinate": 0,
"TaskExt": {
"TaskId": "abc",
"Properties": [
{
"ParamKey": "abc",
"ParamValue": "abc"
}
]
},
"Properties": "abc",
"Notes": "abc",
"InstanceInitStrategy": "abc",
"YarnQueue": "abc",
"Alarms": [
{
"AlarmId": "abc",
"TaskId": "abc",
"Status": 0,
"AlarmType": "abc",
"AlarmWay": "abc",
"Creator": "abc",
"AlarmRecipient": "abc",
"AlarmRecipientId": "abc",
"ModifyTime": "abc",
"LastFailTime": "abc",
"LastOverTime": "abc",
"LastAlarmTime": "abc",
"AlarmExt": [
{
"AlarmId": "abc",
"PropName": "abc",
"PropValue": "abc",
"CreateTime": "abc",
"ModifyTime": "abc"
}
],
"CreateTime": "abc"
}
],
"Alarm": "abc",
"ScriptChange": true,
"Submit": true,
"LastSchedulerCommitTime": "abc",
"NormalizedJobStartTime": "abc",
"RecoverFreezeStartTime": "abc",
"SourceServer": "abc",
"TargetServer": "abc",
"Creater": "abc",
"DependencyRel": "abc",
"DependencyWorkflow": "abc",
"EventListenerConfig": "abc",
"EventPublisherConfig": "abc",
"DependencyConfigList": [
{
"MainCyclicConfig": "abc",
"SubordinateCyclicConfig": "abc",
"DependencyStrategy": {
"PollingNullStrategy": "abc"
}
}
],
"VirtualTaskStatus": "abc",
"RecycleTips": "abc",
"RecycleUser": "abc",
"NewOrUpdate": "abc",
"Params": [
{
"TaskId": "abc",
"ParamKey": "abc",
"ParamDefine": "abc",
"ParamValue": "abc",
"CreateTime": "abc",
"UpdateTime": "abc"
}
],
"TaskLinkInfo": [
{
"TaskTo": "abc",
"TaskFrom": "abc",
"LinkType": "abc",
"LinkKey": "abc",
"Id": "abc",
"InCharge": "abc",
"LinkDependencyType": "abc",
"Offset": 0,
"WorkflowId": "abc",
"RealFromTaskId": "abc",
"RealFromTaskName": "abc",
"RealFromWorkflowId": "abc",
"RealFromWorkflowName": "abc",
"RealProjectId": "abc",
"RealProjectIdent": "abc",
"RealProjectName": "abc"
}
],
"ImportResult": true,
"ImportErrMsg": "abc",
"ContentType": "abc",
"TaskAutoSubmit": true,
"ProductName": "abc",
"OwnId": "abc",
"UserId": "abc",
"TenantId": "abc",
"UpdateUser": "abc",
"UpdateTime": "abc",
"UpdateUserId": "abc",
"SchedulerDesc": "abc",
"ResourceGroup": "abc",
"VersionDesc": "abc",
"LinkId": "abc",
"UserFileId": "abc"
}
],
"Creater": "abc",
"DependencyRel": "abc",
"DependencyWorkflow": "abc",
"EventListenerConfig": "abc",
"EventPublisherConfig": "abc",
"DependencyConfigList": [
{
"MainCyclicConfig": "abc",
"SubordinateCyclicConfig": "abc",
"DependencyStrategy": {
"PollingNullStrategy": "abc"
}
}
],
"VirtualTaskStatus": "abc",
"RecycleTips": "abc",
"RecycleUser": "abc",
"NewOrUpdate": "abc",
"Params": [
{
"TaskId": "abc",
"ParamKey": "abc",
"ParamDefine": "abc",
"ParamValue": "abc",
"CreateTime": "abc",
"UpdateTime": "abc"
}
],
"TaskLinkInfo": [
{
"TaskTo": "abc",
"TaskFrom": "abc",
"LinkType": "abc",
"LinkKey": "abc",
"Id": "abc",
"InCharge": "abc",
"LinkDependencyType": "abc",
"Offset": 0,
"WorkflowId": "abc",
"RealFromTaskId": "abc",
"RealFromTaskName": "abc",
"RealFromWorkflowId": "abc",
"RealFromWorkflowName": "abc",
"RealProjectId": "abc",
"RealProjectIdent": "abc",
"RealProjectName": "abc"
}
],
"ImportResult": true,
"ImportErrMsg": "abc",
"ContentType": "abc",
"TaskAutoSubmit": true,
"ProductName": "abc",
"OwnId": "abc",
"UserId": "abc",
"TenantId": "abc",
"UpdateUser": "abc",
"UpdateTime": "abc",
"UpdateUserId": "abc",
"SchedulerDesc": "abc",
"ResourceGroup": "abc",
"VersionDesc": "abc",
"LinkId": "abc",
"UserFileId": "abc"
}
],
"Creater": "abc",
"DependencyRel": "abc",
"DependencyWorkflow": "abc",
"EventListenerConfig": "abc",
"EventPublisherConfig": "abc",
"DependencyConfigList": [
{
"MainCyclicConfig": "abc",
"SubordinateCyclicConfig": "abc",
"DependencyStrategy": {
"PollingNullStrategy": "abc"
}
}
],
"VirtualTaskStatus": "abc",
"RecycleTips": "abc",
"RecycleUser": "abc",
"NewOrUpdate": "abc",
"Params": [
{
"TaskId": "abc",
"ParamKey": "abc",
"ParamDefine": "abc",
"ParamValue": "abc",
"CreateTime": "abc",
"UpdateTime": "abc"
}
],
"TaskLinkInfo": [
{
"TaskTo": "abc",
"TaskFrom": "abc",
"LinkType": "abc",
"LinkKey": "abc",
"Id": "abc",
"InCharge": "abc",
"LinkDependencyType": "abc",
"Offset": 0,
"WorkflowId": "abc",
"RealFromTaskId": "abc",
"RealFromTaskName": "abc",
"RealFromWorkflowId": "abc",
"RealFromWorkflowName": "abc",
"RealProjectId": "abc",
"RealProjectIdent": "abc",
"RealProjectName": "abc"
}
],
"ImportResult": true,
"ImportErrMsg": "abc",
"ContentType": "abc",
"TaskAutoSubmit": true,
"ProductName": "abc",
"OwnId": "abc",
"UserId": "abc",
"TenantId": "abc",
"UpdateUser": "abc",
"UpdateTime": "abc",
"UpdateUserId": "abc",
"SchedulerDesc": "abc",
"ResourceGroup": "abc",
"VersionDesc": "abc",
"LinkId": "abc",
"UserFileId": "abc"
},
"TaskInputParam": [
{
"Id": 0,
"TaskId": "abc",
"ParamKey": "abc",
"ParamDesc": "abc",
"FromTaskId": "abc",
"FromParamKey": "abc",
"CreateTime": "abc",
"UpdateTime": "abc",
"FromTaskName": "abc",
"FromProjectId": "abc",
"FromProjectName": "abc"
}
],
"TaskOutputParam": [
{
"Id": 0,
"TaskId": "abc",
"ParamKey": "abc",
"ParamDesc": "abc",
"ParamDefine": "abc",
"CreateTime": "abc",
"UpdateTime": "abc",
"TaskName": "abc",
"ProjectId": "abc",
"ProjectName": "abc"
}
],
"ApproveStatus": "abc"
},
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |