1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
按行下载日志信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DownloadLogByLine。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
StartLine | 是 | Integer | 开始行 示例值:1 |
LineCount | 是 | Integer | 读取行 示例值:11 |
ProjectId | 是 | String | 项目id 示例值:11 |
TaskId | 否 | String | 任务id 示例值:11 |
CurRunDate | 否 | String | 实例运行时间 示例值:2022-01-24 12:12:12 |
DetailId | 否 | String | 任务详情id,用于读取切分的日志文件 示例值:11 |
FilePath | 否 | String | base64编码的文件路径 示例值:/12e |
RecordId | 否 | String | 任务记录id 示例值:123 |
SubJobId | 否 | String | 子job id 示例值:123 |
JobType | 否 | String | hiveSql:34,sparkSql:36 dlcSql: 32 示例值:32 |
ParseErrorTip | 否 | Boolean | true:解析错误信息。false:不解析错误信息 示例值:false |
FileType | 否 | Integer | log 0 code 1 result 2 custo 3 示例值:0 |
QueryFileFlag | 否 | Integer | 查询文件标志:0: 从执行机获取,1: 从cos获取,获取不到会再从执行机获取 示例值:0 |
ExtInfo | 否 | String | 透传字段,如果queryFileFlag为1,则ext回作为上一页的分页标识offset 示例值:11 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | InstanceLogByLine | 日志信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 下载日志信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DownloadLogByLine
<公共请求参数>
{
"TaskId": "123",
"CurRunDate": "123",
"DetailId": "123",
"StartLine": 0,
"LineCount": 0,
"FilePath": "123",
"ProjectId": "123",
"RecordId": "123"
}
输出示例
{
"Response": {
"Data": {
"Count": 0,
"Content": [
"123"
],
"Over": true,
"InstanceState": "123",
"InstanceId": "123",
"TaskId": "123",
"WorkerType": 0
},
"RequestId": "123"
}
}
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 | 未登录或登录已过期。 |
AuthFailure.UnauthorizedOperation | CAM未授权,请联系主账号到CAM中授权QcloudWeDataFullAccess策略给该账户。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.CallSchedulerApiError | 外部系统调用异常。 |
InternalError.InternalCallCloudApiError | 调用云API失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.AlarmReceiveAddressNotExist | 告警接收地址不存在。 |
InvalidParameter.ClientIpNotAuthorized | ClientIp未被授权。 |
InvalidParameter.DataEngineInstanceNotExists | 数据引擎实例不存在。 |
InvalidParameter.DuplicateName | 名称重复。 |
InvalidParameter.InvalidAlarmUrl | 告警接收地址不合法。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.UserNotInProject | 用户不是当前项目成员。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |