DNSPod
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > DNSPod > API 文档 > 批量操作相关接口 > 获取任务详情

获取任务详情

最近更新时间：2024-03-12 01:26:29

我的收藏

本页目录：

1. 接口描述

接口请求域名： dnspod.tencentcloudapi.com 。

获取任务详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBatchTask。
Version 是 String 公共参数，本接口取值：2021-03-23。
Region 否 String 公共参数，本接口不需要传递此参数。
JobId 是 Integer 任务ID。操作批量接口时会返回JobId
示例值：21

3. 输出参数

参数名称 类型 描述
DetailList Array of DescribeBatchTaskDetail 批量任务详情
TotalCount Integer 总任务条数
示例值：2
SuccessCount Integer 成功条数
示例值：2
FailCount Integer 失败条数
示例值：0
JobType String 批量任务类型
示例值：record_modify
CreatedAt String 任务创建时间
示例值：2021-04-02 15:57:14
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取任务详情

获取任务详情

输入示例

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

{
    "JobId": 69
}

输出示例

{
    "Response": {
        "RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166",
        "DetailList": [
            {
                "RecordList": [
                    {
                        "RecordLine": "默认",
                        "TTL": 600,
                        "MX": 23,
                        "RecordId": 178,
                        "SubDomain": "test",
                        "RecordType": "MX",
                        "Value": "test.aaaaaaa.com.",
                        "Enabled": 1,
                        "Status": "ok",
                        "ErrMsg": null,
                        "Id": 0,
                        "Operation": "edit"
                    }
                ],
                "DomainId": 49,
                "Domain": "dnsapi1.cn",
                "ErrMsg": null,
                "Status": "ok",
                "Operation": null,
                "DomainGrade": "DP_FREE",
                "Id": 0
            }
        ],
        "TotalCount": 1,
        "SuccessCount": 1,
        "FailCount": 0,
        "JobType": "record_modify",
        "CreatedAt": "2021-04-07 15:28:31"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.NotBatchTaskOwner 权限错误，您无法查看该任务的详情。
FailedOperation.UnknowError 操作未响应，请稍后重试。
InvalidParameter.BatchTaskNotExist 任务不存在，无法获取任务详情。
InvalidParameter.ParamsIllegal 参数不合法，请求被拒绝。
中国站