1. 接口描述
接口请求域名： oceanus.tencentcloudapi.com 。
查询作业实例启动日志
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeJobSubmissionLog。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 作业ID，例如：cql-6v1jkxrn 示例值：cql-ebgioapf |
| StartTime | 是 | Integer | 起始时间，unix时间戳，毫秒级，例如：1611754219108 示例值：1585749042 |
| EndTime | 是 | Integer | 结束时间，unix时间戳，毫秒级，例如：1611754219108 示例值：1585749042 |
| RunningOrderId | 否 | Integer | 作业运行的实例ID, 例如：1,2,3。默认为0，表示未选中任何实例，搜索该时间段内最近的一个实例的日志 示例值：0 |
| Keyword | 否 | String | 日志搜索的关键词，默认为空 |
| Cursor | 否 | String | 日志搜索的游标，可透传上次返回的值，默认为空 |
| OrderType | 否 | String | 时间戳排序规则，asc - 升序，desc - 降序。默认为升序 示例值：asc |
| Limit | 否 | Integer | 搜索的日志条数上限值，最大为100 示例值：100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Cursor | String | 日志搜索的游标，需要搜索更多时透传这个值 示例值：Y29udGV4dC1hNTI3ZmVhYy01YmE0LTQ5MWMtYjAwZS1kZGQwZWEwZWU2NDAxNTg2 |
| ListOver | Boolean | 是否返回了所有的日志记录 示例值：false |
| JobRequestId | String | 作业启动的requestId 注意：此字段可能返回 null，表示取不到有效值。 示例值：dfd73175-f8d4-4981-8cd3-8072e0a52fbd |
| JobInstanceList | Array of JobInstanceForSubmissionLog | 该时间段内符合关键字的所有的作业实例列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[] |
| LogList | Array of String | 废弃，请使用LogContentList 注意：此字段可能返回 null，表示取不到有效值。 示例值： [ "2020-04-08 11:57:32.703 [queuedThreadPool-57106 |
| LogContentList | Array of LogContent | 日志列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询启动日志
查询启动日志
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeJobSubmissionLog
<公共请求参数>
{
"JobId": "cql-067opv7l",
"RunningOrderId": 1,
"StartTime": 1698044059122,
"EndTime": 1698045059131
}输出示例
{
"Response": {
"Cursor": "",
"JobInstanceList": null,
"JobRequestId": "9acab4fc-d101-47ca-96a6-da08fe3fc130",
"ListOver": true,
"LogContentList": [
{
"ContainerName": "",
"Log": "2023-10-23 14:54:18.158 [pool-1-thread-14] INFO org.apache.flink.kubernetes.utils.KubernetesUtils - Kubernetes deployment requires a fixed port. Configuration blob.server.port will be set to 6124",
"PkgId": "",
"PkgLogId": 0,
"Time": 1698044059131
},
{
"ContainerName": "",
"Log": "2023-10-23 14:54:18.158 [pool-1-thread-14] INFO org.apache.flink.kubernetes.utils.KubernetesUtils - Kubernetes deployment requires a fixed port. Configuration taskmanager.rpc.port will be set to 6122",
"PkgId": "",
"PkgLogId": 0,
"Time": 1698044059131
},
{
"ContainerName": "",
"Log": "2023-10-23 14:54:18.590 [pool-1-thread-14] INFO com.qcloud.oceanus.ca.service.RunJobService - Finish invoking clusterClient.run (run job)",
"PkgId": "",
"PkgLogId": 0,
"Time": 1698044059132
}
],
"LogList": [
"2020-04-08 11:58:35.048 [queuedThreadPool-57106 dfd73175-f8d4-4981-8cd3-8072e0a52fbd cql-ebgioapf 4 20200408115835048] WARN org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducerBase - Overwriting the key.serializer is not recommended"
],
"RequestId": "9270beec-295b-42dd-836b-11ec47b6bff7"
}
}示例2 查询指定job实例的启动日志
持续加载数据
输入示例
https://oceanus.tencentcloudapi.com/?Action=DescribeJobSubmissionLog
&JobId=cql-ebgioapf
&RunningOrderId=1
&StartTime=1586284444
&EndTime=1586327659
&Cursor=Y29udGV4dC0xMzcyM2NmZi03YjAyLTQ2MTgtYWJiOC0zYWQ5ZmU3MzIxMGUxNTg2MzI3OTk0NjEx
&Limit=100
&<公共请求参数>输出示例
{
"Response": {
"Cursor": "Y29udGV4dC1hNTI3ZmVhYy01YmE0LTQ5MWMtYjAwZS1kZGQwZWEwZWU2NDAxNTg2MzI4MTQ4Nzkw",
"JobInstanceList": [],
"JobRequestId": "dfd73175-f8d4-4981-8cd3-8072e0a52fbd",
"ListOver": false,
"LogList": [
"2020-04-08 11:57:32.703 [queuedThreadPool-57106 dfd73175-f8d4-4981-8cd3-8072e0a52fbd cql-ebgioapf 1 20200408115732703] INFO com.tencent.cloud.tstream.flink.toolbox.sql.parse.settings.SettingManager - Registered Setting Handler CHECKPOINT_INTERVAL to CheckpointIntervalHandler for POST_PROCESSING"
],
"LogContentList": [
{
"Log": "2023-09-11 15:37:23.094 [jobmanager-future-thread-4] INFO org.apache.flink.runtime.checkpoint.CheckpointCoordinator - Completed checkpoint 2767 for job 00000000000000000000000000000000 (0 bytes in 269 ms).",
"Time": 1694417844009,
"PkgId": "11CBB7C1649A91DD-1741",
"PkgLogId": 131073,
"ContainerName": "cql-07zmx8tv-318940-64f4dbfcb6-vtf67"
}
],
"RequestId": "db79c5af-adba-484b-8cf0-775e0b0b8070"
}
}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.UnauthorizedOperation | 未授权操作。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.DB | 数据库异常。 |
| InternalError.LogicError | 内部错误。 |
| InvalidParameter.IllegalSearchKeyword | 非法的搜索字符串。 |
| InvalidParameterValue.InvalidLimit | 无效限制错误。 |
| InvalidParameterValue.InvalidTime | 无效时间错误。 |
| ResourceNotFound.Job | 作业不存在。 |
| ResourceNotFound.LogTopic | 找不到日志。 |
| UnsupportedOperation.ClsSqlNotEnabled | Cls Sql未启用。 |
