1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
下载日志文件,返回日志下载URL
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstanceLogFile。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectId | 是 | String | 项目ID 示例值:"1485413914375667" |
TaskId | 是 | String | 任务ID 示例值:"19920226154637701" |
CurRunDate | 是 | String | 实例数据时间 示例值:"2024-04-09 00:00:00" |
RequestFromSource | 否 | String | 请求来源,WEB 前端;CLIENT 客户端 |
BrokerIp | 否 | String | 执行机IP 示例值:"172.16.1.119" |
OriginFileName | 否 | String | 日志文件名 示例值:"20230309190426-9-all-log-0.20230309190612.log" |
ExecutionJobId | 否 | String | 执行平台下发执行id |
LogLevelType | 否 | String | 日志级别,Info/Debug/Warn/Error/All |
ExecutionFileType | 否 | String | 文件类型,Log/Code |
InstanceLifeDetailDtoList.N | 否 | Array of InstanceLifeDetailDto | 生命周期为基础数据进行日志匹配。Dynamic=true动态获取日志链路中使用 |
CurrentLifeRound | 否 | Integer | 当前生命周期数 示例值:1 |
Tries | 否 | Integer | 当前生命周期重试次数 示例值:1 |
Dynamic | 否 | Boolean | 动态获取日志信息标识 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | InstanceDownloadLogInfo | 下载文件详情 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"FileName":"20230309190426-9-all-log-0.20230309190612.log","FileUrl":"https://dev-downloadlog-1257305158.cos.ap-xxx"} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功下载日志文件
成功下载日志文件
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceLogFile
<公共请求参数>
{
"ProjectId": "1",
"TaskId": "20230309190527020",
"CurRunDate": "2023-03-09 19:04:26",
"BrokerIp": "1315051789_vpc-8i88z8fg_30.0.32.31",
"OriginFileName": "20230309190426-9-all-log-0.20230309190612.log"
}
输出示例
{
"Response": {
"Data": {
"FileName": "20230309190426-9-all-log-0.20230309190612.log",
"FileUrl": "https://dev-downloadlog-1257305158.cos.ap-nanjing.myqcloud.com/20230309190527020/20230309190426/32204025/20230309190426-9-all-log-0.20230309190612.log?sign=q-sign-algorithm%3Dsha1%26q-ak%3D***_DhCfOuRtaa2-gkeJ06H9V2pOLPKYIdk7REPhJocXdJAnl9-HNfYg7Rk66AIX%26q-sign-time%3D1679625235%3B1679632435%26q-key-time%3D1679625235%3B1679632435%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3Daf2ed79c7626b6d73267e21cdeb5ec2c49b297c9&x-cos-security-token=oiXbaVVDKQNIvn1iBdyP5WRb8mnRa1Sa904dcfb5c94d0b68b8ed93658db45d39xWvJ6WUavmuP95kWvVjD6MJkv2423k-XlPlxdr39s6hcYGZa8pvG22I8dgtL8VtqZOeDNhuUnFOb07Cp3M8rmKNb3n5ykP295uKpVnAyKoUADmIk3-iV_FLqsyC4333AUeILLaoVps43jPrqKJnY7ELrYJfplQdUwvS2oR3wtaAbmxkreZOhSM0L_4haRpG4mmJ1YD1UBtk8Cb7F4EtC6bSvopILDEAMprf6PUjm79LdywGdklI7eQRy4iv2CiurbYUBteziJ3U3P82Q3gIAQhRTV3XEkFnEfznyYuSRfPm2hgEHBVgOz-3TscNx9SU9Tx2LyCunLSmAmiU3txNhhhqHvyGJKrzWvKUUzBAIaj50s3uWvDCL3x8a3cPn9VHKXmpozcBxFnA5ES2_BemtuGgfjph49Tkcu73DS5YGiL2WagOlVXvxRGgH_g6SZDtedF1XUFjYjPxtRpQ9qfKeRYrZk6Jk65x4QUTrz7uRFv1E4NUk7B5Krus5jaSQb4peiZfNzJwdJA3En1K4ulqS69R-0WxsThn40Xb_DLc3ECMwrV4B69vR8_9wP0xSrIylvF630sGLIHljXsYdmZ4XCIwV061-NxDvlauHzxC9XFp1ercFiaQ3bdBkDPlC4ZfBud5RIXM-SpLRGVM2guifcWz6P4He8D_UPAKxRujw6hU7YhJy2CfSQEQJXPw4Nrog"
},
"RequestId": "b6ed50b1-69f7-415c-9359-7a2576435b0f"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |