获取任务模板

最近更新时间:2020-11-18 08:07:48

1. 接口描述

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

用于查询任务模板信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskTemplates。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
TaskTemplateIds.N Array of String 任务模板ID列表,与Filters参数不能同时指定。
Filters.N Array of Filter 过滤条件
  • task-template-name - String - 是否必填:否 -(过滤条件)按照任务模板名称过滤。
  • tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。
  • tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。
  • tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。

  • 与TaskTemplateIds参数不能同时指定。
    Offset Integer 偏移量
    Limit Integer 返回数量

    3. 输出参数

    参数名称 类型 描述
    TaskTemplateSet Array of TaskTemplateView 任务模板列表
    TotalCount Integer 任务模板数量
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询任务模板

    输入示例

    https://batch.tencentcloudapi.com/?Action=DescribeTaskTemplates
    &TaskTemplateIds.0=task-tmpl-pq24rq1e
    &TaskTemplateIds.1=task-tmpl-606i415o
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 2,
        "TaskTemplateSet": [
          {
            "TaskTemplateName": "rendering",
            "TaskTemplateDescription": "3ds Max 2018 Demo",
            "TaskTemplateId": "task-tmpl-pq24rq1e",
            "CreateTime": "2018-03-08T03:27:43Z",
            "Tags": [
              {
                "Key": "batch-test-tag-tp-key",
                "Value": "batch-test-tag-tp-value"
              }
            ],
            "TaskTemplateInfo": {
              "OutputMappings": [
                {
                  "SourcePath": "C:\\\\render\\\\",
                  "DestinationPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/"
                }
              ],
              "TaskInstanceNum": 1,
              "ComputeEnv": {
                "EnvType": "MANAGED",
                "EnvData": {
                  "SystemDisk": {
                    "DiskSize": "50",
                    "DiskType": "CLOUD_BASIC"
                  },
                  "LoginSettings": {
                    "Password": "B1habcdB1habcd"
                  },
                  "InternetAccessible": {
                    "InternetMaxBandwidthOut": "10",
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR"
                  },
                  "ImageId": "img-i64lx84h",
                  "InstanceType": "S1.LARGE8",
                  "DataDisks": [
                    {
                      "DiskSize": "0",
                      "DiskType": "CLOUD_BASIC"
                    }
                  ]
                }
              },
              "RedirectInfo": {
                "StdoutRedirectPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/wonderflet/logs/",
                "StderrRedirectPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/wonderflet/logs/"
              },
              "Application": {
                "Command": "3dsmaxcmd Demo.max -outputName:c:\\\\render\\\\image.jpg",
                "PackagePath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/render/max.tar.gz",
                "DeliveryForm": "PACKAGE"
              },
              "MaxRetryCount": 0,
              "Timeout": 259200,
              "FailedAction": "TERMINATE",
              "TaskName": "rendering"
            }
          },
          {
            "TaskTemplateName": "A",
            "TaskTemplateDescription": "",
            "TaskTemplateId": "task-tmpl-606i415o",
            "CreateTime": "2018-01-25T07:46:12Z",
            "Tags": [
              {
                "Key": "batch-test-tag-tp-key",
                "Value": "batch-test-tag-tp-value"
              }
            ],
            "TaskTemplateInfo": {
              "TaskInstanceNum": 2,
              "ComputeEnv": {
                "EnvType": "MANAGED",
                "EnvData": {
                  "InstanceType": "S1.SMALL1",
                  "ImageId": "img-bq1gnde2"
                }
              },
              "RedirectInfo": {
                "StdoutRedirectPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/hello2/logs/",
                "StderrRedirectPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/hello2/logs/"
              },
              "Application": {
                "Command": "python -c \"fib=lambda n:1 if n&lt=2 else fib(n-1)+fib(n-2); print(fib(20))\" ",
                "DeliveryForm": "LOCAL"
              },
              "MaxRetryCount": 0,
              "FailedAction": "TERMINATE",
              "TaskName": "A"
            }
          }
        ],
        "RequestId": "23f7d202-1cd4-4658-a989-88ad4ed77aac"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter.InvalidParameterCombination 非法的参数组合。
    InvalidParameter.TaskTemplateIdMalformed 非法的任务模板ID格式。
    InvalidParameterValue 参数取值错误。
    UnknownParameter 未知参数错误。
    目录