查询Flink作业自动调优历史 - ListFlinkJobAutoscalingHistories
功能介绍
查询Flink作业自动调优历史记录,包含每次扩缩容操作的详细信息。此接口为同步接口,支持分页查询。
调用方法
请参见如何调用API。
URI
GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id}/autoscaling-histories
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token,用于接口认证鉴权,可通过调用获取IAM用户Token接口获取。 约束限制:不涉及。 取值范围:长度不超过65534个字符。 默认取值:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| autoscaling_histories | Array of AutoscalingHistory objects | 参数解释:调优历史记录列表。 |
| count | Integer | 参数解释:调优历史记录总数。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tuning_id | String | 参数解释:调优记录唯一ID。 取值范围:UUID格式,长度为36个字符。 |
| job_id | String | 参数解释:Flink作业ID。 取值范围:UUIDv7格式,长度为36个字符。 |
| action_type | String | 参数解释:调优动作类型。 取值范围: |
| tuning_message | String | 参数解释:调优消息,国际化字符串,人类可读,不建议程序化解析。 取值范围:不涉及。 |
| old_resource_setting | old_resource_setting object | 参数解释:变更前的资源配置。 取值范围:不涉及。 |
| new_resource_setting | new_resource_setting object | 参数解释:变更后的资源配置。 取值范围:不涉及。 |
| trigger_time | String | 参数解释:调优触发时间,格式为ISO 8601标准的UTC日期时间字符串。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| parallelism | Map<String,Integer> | 参数解释:变更前各算子的并行度,key为算子ID,value为并行度。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| parallelism | Map<String,Integer> | 参数解释:变更后各算子的并行度,key为算子ID,value为并行度。 取值范围:不涉及。 |
状态码: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个字符。 |
请求示例
查询作业自动调优历史,返回最近10条记录。
GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id}/autoscaling-histories?offset=0&limit=10 响应示例
状态码:200
{
"autoscaling_histories" : [ {
"tuning_id" : "a1b2c3d4-e5f6-xxxx-xxxx-ef1234567890",
"job_id" : "01a038e4-4be8-xxxx-xxxx-c306ca6d2ade",
"action_type" : "SCALE_OUT",
"old_resource_setting" : {
"parallelism" : {
"source" : 2,
"filter" : 2
}
},
"new_resource_setting" : {
"parallelism" : {
"source" : 4,
"filter" : 4
}
},
"tuning_message" : "dae3eb9dfe017c04da35c041f0e70581并行度从2扩容至4",
"trigger_time" : "2026-08-25T10:30:00.000+00:00"
} ],
"count" : 15
} 状态码: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 | 系统内部错误。 |