查询Flink作业事件详情列表 - ListFlinkJobEvents
功能介绍
查询Flink作业的运行事件列表。此接口为同步接口,响应中包含作业运行期间产生的事件详情,可用于问题定位和运行状态追踪。
可通过查看Flink作业详情接口获取作业完整信息,或通过查询Flink作业状态接口获取作业当前运行状态。
调用方法
请参见如何调用API。
URI
GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id}/events
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 是 | String | 参数解释:工作空间ID,用于资源隔离。获取方法请参见获取工作空间ID。 约束限制:不涉及。 取值范围:只能由英文字母、数字及中划线组成,且长度为32~36个字符。 默认取值:不涉及。 |
| job_id | 是 | String | 参数解释:Flink作业ID,用于唯一标识一个Flink作业,可通过查询Flink作业列表接口获取。 约束限制:不涉及。 取值范围:采用UUIDv7格式,固定36个字符。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释:索引位置偏移量,用于分页查询,从0开始。 约束限制:不涉及。 取值范围:0~100000之间的整数。 默认取值:0。 |
| limit | 否 | Integer | 参数解释:查询返回的记录数,用于分页查询。 约束限制:不涉及。 取值范围:1~1000之间的整数。 默认取值:100。 |
| create_time_after | 否 | Long | 参数解释:筛选起始时间(包含),用于按创建时间筛选。 约束限制:不涉及。 取值范围:0~4102416000000,13位毫秒时间戳。 默认取值:不涉及。 |
| create_time_before | 否 | Long | 参数解释:筛选结束时间(包含),用于按创建时间筛选。 约束限制:不涉及。 取值范围:0~4102416000000,13位毫秒时间戳。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token,用于接口认证鉴权,可通过调用获取IAM用户Token接口获取。 约束限制:不涉及。 取值范围:长度不超过65534个字符。 默认取值:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Integer | 参数解释:作业事件总个数。 取值范围:0~2147483647。 |
| job_events | Array of FlinkJobEvent objects | 参数解释:Flink作业事件列表。可显示0~1000个FlinkJobEvent对象。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| event_id | String | 参数解释:运行事件ID。 取值范围:UUIDv7格式,固定36位,由英文小写字母、数字及中划线组成。 |
| create_time | Long | 参数解释:事件创建时间戳。 取值范围:0~4102416000000,13位毫秒时间戳。 |
| event_name | String | 参数解释:运行事件名称。 取值范围:1~128个字符。 |
| event_message | String | 参数解释:运行事件信息。 取值范围:0~1024个字符。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码,用于标识具体的错误类型。 取值范围:长度为1~256个字符。 |
| error_msg | String | 参数解释:错误描述信息,用于说明错误原因。 取值范围:长度为1~1024个字符。 |
| solution_msg | String | 参数解释:解决建议,用于提供错误的解决方案。 取值范围:长度为0~1024个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码,用于标识具体的错误类型。 取值范围:长度为1~256个字符。 |
| error_msg | String | 参数解释:错误描述信息,用于说明错误原因。 取值范围:长度为1~1024个字符。 |
| solution_msg | String | 参数解释:解决建议,用于提供错误的解决方案。 取值范围:长度为0~1024个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码,用于标识具体的错误类型。 取值范围:长度为1~256个字符。 |
| error_msg | String | 参数解释:错误描述信息,用于说明错误原因。 取值范围:长度为1~1024个字符。 |
| solution_msg | String | 参数解释:解决建议,用于提供错误的解决方案。 取值范围:长度为0~1024个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码,用于标识具体的错误类型。 取值范围:长度为1~256个字符。 |
| error_msg | String | 参数解释:错误描述信息,用于说明错误原因。 取值范围:长度为1~1024个字符。 |
| solution_msg | String | 参数解释:解决建议,用于提供错误的解决方案。 取值范围:长度为0~1024个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码,用于标识具体的错误类型。 取值范围:长度为1~256个字符。 |
| error_msg | String | 参数解释:错误描述信息,用于说明错误原因。 取值范围:长度为1~1024个字符。 |
| solution_msg | String | 参数解释:解决建议,用于提供错误的解决方案。 取值范围:长度为0~1024个字符。 |
请求示例
查询指定Flink作业的运行事件详情列表,用于问题定位和运行状态追踪。
GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id}/events?offset=0&limit=10 响应示例
状态码:200
{
"count" : 1,
"job_events" : [ {
"event_id" : "019f6a01-7d2e-xxxx-xxxx-9b1f4e5a6b7c",
"create_time" : 1705896000000,
"event_name" : "CREATE",
"event_message" : "user(testuser) create new job, wait for start"
} ]
} 状态码:400
{
"error_code" : "AIDataLake.01011001",
"error_msg" : "Invalid parameter",
"solution_msg" : "Please check the input parameters according to the documentation."
} 状态码:401
{
"error_code" : "AIDataLake.01011003",
"error_msg" : "Auth Token not exists in header",
"solution_msg" : "Please check if auth Token is included in the request header."
} 状态码:403
{
"error_code" : "AIDataLake.01011005",
"error_msg" : "Current account has no permission",
"solution_msg" : "Please connect administrators to add permission."
} 状态码:404
{
"error_code" : "AIDataLake.01051001",
"error_msg" : "Flink job 019f609a-e90c-xxxx-xxxx-a4ec9018e7f2 does not exist",
"solution_msg" : "Please check if Flink job 019f609a-e90c-xxxx-xxxx-a4ec9018e7f2 is entered correctly or has been deleted."
} 状态码:500
{
"error_code" : "AIDataLake.01010001",
"error_msg" : "Internal system error",
"solution_msg" : "Contact operations for analysis."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 请求参数错误。 |
| 401 | 认证失败。 |
| 403 | 权限不足。 |
| 404 | Flink作业不存在。 |
| 500 | 系统内部错误。 |