1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
更新工作流信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyWorkflowInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目Id 示例值：202131121231312 |
| WorkflowId | 是 | String | 工作流id 示例值：bf2-2f78-11ee-8d13-a4ae120f8272 |
| Owner | 否 | String | 责任人 示例值：jack |
| OwnerId | 否 | String | 责任人id 示例值：102523123 |
| WorkflowDesc | 否 | String | 备注 示例值：备注信息 |
| WorkflowName | 否 | String | 工作流名称 示例值：测试工作流 |
| FolderId | 否 | String | 所属文件夹id 示例值：2f78-11ee-8d13-a4ae120f8272 |
| UserGroupId | 否 | String | 工作流所属用户分组id 若有多个,分号隔开: a;b;c 示例值：1 |
| UserGroupName | 否 | String | 工作流所属用户分组名称 若有多个,分号隔开: a;b;c 示例值：开发组 |
| WorkflowParams.N | 否 | Array of ParamInfo | 工作流参数列表 示例值：[{"ParamValue":"11","ParamKey":"ff"}] |
| GeneralTaskParams.N | 否 | Array of GeneralTaskParam | 用于配置优化参数（线程、内存、CPU核数等），仅作用于Spark SQL节点。多个参数用英文分号分隔。 示例值：[{"Type":"SPARK_SQL","Value":"cc"}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Boolean | true代表成功，false代表失败 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新工作流信息范例
更新工作流信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWorkflowInfo
<公共请求参数>
{
"WorkflowId": "34e51bc4-0cd9-11ed-8909-bc97e105ba60",
"WorkflowName": "测试工作流",
"UserGroupName": "",
"WorkflowParams": [
{
"ParamValue": "11",
"ParamKey": "ff"
}
],
"GeneralTaskParams": [
{
"Type": "SPARK_SQL",
"Value": "cc"
}
],
"ProjectId": "1",
"WorkflowDesc": "ccc",
"UserGroupId": "1",
"Owner": "jack",
"OwnerId": "104293423",
"FolderId": "sdf-ddsef-oge923"
}输出示例
{
"Response": {
"RequestId": "f13c9348-c817-4ff0-b747-1c7581862281",
"Data": true
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。