查询作业详情 - ShowFlinkJob

功能介绍

查看一个作业的详情信息。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

• 如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。
• 如果使用身份策略授权，需具备如下身份策略权限。

  授权项 Action	访问级别 Access Level	资源类型（*为必须） Resource Type (*: required)	条件键 Condition Key	别名 Alias	依赖的授权项 Dependencies
  dli:jobs:get	read	jobs *	g:ResourceTag/<tag-key>	-	-

URI

• URI格式

  GET /v1.0/{project_id}/streaming/jobs/{job_id}

• 参数说明

  表1 URI参数说明

  参数名称	是否必选	参数类型	说明
  project_id	是	String	项目编号，用于资源隔离。获取方式请参考获取项目ID。
  job_id	是	String	作业ID。

请求消息

无请求参数。

响应消息

请求示例

无

响应示例

• 作业类型为：flink_jar_job，参考响应样例如下：

  {
      "is_success": "true",
      "message": "作业详情查询成功",
      "job_detail": {
          "job_id": 104,
          "user_id": "011c99a26ae84a1bb963a75e7637d3fd",
          "queue_name": "flinktest",
          "project_id": "330e068af1334c9782f4226acc00a2e2",
          "name": "jptest",
          "desc": "",
          "sql_body": "",
          "run_mode": "exclusive_cluster",
          "job_type": "flink_jar_job",
          "job_config": {
              "checkpoint_enabled": false,
              "checkpoint_interval": 10,
              "checkpoint_mode": "exactly_once",
              "log_enabled": false,
              "obs_bucket": null,
              "root_id": -1,
              "edge_group_ids": null,
              "graph_editor_enabled": false,
              "graph_editor_data": "",
              "manager_cu_number": 1,
              "executor_number": null,
              "executor_cu_number": null,
              "cu_number": 2,
              "parallel_number": 1,
              "smn_topic": null,
              "restart_when_exception": false,
              "idle_state_retention": 3600,
              "config_url": null,
              "udf_jar_url": null,
              "dirty_data_strategy": null,
              "entrypoint": "FemaleInfoCollection.jar",
              "execution_agency_urn": "myAgencyName",
              "dependency_jars": [
                  "FemaleInfoCollection.jar",
                  "ObsBatchTest.jar"
              ],
              "dependency_files": [
                  "FemaleInfoCollection.jar",
                  "ReadFromResource"
              ]
          },
          "main_class": null,
          "entrypoint_args": null,
          "execution_graph": null,
          "status": "job_init",
          "status_desc": "",
          "create_time": 1578466221525,
          "update_time": 1578467395713,
          "start_time": null
      }
  }

• 作业类型为：flink_opensource_sql_job，参考响应样例如下：

  {
      "is_success": "true",
      "message": "The job information query succeeds.",
      "job_detail": {
          "job_type": "flink_opensource_sql_job",
          "status_desc": "",
          "create_time": 1637632872828,
          "sql_body": "xxx",
          "savepoint_path": null,
          "main_class": null,
          "queue_name": "xie_container_general",
          "execution_graph": "xxx",
          "start_time": 1638433497621,
          "update_time": 1638449337993,
          "job_config": {
              "checkpoint_enabled": true,
              "checkpoint_interval": 600,
              "checkpoint_mode": "exactly_once",
              "log_enabled": true,
              "obs_bucket": "dli-test",
              "root_id": -1,
              "edge_group_ids": null,
              "graph_editor_enabled": false,
              "graph_editor_data": "",
              "manager_cu_number": 1,
              "executor_number": null,
              "executor_cu_number": null,
              "cu_number": 2,
              "parallel_number": 3,
              "smn_topic": "",
              "restart_when_exception": true,
              "resume_checkpoint": true,
              "resume_max_num": -1,
              "checkpoint_path": null,
              "idle_state_retention": 3600,
              "config_url": null,
              "udf_jar_url": "test/flink_test-1.0-SNAPSHOT-jar-with-dependencies.jar",
              "dirty_data_strategy": "0",
              "entrypoint": "test/flink_test-1.0-SNAPSHOT-jar-with-dependencies.jar",
              "dependency_jars": null,
              "dependency_files": null,
              "tm_cus": 1,
              "tm_slot_num": 3,
              "image": null,
              "feature": null,
              "flink_version": null,
              "operator_config": "xxx",
              "static_estimator_config": "xxx",
              "execution_agency_urn": "myAgencyName",
              "runtime_config": null
          },
          "user_id": "xxx",
          "project_id": "xxx",
          "run_mode": "exclusive_cluster",
          "job_id": 90634,
          "name": "test_guoquan",
          "desc": "",
          "entrypoint_args": null,
          "status": "job_cancel_success"
      }
  }

状态码

状态码如表6所示。

错误码

调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。