调用ListJobs可以获取到某个作业下所有作业实例的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

名称 类型 是否必选 示例 描述
workspace String 是 a14bd5d90a****

工作空间ID。

请求语法

GET /api/v2/namespaces/{namespace}/jobs HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
namespace String Path 是 default-namespace

项目空间名称。
pageIndex Integer Query 否 1

分页参数，页码索引，表示所请求页码，最小值为1，默认值为1。
pageSize Integer Query 否 10

分页参数，表示所请求页码元素数量，最大值为100，最小值为1，默认值为10。
deploymentId String Query 是 58718c99-3b29-4c5e-93bb-c9fc4ec6****

已部署作业ID。

返回数据

名称 类型 示例值 描述
requestId String CBC799F0-AS7S-1D30-8A4F-882ED4DD****

请求ID。
success Boolean true

表示业务请求是否成功。
httpCode Integer 200

固定值200。
errorCode String ""
  • 当success为false，返回业务错误码；
  • 当success为true，返回空值。
errorMessage String ""
  • 当success为false，返回业务错误信息；
  • 当success为true，返回空值。
pageIndex Integer 1

分页参数，页码索引，表示所请求页码。
pageSize Integer 10

分页参数，表示所请求页码元素数量。
totalSize Integer 1

满足查询条件的所有元素的数量。
data Array of Job
  • 当success为true，返回所有满足条件的实例信息；
  • 当success为false，返回空值。

示例

请求示例

GET /api/v2/namespaces/default-namespace/jobs?pageIndex=1&pageSize=10&deploymentId=58718c99-3b29-4c5e-93bb-c9fc4ec6**** HTTP/1.1
Host:ververica.aliyuncs.com
workspace:a14bd5d90a****
Content-Type:application/json

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListJobsResponse>
    <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>
    <success>true</success>
    <errorCode>""</errorCode>
    <errorMessage>""</errorMessage>
    <httpCode>200</httpCode>
    <pageIndex>1</pageIndex>
    <pageSize>10</pageSize>
    <totalSize>1</totalSize>
    <data>
        <jobId>354dde66-a3ae-463e-967a-0b4107fd****</jobId>
        <deploymentId>354dde66-a3ae-463e-967a-0b4107fd****</deploymentId>
        <deploymentName>flinktest</deploymentName>
        <namespace>namespacetest</namespace>
        <executionMode>BATCH</executionMode>
        <startTime>1660190835</startTime>
        <endTime>1660277235</endTime>
        <engineVersion>vvr-4.0.14-flink-1.13</engineVersion>
        <status>
            <currentJobStatus>RUNNING</currentJobStatus>
            <running>
                <observedFlinkJobRestarts>4</observedFlinkJobRestarts>
                <observedFlinkJobStatus>RUNNING</observedFlinkJobStatus>
            </running>
        </status>
        <metric>
            <totalMemoryByte>4096</totalMemoryByte>
            <totalCpu>2</totalCpu>
        </metric>
        <sessionClusterName>preview</sessionClusterName>
        <artifact>
            <jarArtifact>
                <jarUri>https://oss//bucket//test.jar</jarUri>
                <entryClass>org.apapche.flink.test</entryClass>
            </jarArtifact>
            <kind>JAR</kind>
        </artifact>
        <logging>
            <loggingProfile>oss</loggingProfile>
            <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>
            <log4jLoggers>
                <loggerName>StdOutErrConsoleAppender</loggerName>
                <loggerLevel>ERROR</loggerLevel>
            </log4jLoggers>
            <logReservePolicy>
                <openHistory>true</openHistory>
                <expirationDays>7</expirationDays>
            </logReservePolicy>
        </logging>
        <batchResourceSetting>
            <maxSlot>10</maxSlot>
            <basicResourceSetting>
                <parallelism>4</parallelism>
                <jobmanagerResourceSettingSpec>
                    <cpu>2</cpu>
                    <memory>4Gi</memory>
                </jobmanagerResourceSettingSpec>
                <taskmanagerResourceSettingSpec>
                    <cpu>2</cpu>
                    <memory>4Gi</memory>
                </taskmanagerResourceSettingSpec>
            </basicResourceSetting>
        </batchResourceSetting>
    </data>
</ListJobsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success" : true,
  "errorCode" : "\"\"",
  "errorMessage" : "\"\"",
  "httpCode" : 200,
  "pageIndex" : 1,
  "pageSize" : 10,
  "totalSize" : 1,
  "data" : [ {
    "jobId" : "354dde66-a3ae-463e-967a-0b4107fd****",
    "deploymentId" : "354dde66-a3ae-463e-967a-0b4107fd****",
    "deploymentName" : "flinktest",
    "namespace" : "namespacetest",
    "executionMode" : "BATCH",
    "startTime" : 1660190835,
    "endTime" : 1660277235,
    "engineVersion" : "vvr-4.0.14-flink-1.13",
    "status" : {
      "currentJobStatus" : "RUNNING",
      "running" : {
        "observedFlinkJobRestarts" : 4,
        "observedFlinkJobStatus" : "RUNNING"
      }
    },
    "metric" : {
      "totalMemoryByte" : 4096,
      "totalCpu" : 2
    },
    "sessionClusterName" : "preview",
    "artifact" : {
      "jarArtifact" : {
        "jarUri" : "https://oss//bucket//test.jar",
        "entryClass" : "org.apapche.flink.test",
        "additionalDependencies" : [ ]
      },
      "kind" : "JAR"
    },
    "logging" : {
      "loggingProfile" : "oss",
      "log4j2ConfigurationTemplate" : "xml格式文本",
      "log4jLoggers" : [ {
        "loggerName" : "StdOutErrConsoleAppender",
        "loggerLevel" : "ERROR"
      } ],
      "logReservePolicy" : {
        "openHistory" : true,
        "expirationDays" : 7
      }
    },
    "batchResourceSetting" : {
      "maxSlot" : 10,
      "basicResourceSetting" : {
        "parallelism" : 4,
        "jobmanagerResourceSettingSpec" : {
          "cpu" : 2,
          "memory" : "4Gi"
        },
        "taskmanagerResourceSettingSpec" : {
          "cpu" : 2,
          "memory" : "4Gi"
        }
      }
    }
  } ]
}