# 查看Flink作业详情 - ShowFlinkJob #### 功能介绍 获取Flink作业实例的详细信息。此接口为同步接口，响应中包含作业的完整配置和运行状态信息。 可通过[查询Flink作业事件详情列表](https://support.huaweicloud.com/api-aidatalake/ListFlinkJobEvents.html)接口获取作业运行事件。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-aidatalake/aidatalake_02_0003.html)。 #### URI GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 是 | String | **参数解释** ：工作空间ID，用于资源隔离。获取方法请参见[获取工作空间ID](https://support.huaweicloud.com/api-aidatalake/aidatalake_02_0044.html)。 **约束限制**：不涉及。 **取值范围**：只能由英文字母、数字及中划线组成，且长度为32\~36个字符。 **默认取值**：不涉及。 | | job_id | 是 | String | **参数解释** ：Flink作业ID，用于唯一标识一个Flink作业，可通过[查询Flink作业列表](https://support.huaweicloud.com/api-aidatalake/ListFlinkJobs.html)接口获取。 **约束限制**：不涉及。 **取值范围**：采用UUIDv7格式，固定36个字符。 **默认取值**：不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** ：用户Token，用于接口认证鉴权，可通过调用[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制**：不涉及。 **取值范围**：长度不超过65534个字符。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**：Flink作业ID。 **取值范围**：UUIDv7格式，固定36位，由英文小写字母、数字及中划线组成。 | | client_token | String | **参数解释**：客户端Token，用于接口调用幂等校验。 **取值范围**：长度为1\~64个字符，只能由英文字母、数字、下划线和中划线组成。 | | name | String | **参数解释**：作业名称。 **取值范围**：1\~128个字符，以字母或数字开头和结尾，中间可包含字母、数字、下划线和中划线。 | | deployment_id | String | **参数解释**：已部署作业ID。 **取值范围**：1\~64个字符，支持字母、数字、下划线和中划线。 | | endpoint_id | String | **参数解释**：作业运行的端点ID。 **取值范围**：采用UUID格式，固定36个字符。 | | endpoint_name | String | **参数解释**：作业运行的端点名称。 **取值范围**：只能由英文小写字母、数字及中划线组成，以英文小写字母开头，以英文小写字母或数字结尾，且长度为1\~63个字符。 | | status | [FlinkJobStatus] object | **参数解释**：作业状态信息。 | | job_agency | String | **参数解释**：用户自定义委托名称，用于授权作业访问OBS等外部资源，不指定时默认使用端点委托。 **取值范围**：1\~64个字符。 | | obs_bucket_name | String | **参数解释**：OBS桶名称，用于存储作业的Checkpoint、日志等数据。 **取值范围**：1\~512个字符。 | | job_config | One of: - [ShowFlinkSqlParameterResponse] object - [ShowFlinkJarParameterResponse] object | **参数解释**：作业配置参数，用于指定Flink作业的类型和执行参数。根据作业类型自动选择对应的参数结构：FLINK_SQL_JOB对应ShowFlinkSqlParameterResponse，FLINK_JAR_JOB对应ShowFlinkJarParameterResponse。 | | resource_config | [ShowFlinkResourceConfigResponseBody] object | **参数解释**：资源配置，包含作业的并行度和各组件资源规格。 | | image_config | [ShowFlinkJobImageConfigResponseBody] object | **参数解释**：镜像配置，包含Flink作业运行所需的镜像信息。 | | flink_config | Map\ | **参数解释**：Flink配置参数，为键值对形式。key为Flink配置项名称（如taskmanager.numberOfTaskSlots）；value为对应配置值，长度1\~1024个字符。除用户配置项外，还包含系统自动补充的保留参数（如execution.checkpointing.dir、execution.checkpointing.savepoint-dir、high-availability.storageDir，由系统根据作业配置自动生成）。 | | execution_mode | String | **参数解释**：Flink作业的执行模式。 **取值范围**： - STREAMING：流模式。 - BATCH：批模式。 | | restore_strategy | [ShowRestoreStrategyResponseBody] object | **参数解释**：恢复策略配置，包含Flink作业的状态恢复类型及各类型对应的参数。 | | logging_config | [ShowFlinkLoggingConfigResponseBody] object | **参数解释**：日志配置，包含根目录日志级别和自定义日志类级别。 | | metric | [FlinkResourceMetric] object | **参数解释**：作业指标信息。 | | create_time | Long | **参数解释**：创建时间戳。 **取值范围**：0\~4102416000000，13位毫秒时间戳。 | | create_user | [FlinkCreateUser] object | **参数解释**：创建者信息。 | | update_time | Long | **参数解释**：更新时间戳。 **取值范围**：0\~4102416000000，13位毫秒时间戳。 | | update_user | [FlinkUpdateUser] object | **参数解释**：更新者信息。 | | log_url | String | **参数解释**：日志归档路径OBS URL，用于查看作业执行日志。 **取值范围**：OBS URL格式，长度为1\~1024个字符。 | | labels | Array of [FlinkLabel] objects | **参数解释**：标签，用于作业分类和筛选。 | | description | String | **参数解释**：描述信息。 **取值范围**：1\~512个字符。 | | start_time | Long | **参数解释**：作业开始运行的时间戳（进入RUNNING状态的时间）。 **取值范围**：0 \~ 4102416000000，13位毫秒时间戳。 | | end_time | Long | **参数解释**：作业结束时间戳（进入终态 FINISHED/CANCELLED/FAILED的时间）。 **取值范围**：0 \~ 4102416000000，13位毫秒时间戳。 | 表4FlinkJobStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | state | String | **参数解释**：作业当前状态。 **取值范围**： - CREATED：已创建。 - STARTING：启动中。 - RUNNING：运行中。 - CANCELLING：停止中。 - FAILED：已失败。 - CANCELLED：已停止。 - FINISHED：已完成。 | | state_message | String | **参数解释**：状态消息详情，包含状态变更的补充说明或错误信息。 **取值范围**：0\~1024个字符。 | 表5ShowFlinkSqlParameterResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**：作业类型，用于区分Flink SQL作业和Flink Jar作业。 **取值范围**： - FLINK_SQL_JOB：Flink SQL作业。 | | sql_script_file | String | **参数解释**：SQL脚本所在的OBS文件路径，用于指定SQL作业的脚本文件。 **取值范围**：OBS URL格式，长度为1\~512个字符，以obs://开头。 | | dependency_jars | Array of strings | **参数解释**：SQL作业依赖的JAR包OBS路径列表，用于指定作业运行所需的依赖JAR包，单个路径为OBS URL格式，长度为1\~512个字符，以obs://开头。 | 表6ShowFlinkJarParameterResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**：作业类型，用于区分Flink SQL作业和Flink Jar作业。 **取值范围**： - FLINK_JAR_JOB：Flink Jar作业。 | | main_jar | String | **参数解释**：JAR作业主类所在JAR包的OBS路径，用于指定作业的入口JAR包。 **取值范围**：长度为1\~512个字符，以obs://开头。 | | main_class | String | **参数解释**：JAR作业入口类名称，用于指定作业的入口类。 **取值范围**：长度不超过512个字符。 | | main_args | Array of strings | **参数解释**：JAR作业入口类参数，用于传递运行参数。 | | dependency_jars | Array of strings | **参数解释**：JAR作业依赖JAR包的OBS路径，用于指定作业运行所需的依赖JAR包。 | | dependency_files | Array of strings | **参数解释**：JAR作业依赖文件的OBS路径列表，用于指定作业运行所需的依赖文件。 | 表7ShowFlinkResourceConfigResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | parallelism | Integer | **参数解释**：作业并行度。 **取值范围**：1\~1000。 | | jobmanager_resource_spec | [ShowFlinkResourceSpecResponseBody] object | **参数解释**：JobManager的资源规格，包含CPU、内存、磁盘等信息。 | | taskmanager_resource_spec | [ShowFlinkResourceSpecResponseBody] object | **参数解释**：TaskManager的资源规格，包含CPU、内存、磁盘等信息。 | 表8ShowFlinkResourceSpecResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu | Integer | **参数解释**：CPU毫核数，单位为毫核。 **取值范围**：500\~48000。 | | memory | Integer | **参数解释**：内存大小，单位为MB。 **取值范围**：2048\~393216。 | | disk | Integer | **参数解释**：Pod临时存储容量，单位为GB。 **取值范围**：30\~1024。 | 表9ShowFlinkJobImageConfigResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | image_id | String | **参数解释**：镜像ID，Flink作业运行所使用的镜像。 **取值范围**：长度为2\~64个字符。 | | image_version_id | String | **参数解释**：镜像版本ID，Flink作业运行所使用的镜像版本。 **取值范围**：长度为2\~64个字符。 | | release_version | String | **参数解释**：Flink作业的版本信息，格式为AIDataLake.\<平台版本\>(Flink\,JRE\)，例如AIDataLake.26.9.0(Flink1.20.0,JRE21)。 **取值范围**：长度为1\~512个字符。 | | image_version_type | String | **参数解释**：Flink作业使用的镜像版本类型。 **取值范围**： - STABLE：稳定版。 - RECOMMEND：推荐版。 - BETA：测试版。 | 表10ShowRestoreStrategyResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | restore_type | String | **参数解释**：恢复类型，作业的恢复策略。 **取值范围**： - NONE：无状态启动。 - FROM_SAVEPOINT_ID：从指定Savepoint快照恢复。 - FROM_CHECKPOINT_PATH：从指定Checkpoint路径恢复。 - FROM_SPECIFIED_TIMESTAMP：从指定时间戳恢复。 | | savepoint_id | String | **参数解释**：Savepoint的ID，唯一标识一个快照。当restore_type为FROM_SAVEPOINT_ID时返回。 **取值范围**：UUIDv7格式，固定36位，由英文小写字母、数字及中划线组成。 | | checkpoint_path | String | **参数解释**：Checkpoint的存储路径，指向_metadata文件的上一级目录。仅当restore_type为FROM_CHECKPOINT_PATH时返回。 **取值范围**：1\~512个字符，需以obs://开头。 | | allow_non_restored_state | Boolean | **参数解释**：允许忽略部分算子状态。仅当restore_type为FROM_SAVEPOINT_ID或FROM_CHECKPOINT_PATH时返回。 **取值范围**： - true：允许忽略部分算子状态。设为true时，如果快照中包含当前作业不再使用的算子状态，将跳过这些状态而非报错。 - false：不允许忽略算子状态。 | | job_start_time_in_ms | Long | **参数解释**：源表的数据消费起始时间戳，用于指定作业启动后从源表的哪个时间点开始消费数据。仅当restore_type为FROM_SPECIFIED_TIMESTAMP时返回，且仅支持Kafka源表。 **取值范围**：0\~4102416000000，13位毫秒时间戳。 | 表11ShowFlinkLoggingConfigResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | root_logger_level | String | **参数解释**：根目录日志级别。 **取值范围**： - TRACE：跟踪。 - DEBUG：调试。 - INFO：信息。 - WARN：警告。 - ERROR：错误。 | | log4j_loggers | Array of [ShowFlinkLog4jLoggersResponseBody] objects | **参数解释**：自定义日志类配置列表。 | 表12ShowFlinkLog4jLoggersResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | logger_name | String | **参数解释**：日志类名称。 **取值范围**：1\~256个字符。 | | logger_level | String | **参数解释**：日志级别。 **取值范围**： - TRACE：跟踪。 - DEBUG：调试。 - INFO：信息。 - WARN：警告。 - ERROR：错误。 | 表13FlinkResourceMetric | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_memory | Long | **参数解释**：总内存，单位MB。 **取值范围**：0\~9223372036854775807。 | | total_cpu | Long | **参数解释**：总CPU，单位毫核。 **取值范围**：0\~9223372036854775807。 | | total_disk | Long | **参数解释**：总磁盘容量，单位GB。 **取值范围**：0\~9223372036854775807。 | 表14FlinkCreateUser | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_id | String | **参数解释**：创建者用户ID，用于标识作业的创建者。 **取值范围**：长度为1\~128个字符，只能由英文字母和数字组成。 | | user_name | String | **参数解释**：创建者用户名称，用于显示作业的创建者名称。 **取值范围**：长度为0\~128个字符。 | 表15FlinkUpdateUser | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_id | String | **参数解释**：更新者用户ID，用于标识作业的更新者。 **取值范围**：长度为1\~128个字符，只能由英文字母和数字组成。 | | user_name | String | **参数解释**：更新者用户名称，用于显示作业的更新者名称。 **取值范围**：长度为0\~128个字符。 | 表16FlinkLabel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：标签键。 **取值范围**：1\~128个字符，不支持输入等号。 | | value | String | **参数解释**：标签值。 **取值范围**：1\~512个字符，字符组成不限制。 | **状态码：400** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码，用于标识具体的错误类型。 **取值范围**：长度为1\~256个字符。 | | error_msg | String | **参数解释**：错误描述信息，用于说明错误原因。 **取值范围**：长度为1\~1024个字符。 | | solution_msg | String | **参数解释**：解决建议，用于提供错误的解决方案。 **取值范围**：长度为0\~1024个字符。 | **状态码：401** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码，用于标识具体的错误类型。 **取值范围**：长度为1\~256个字符。 | | error_msg | String | **参数解释**：错误描述信息，用于说明错误原因。 **取值范围**：长度为1\~1024个字符。 | | solution_msg | String | **参数解释**：解决建议，用于提供错误的解决方案。 **取值范围**：长度为0\~1024个字符。 | **状态码：403** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码，用于标识具体的错误类型。 **取值范围**：长度为1\~256个字符。 | | error_msg | String | **参数解释**：错误描述信息，用于说明错误原因。 **取值范围**：长度为1\~1024个字符。 | | solution_msg | String | **参数解释**：解决建议，用于提供错误的解决方案。 **取值范围**：长度为0\~1024个字符。 | **状态码：404** 表20响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码，用于标识具体的错误类型。 **取值范围**：长度为1\~256个字符。 | | error_msg | String | **参数解释**：错误描述信息，用于说明错误原因。 **取值范围**：长度为1\~1024个字符。 | | solution_msg | String | **参数解释**：解决建议，用于提供错误的解决方案。 **取值范围**：长度为0\~1024个字符。 | **状态码：500** 表21响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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} ``` #### 响应示例 **状态码：200** ``` { "job_id" : "019f609a-e90c-xxxx-xxxx-a4ec9018e7f2", "client_token" : "019f8cc4-1cf2-xxxx-xxxx-bf8634076872", "name" : "test-flink-job", "endpoint_id" : "4702a179-xxxx-xxxx-81c3-6cd4d8090671", "endpoint_name" : "test-endpoint", "status" : { "state" : "RUNNING" }, "job_agency" : "test-agency", "obs_bucket_name" : "my-flink-bucket", "job_config" : { "type" : "FLINK_SQL_JOB", "sql_script_file" : "obs://my-flink-bucket/path/to/script.sql" }, "resource_config" : { "parallelism" : 1, "jobmanager_resource_spec" : { "cpu" : 1000, "memory" : 4096, "disk" : 30 }, "taskmanager_resource_spec" : { "cpu" : 1000, "memory" : 4096, "disk" : 30 } }, "image_config" : { "image_id" : "de67c4dc-xxxx-xxxx-xxxx-db12828dab7a", "image_version_id" : "e0ebd72a-xxxx-xxxx-xxxx-1252617297fb", "release_version" : "AIDataLake.26.9.0(Flink1.20.0,JRE21)", "image_version_type" : "STABLE" }, "flink_config" : { "taskmanager.numberOfTaskSlots" : "1", "high-availability.storageDir" : "obs://my-flink-bucket/aidatalake/workspace_57fd5733-xxxx-xxxx-85a9-c6e7f39b1891/flink/endpoint_4702a179-xxxx-xxxx-81c3-6cd4d8090671/jobs/ha/019f609a-e90c-xxxx-xxxx-a4ec9018e7f2", "execution.checkpointing.savepoint-dir" : "obs://my-flink-bucket/aidatalake/workspace_57fd5733-xxxx-xxxx-85a9-c6e7f39b1891/flink/endpoint_4702a179-xxxx-xxxx-81c3-6cd4d8090671/jobs/savepoint/019f609a-e90c-xxxx-xxxx-a4ec9018e7f2", "execution.checkpointing.num-retained" : "6", "execution.checkpointing.dir" : "obs://my-flink-bucket/aidatalake/workspace_57fd5733-xxxx-xxxx-85a9-c6e7f39b1891/flink/endpoint_4702a179-xxxx-xxxx-81c3-6cd4d8090671/jobs/checkpoint/019f609a-e90c-xxxx-xxxx-a4ec9018e7f2" }, "execution_mode" : "STREAMING", "restore_strategy" : { "restore_type" : "NONE" }, "logging_config" : { "root_logger_level" : "INFO" }, "metric" : { "total_cpu" : 2000, "total_memory" : 8192, "total_disk" : 60 }, "create_time" : 1705896000000, "create_user" : { "user_id" : "001", "user_name" : "testuser" }, "update_time" : 1705896000000, "update_user" : { "user_id" : "001", "user_name" : "testuser" }, "log_url" : "obs://my-flink-bucket/aidatalake/workspace_57fd5733-xxxx-xxxx-85a9-c6e7f39b1891/flink/endpoint_4702a179-xxxx-xxxx-81c3-6cd4d8090671/jobs/logs/019f609a-e90c-xxxx-xxxx-a4ec9018e7f2", "description" : "测试Flink作业。", "start_time" : 1705896545546, "end_time" : 0 } ``` **状态码：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 | 系统内部错误。 |