获取实例详情

最近更新时间:2025-09-23 00:18:32

我的收藏

1. 接口描述

接口请求域名: wedata.tencentcloudapi.com 。

调度实例详情

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetTaskInstance。
Version String 公共参数,本接口取值:2025-08-06。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 所属项目id
示例值:2763518183736183934
InstanceKey String 实例唯一标识,可以通过ListInstances获取
示例值:20250807170933305_2025-03-01 00:00:00
TimeZone String 时区timeZone, 传入的时间字符串的所在时区,默认UTC+8
示例值:UTC+8

3. 输出参数

参数名称 类型 描述
Data TaskInstanceDetail 实例详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取任务详情

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTaskInstance
<公共请求参数>

{
    "ProjectId": "1460947878944567296",
    "InstanceKey": "20250714200130106_2025-10-01 00:00:00"
}

输出示例

{
    "Response": {
        "Data": {
            "CostTime": 3000,
            "CurRunDate": "2025-10-01 00:00:00",
            "CycleType": "MONTH_CYCLE",
            "EndTime": "2025-08-27 22:24:40",
            "ExecutorGroupId": "20240222212719833743",
            "ExecutorGroupName": "qfh_test",
            "FolderId": "a1eb11e9-6f1a-11ed-8909-bc97e105ba60",
            "FolderName": "u9ed8u8ba4u6587u4ef6u5939",
            "InstanceKey": "20250714200130106_2025-10-01 00:00:00",
            "InstanceState": "COMPLETED",
            "InstanceType": 0,
            "JobErrorMsg": "",
            "LastUpdateTime": "2025-08-27 22:24:44",
            "OwnerUinList": [
                "100039182306"
            ],
            "ProjectId": "1460947878944567296",
            "SchedulerTime": "2025-10-01 00:00:00",
            "StartTime": "2025-08-27 22:24:37",
            "TaskId": "20250714200130106",
            "TaskName": "u8c03u5ea6u53c2u6570u6d4bu8bd51",
            "TaskType": "Shell",
            "TaskTypeId": 35,
            "TotalRunNum": 10,
            "Tries": 1,
            "TryLimit": 5,
            "WorkflowId": "1f0911b9-032e-4e4f-a564-69e4b871d7e2",
            "WorkflowName": "u8c03u5ea6u53c2u6570u6d4bu8bd5"
        },
        "RequestId": "546eed85-388d-4e81-ad3f-28db7a619d18"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。