1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
通过 ResourceManager 调用 CLS SearchLog API 查询作业相关日志。不返回总数,使用 Context 进行翻页,ListOver 标识是否还有更多数据。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetRayJobEvent。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Id | 是 | String | ray-job ID 示例值:rayjob-20260323163852-huvy |
| StartTime | 否 | Integer | 开始时间(毫秒时间戳) 示例值:1774256000000 |
| EndTime | 否 | Integer | 结束时间(毫秒时间戳) 示例值:1774259600000 |
| SortFields.N | 否 | Array of SortField | 排序字段列表 |
| Context | 否 | String | 翻页上下文,首次查询不传,后续翻页传入上一次返回的 Context 值 示例值:Y29udGV4dC0xNTIwYjQ0NS1hN2MwLTQxNjQtYTlmYy0wOWYyOWZjMDY2MWQxNzgwMzk0ODU5NTc3 |
| PageSize | 否 | Integer | 分页大小 示例值:1 |
| EventType | 否 | String | 事件类型过滤,仅允许 ASCII 字母(如 Normal、Warning) 示例值:Warning |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Context | String | 翻页上下文,下一次分页请求时传入此值 示例值:Y29udGV4dC1lZTIxMjc0ZS0yZGIyLTRlNjEtYTZmYy1iZDZlZTMzYTdlOGQxNzgwMzk0ODY3MTc1 |
| ListOver | Boolean | 是否已经返回所有符合条件的日志,true 表示已全部返回 示例值:false |
| Events | Array of RayJobEventItem | 事件列表 |
| StartTime | Integer | 事件开始时间 单位:毫秒 示例值:1783411786956 |
| EndTime | Integer | 事件结束时间 单位:毫秒 示例值:1783498186956 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取作业事件
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRayJobEvent
<公共请求参数>
{
"Id": "rayjob-20260323163852-huvy",
"StartTime": 1774256000000,
"EndTime": 1774259600000
}
输出示例
{
"Response": {
"Context": "eyJvZmZzZXQiOjEwfQ==",
"ListOver": false,
"Events": [
{
"EventTime": 1774256065032,
"Component": "RayJob",
"Level": "Normal",
"Message": "Created RayCluster rayjob-xxx"
}
],
"RequestId": "dffa8e31-2df1-4f61-9e88-df82ec7d7ae8"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ExternalService | 外部服务异常 |