StartJob - 启动作业实例(废弃)

目前该API接口已标记为弃用,推荐使用替代API:ververica(2022-07-18) - StartJobWithParams

创建并启动一个作业实例。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
stream:StartJobnone
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
workspacestring

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
bodyStartJobRequestBody

启动实例参数。

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

CBC799F0-AS7S-1D30-8A4F-882ED4DD****
successboolean

表示业务请求是否成功。

true
httpCodeinteger

固定值 200。

200
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

""
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

""
dataJob
  • 当 success 为 true,返回创建的实例信息;

  • 当 success 为 false,返回空值。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "jobId": "354dde66-a3ae-463e-967a-0b4107fd****",
    "deploymentId": "354dde66-a3ae-463e-967a-0b4107fd****",
    "deploymentName": "flinktest",
    "namespace": "namespacetest",
    "executionMode": "BATCH",
    "creator": "27846363877456****",
    "creatorName": "****@streamcompute.onaliyun.com",
    "modifier": "27846363877456****",
    "modifierName": "****@streamcompute.onaliyun.com",
    "startTime": 1660190835,
    "endTime": 1660277235,
    "engineVersion": "vvr-4.0.14-flink-1.13",
    "flinkConf": {
      "test": "test",
      "test2": 1
    },
    "status": {
      "running": {
        "observedFlinkJobRestarts": 4,
        "observedFlinkJobStatus": "RUNNING"
      },
      "riskLevel": "",
      "failure": {
        "message": "Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.",
        "reason": "KubernetesDeploymentNotProgressing",
        "failedAt": 1660120062
      },
      "currentJobStatus": "RUNNING",
      "healthScore": 0
    },
    "metric": {
      "totalMemoryByte": 4096,
      "totalCpu": 2
    },
    "sessionClusterName": "null",
    "artifact": {
      "sqlArtifact": {
        "sqlScript": "CREATE TEMPORARY TABLE datagen_source(   name VARCHAR ) WITH (   'connector' = 'datagen' ); CREATE TEMPORARY TABLE blackhole_sink(   name  VARCHAR ) with (   'connector' = 'blackhole' ); INSERT INTO blackhole_sink SELECT name from datagen_source;",
        "additionalDependencies": [
          "https://oss/bucket/addition.jar"
        ]
      },
      "jarArtifact": {
        "jarUri": "https://oss/bucket/test.jar",
        "entryClass": "org.apapche.flink.test",
        "mainArgs": "start from main",
        "additionalDependencies": [
          "https://oss/bucket/addition.jar"
        ]
      },
      "pythonArtifact": {
        "pythonArtifactUri": "https://oss/bucket/test.py",
        "mainArgs": "start from main",
        "entryModule": "test.py",
        "additionalDependencies": [
          "https://oss/bucket/addition.py"
        ],
        "additionalPythonLibraries": [
          "https://oss/bucket/additionlib.py"
        ],
        "additionalPythonArchives": [
          "https://oss/bucket/additionArchives.zip"
        ]
      },
      "kind": "SQLSCRIPT"
    },
    "logging": {
      "loggingProfile": "default",
      "log4j2ConfigurationTemplate": "xml格式文本",
      "log4jLoggers": [
        {
          "loggerName": "StdOutErrConsoleAppender",
          "loggerLevel": "ERROR"
        }
      ],
      "logReservePolicy": {
        "openHistory": true,
        "expirationDays": 7
      }
    },
    "batchResourceSetting": {
      "maxSlot": 10,
      "basicResourceSetting": {
        "parallelism": 4,
        "jobmanagerResourceSettingSpec": {
          "cpu": 2,
          "memory": "4 GiB"
        },
        "taskmanagerResourceSettingSpec": {
          "cpu": 2,
          "memory": "4 GiB"
        }
      }
    },
    "streamingResourceSetting": {
      "resourceSettingMode": "EXPERT",
      "expertResourceSetting": {
        "jobmanagerResourceSettingSpec": {
          "cpu": 2,
          "memory": "4 GiB"
        },
        "resourcePlan": "{\\\"ssgProfiles\\\":[{\\\"name\\\":\\\"default\\\",\\\"cpu\\\":1.13,\\\"heap\\\":\\\"1 gb\\\",\\\"offHeap\\\":\\\"32 mb\\\",\\\"managed\\\":{},\\\"extended\\\":{}}],\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"StreamExecTableSourceScan\\\",\\\"desc\\\":\\\"Source: datagen_source[78]\\\",\\\"profile\\\":{\\\"group\\\":\\\"default\\\",\\\"parallelism\\\":1,\\\"maxParallelism\\\":32768,\\\"minParallelism\\\":1}},{\\\"id\\\":2,\\\"type\\\":\\\"StreamExecSink\\\",\\\"desc\\\":\\\"Sink: blackhole_sink[79]\\\",\\\"profile\\\":{\\\"group\\\":\\\"default\\\",\\\"parallelism\\\":1,\\\"maxParallelism\\\":32768,\\\"minParallelism\\\":1}}],\\\"edges\\\":[{\\\"source\\\":1,\\\"target\\\":2,\\\"mode\\\":\\\"PIPELINED\\\",\\\"strategy\\\":\\\"FORWARD\\\"}],\\\"vertices\\\":{\\\"717c7b8afebbfb7137f6f0f99beb2a94\\\":[1,2]}}"
      },
      "basicResourceSetting": {
        "parallelism": 4
      }
    },
    "restoreStrategy": {
      "kind": "LATEST_STATE",
      "allowNonRestoredState": true,
      "jobStartTimeInMs": 1660293803155,
      "savepointId": "354dde66-a3ae-463e-967a-0b4107fd****"
    },
    "userFlinkConf": {
      "taskmanager.numberOfTaskSlots": "1",
      "table.exec.state.ttl": "128000s"
    },
    "localVariables": [
      {
        "name": "test",
        "value": "datagen"
      }
    ],
    "workspace": "edcef******b4f",
    "createdAt": "1714058507",
    "modifiedAt": "1714058800"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-27OpenAPI 变更为 deprecated,即将下线查看变更详情