1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
根据补录计划和补录任务获取补录实例列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOpsMakePlanInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值："1298776544" |
| PlanId | 是 | String | 补录计划ID 示例值："789de4f-bcc7-11ed-b7fc-043f72e73c62" |
| TaskId | 是 | String | 补录任务ID 示例值："200102280231098" |
| PageNumber | 否 | Integer | 分页页码，默认值1 示例值：1 |
| PageSize | 否 | Integer | 分页大小，默认值10 示例值：10 |
| StateList.N | 否 | Array of Integer | 实例状态列表 示例值：[2, 12, 6, 7, 9, 18, 0] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | MakePlanInstanceOpsDtoCollection | 补录计划实例分页查询结果 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取补录计划任务实例
数据补录-获取补录计划任务实例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOpsMakePlanInstances
<公共请求参数>
{
"PageNumber": 1,
"PageSize": 1,
"ProjectId": "147056160274522xxxx",
"PlanId": "e0bed861-0e95-44ca-9d10-28f29752xxxx",
"TaskId": "2023052809431xxxx"
}输出示例
{
"Response": {
"Data": {
"TotalCount": 1,
"TotalPage": 1,
"PageCount": 1,
"PageNumber": 1,
"PageSize": 10,
"Items": [
{
"TaskId": "2002090216540987",
"TaskName": "test_shell_0",
"WorkflowId": null,
"WorkflowName": null,
"InCharge": null,
"CycleType": null,
"CurRunDate": "2024-04-08 00:00:00",
"NextCurDate": null,
"RunPriority": 1,
"TryLimit": 1,
"Tries": 1,
"TotalRunNum": 1,
"DoFlag": 0,
"RedoFlag": 1,
"State": "EXPIRED",
"RuntimeBroker": null,
"ErrorDesc": null,
"TaskType": {
"TypeDesc": null,
"TypeId": 0,
"TypeSort": null
},
"DependenceFulfillTime": null,
"FirstDependenceFulfillTime": null,
"FirstStartTime": null,
"StartTime": null,
"EndTime": "2024-04-09 18:21:36",
"CostTime": "00:00:00.000",
"CostMillisecond": 1,
"MaxCostTime": 1,
"MinCostTime": 1,
"AvgCostTime": 0,
"LastLog": null,
"SchedulerDateTime": null,
"LastSchedulerDateTime": null,
"LastUpdate": null,
"CreateTime": null,
"DependencyRel": null,
"ExecutionSpace": null,
"IgnoreEvent": true,
"VirtualFlag": true,
"FolderId": null,
"FolderName": null,
"SonList": null,
"ProductName": null,
"ResourceGroup": null,
"ResourceInstanceId": null,
"YarnQueue": null,
"SchedulerDesc": null,
"FirstSubmitTime": null,
"FirstRunTime": null,
"ProjectId": null,
"ProjectIdent": null,
"ProjectName": null,
"TenantId": null,
"InstanceKey": null,
"ExecutorGroupId": null,
"ExecutorGroupName": null,
"RelatedInstanceList": [
{
"TaskId": null,
"TaskName": null,
"WorkflowId": null,
"WorkflowName": null,
"InCharge": null,
"CycleType": null,
"CurRunDate": null,
"NextCurDate": null,
"RunPriority": 1,
"TryLimit": 1,
"Tries": 1,
"TotalRunNum": 1,
"DoFlag": 1,
"RedoFlag": 1,
"State": null,
"RuntimeBroker": null,
"ErrorDesc": null,
"TaskType": {
"TypeDesc": null,
"TypeId": 0,
"TypeSort": null
},
"DependenceFulfillTime": null,
"FirstDependenceFulfillTime": null,
"FirstStartTime": null,
"StartTime": "2024-04-09 18:23:48",
"EndTime": null,
"CostTime": null,
"CostMillisecond": 1,
"MaxCostTime": 1,
"MinCostTime": 1,
"AvgCostTime": 0,
"LastLog": null,
"SchedulerDateTime": null,
"LastSchedulerDateTime": null,
"LastUpdate": null,
"CreateTime": null,
"DependencyRel": null,
"ExecutionSpace": null,
"IgnoreEvent": true,
"VirtualFlag": true,
"FolderId": null,
"FolderName": null,
"SonList": null,
"ProductName": null,
"ResourceGroup": null,
"ResourceInstanceId": null,
"YarnQueue": null,
"SchedulerDesc": null,
"FirstSubmitTime": null,
"FirstRunTime": null,
"ProjectId": null,
"ProjectIdent": null,
"ProjectName": null,
"TenantId": null,
"InstanceKey": null,
"ExecutorGroupId": null,
"ExecutorGroupName": null,
"RelatedInstanceList": [
{
"TaskId": null,
"TaskName": null,
"WorkflowId": null,
"WorkflowName": null,
"InCharge": null,
"CycleType": null,
"CurRunDate": null,
"NextCurDate": null,
"RunPriority": 1,
"TryLimit": 1,
"Tries": 1,
"TotalRunNum": 1,
"DoFlag": 1,
"RedoFlag": 1,
"State": null,
"RuntimeBroker": null,
"ErrorDesc": null,
"TaskType": {
"TypeDesc": null,
"TypeId": 0,
"TypeSort": null
},
"DependenceFulfillTime": null,
"FirstDependenceFulfillTime": null,
"FirstStartTime": null,
"StartTime": null,
"EndTime": null,
"CostTime": null,
"CostMillisecond": 1,
"MaxCostTime": 1,
"MinCostTime": 1,
"AvgCostTime": 0,
"LastLog": null,
"SchedulerDateTime": null,
"LastSchedulerDateTime": null,
"LastUpdate": null,
"CreateTime": null,
"DependencyRel": null,
"ExecutionSpace": null,
"IgnoreEvent": true,
"VirtualFlag": true,
"FolderId": null,
"FolderName": null,
"SonList": null,
"ProductName": null,
"ResourceGroup": null,
"ResourceInstanceId": null,
"YarnQueue": null,
"SchedulerDesc": null,
"FirstSubmitTime": null,
"FirstRunTime": null,
"ProjectId": null,
"ProjectIdent": null,
"ProjectName": null,
"TenantId": null,
"InstanceKey": null,
"ExecutorGroupId": null,
"ExecutorGroupName": null,
"RelatedInstanceSize": 0,
"OwnerId": null,
"UserId": null,
"InstanceLifeCycleOpsDto": {
"TaskId": null,
"CurRunDate": null,
"LifeRound": 0,
"RunType": null,
"Tries": 0,
"InstanceLifeDetailDtoList": [
{
"State": null,
"StartTime": null,
"DetailState": null,
"EndTime": null
}
],
"RunnerState": null,
"ErrorDesc": null,
"ErrorCodeLevel": null,
"InstanceLogListOpsDto": {
"TaskId": null,
"CurRunDate": null,
"Tries": null,
"LastUpdate": null,
"BrokerIp": null,
"FileSize": null,
"OriginFileName": null,
"CreateTime": null,
"InstanceLogType": null,
"TaskName": null,
"CostTime": null,
"InstanceStatus": null,
"CodeFileName": null,
"ExtensionInfo": [
{
"Key": null,
"Value": null,
"Description": null
}
]
},
"InstanceState": null
},
"RetryAttempts": 1
}
],
"RelatedInstanceSize": 0,
"OwnerId": null,
"UserId": null,
"InstanceLifeCycleOpsDto": {
"TaskId": null,
"CurRunDate": null,
"LifeRound": 0,
"RunType": null,
"Tries": 0,
"InstanceLifeDetailDtoList": [
{
"State": null,
"StartTime": null,
"DetailState": null,
"EndTime": null
}
],
"RunnerState": null,
"ErrorDesc": null,
"ErrorCodeLevel": null,
"InstanceLogListOpsDto": {
"TaskId": null,
"CurRunDate": null,
"Tries": null,
"LastUpdate": null,
"BrokerIp": null,
"FileSize": null,
"OriginFileName": null,
"CreateTime": null,
"InstanceLogType": null,
"TaskName": null,
"CostTime": null,
"InstanceStatus": null,
"CodeFileName": null,
"ExtensionInfo": [
{
"Key": null,
"Value": null,
"Description": null
}
]
},
"InstanceState": null
},
"RetryAttempts": 1
}
],
"RelatedInstanceSize": 0,
"OwnerId": null,
"UserId": null,
"InstanceLifeCycleOpsDto": {
"TaskId": null,
"CurRunDate": null,
"LifeRound": 0,
"RunType": null,
"Tries": 0,
"InstanceLifeDetailDtoList": [
{
"State": null,
"StartTime": null,
"DetailState": null,
"EndTime": null
}
],
"RunnerState": null,
"ErrorDesc": null,
"ErrorCodeLevel": null,
"InstanceLogListOpsDto": {
"TaskId": null,
"CurRunDate": null,
"Tries": null,
"LastUpdate": null,
"BrokerIp": null,
"FileSize": null,
"OriginFileName": null,
"CreateTime": null,
"InstanceLogType": null,
"TaskName": null,
"CostTime": null,
"InstanceStatus": null,
"CodeFileName": null,
"ExtensionInfo": [
{
"Key": null,
"Value": null,
"Description": null
}
]
},
"InstanceState": null
},
"RetryAttempts": 1
}
]
},
"RequestId": "123"
}
}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 | 操作失败。 |
