获取任务模板

最近更新时间:2018-11-08 20:28:45

1. 接口描述

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

用于查询任务模板信息

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskTemplates
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
TaskTemplateIds.N Array of String 任务模板ID
Filters.N Array of Filter 过滤条件
  • task-template-name - String - 是否必填:否 -(过滤条件)按照任务模板名称过滤。
  • 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": {
        "RequestId": "23f7d202-1cd4-4658-a989-88ad4ed77aac",
        "TaskTemplateSet": [
          {
            "CreateTime": "2018-03-08T03:27:43Z",
            "TaskTemplateDescription": "3ds Max 2018 Demo",
            "TaskTemplateId": "task-tmpl-pq24rq1e",
            "TaskTemplateInfo": {
              "Application": {
                "Command": "3dsmaxcmd Demo.max -outputName:c:\\\\render\\\\image.jpg",
                "DeliveryForm": "PACKAGE",
                "PackagePath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/render/max.tar.gz"
              },
              "ComputeEnv": {
                "EnvData": {
                  "DataDisks": [
                    {
                      "DiskSize": "0",
                      "DiskType": "CLOUD_BASIC"
                    }
                  ],
                  "ImageId": "img-i64lx84h",
                  "InstanceType": "S1.LARGE8",
                  "InternetAccessible": {
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": "10"
                  },
                  "LoginSettings": {
                    "Password": "B1habcdB1habcd"
                  },
                  "SystemDisk": {
                    "DiskSize": "50",
                    "DiskType": "CLOUD_BASIC"
                  }
                },
                "EnvType": "MANAGED"
              },
              "FailedAction": "TERMINATE",
              "MaxRetryCount": 0,
              "OutputMappings": [
                {
                  "DestinationPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/",
                  "SourcePath": "C:\\\\render\\\\"
                }
              ],
              "RedirectInfo": {
                "StderrRedirectPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/wonderflet/logs/",
                "StdoutRedirectPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/wonderflet/logs/"
              },
              "TaskInstanceNum": 1,
              "TaskName": "rendering",
              "Timeout": 259200
            },
            "TaskTemplateName": "rendering"
          },
          {
            "CreateTime": "2018-01-25T07:46:12Z",
            "TaskTemplateDescription": "",
            "TaskTemplateId": "task-tmpl-606i415o",
            "TaskTemplateInfo": {
              "Application": {
                "Command": "python -c \"fib=lambda n:1 if n&lt=2 else fib(n-1)+fib(n-2); print(fib(20))\" ",
                "DeliveryForm": "LOCAL"
              },
              "Authentications": [
                {
                  "Scene": "COS",
                  "SecretId": "AKIDHS4Zs1esoxBRkwqugIiyDTfkjXIsvn6M",
                  "SecretKey": "SlxCco25zhH0dabfhYDqyym4ED0PglgZ"
                }
              ],
              "ComputeEnv": {
                "EnvData": {
                  "ImageId": "img-bq1gnde2",
                  "InstanceType": "S1.SMALL1"
                },
                "EnvType": "MANAGED"
              },
              "FailedAction": "TERMINATE",
              "MaxRetryCount": 0,
              "RedirectInfo": {
                "StderrRedirectPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/hello2/logs/",
                "StdoutRedirectPath": "cos://bucket-appid.cos.ap-guangzhou.myqcloud.com/hello2/logs/"
              },
              "TaskInstanceNum": 2,
              "TaskName": "A"
            },
            "TaskTemplateName": "A"
          }
        ],
        "TotalCount": 2
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

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