1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
异步批量创建任务版本
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:BatchCreateTaskVersionAsync。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Tasks.N | 是 | Array of BatchCreateTaskVersionDTO | 任务信息 示例值:taskinfo |
ProjectId | 是 | String | 项目ID 示例值:1470547050521227264 |
AutoRun | 否 | Boolean | 是否自动运行 示例值:FALSE |
AlarmWays | 否 | String | 告警方式:email-邮件;sms-短信;wecom-企业微信 示例值:email |
AlarmRecipientTypes | 否 | String | 告警对象:1-项目管理员,2-任务责任人 示例值:1 |
NeedCheckParentSubmitted | 否 | Boolean | 是否需要校验父任务已经提交到调度 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | BatchTaskOperateNew | 批量操作返回 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchCreateTaskVersionAsync
<公共请求参数>
{
"Tasks": [
{
"TaskId": "20250227112817430",
"VersionRemark": "test"
}
],
"AutoRun": true,
"AlarmWays": "true",
"AlarmRecipientTypes": "all",
"ProjectId": "1470547050521227264"
}
输出示例
{
"Response": {
"Data": {
"JobId": 1
},
"RequestId": "2c66cc14-ea0a-4f25-bb2c-3a315bd9b606"
}
}
示例2 错误示例
错误示例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchCreateTaskVersionAsync
<公共请求参数>
{
"Tasks": [
{
"TaskId": "20230425181533351",
"VersionRemark": "ces"
}
],
"AutoRun": true,
"AlarmWays": "email",
"AlarmRecipientTypes": "2",
"ProjectId": "1470561602745229312"
}
输出示例
{
"Response": {
"Error": {
"Code": "FailedOperation",
"Message": "操作失败"
},
"RequestId": "6218d665-282f-4e43-972a-262dc311618e"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.SignatureExpire | 未登录或登录已过期。 |
FailedOperation | 操作失败。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |