1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
保存任务信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UploadContent。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ScriptRequestInfo | 是 | ScriptRequestInfo | 脚本上传信息 |
RequestFromSource | 否 | String | 请求来源,WEB 前端;CLIENT 客户端 |
ProjectId | 否 | String | 项目id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ScriptInfo | ScriptInfoResponse | 脚本信息响应 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 UploadContent 示例
开发空间-保存任务信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UploadContent
<公共请求参数>
{
"ScriptRequestInfo": {
"FilePath": "/datastudio/personal/shell1234.sh",
"ProjectId": "1485413914375667333",
"Operation": "create",
"ExtraInfo": "{\"taskId\":\"ap-shanghai|wedata-agent-sh-1257305432|/datastudio/personal/shell1234.sh\"}",
"BucketName": "wedata-agent-sh-1257305432",
"Region": "ap-shanghai",
"FileExtensionType": "sh"
},
"RequestFromSource": "WEB"
}
输出示例
{
"Response": {
"RequestId": "b24bf87c-c391-42cc-a41e-077f946bdff1",
"ScriptInfo": {
"Bucket": "wedata-agent-sh-1257305432",
"CreateTime": "2024-04-10 10:38:15",
"ExtraInfo": "{\"taskId\":\"ap-shanghai|wedata-agent-sh-1257305432|/datastudio/personal/shell1234.sh\"}",
"FileExtensionType": "sh",
"FileName": "shell1234.sh",
"LocalPath": "/datastudio/personal/shell1234.sh",
"LocalTempPath": null,
"Md5Value": null,
"Owner": "100028649733",
"OwnerName": "demo",
"PathDepth": null,
"ProjectId": "100028649733",
"Region": "ap-shanghai",
"RemotePath": "/datastudio/personal/100028649733/shell1234.sh",
"ResourceId": "3342446a-d046-4a97-9fe6-3c5dd9866ba4",
"Size": null,
"Type": "personal",
"UpdateTime": "2024-04-10 10:38:15",
"ZipPath": null
}
}
}
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.SignatureExpire | 未登录或登录已过期。 |
FailedOperation | 操作失败。 |
FailedOperation.NoLock | 查询数据开发资源锁状态-当前用户不持有锁 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DataEngineInstanceNotExists | 数据引擎实例不存在。 |
MissingParameter | 缺少参数错误。 |