StartJobWithParams

Updated at:

Starts a job instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

stream:StartJobWithParams

none

*All Resource

*

None None

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example

namespace

string

Yes

The namespace name.

default-namespace

Request parameters

Parameter

Type

Required

Description

Example

workspace

string

Yes

The workspace ID.

a14bd5d90a****

body JobStartParameters

No

The startup parameters for the job instance.

Response elements

Element

Type

Description

Example

object

The response data.

requestId

string

The request ID.

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

success

boolean

Indicates whether the business request is successful.

true

httpCode

integer

The business status code. The value is always 200. Use the success field to determine whether the request is successful.

200

errorCode

string

The business error code. This field is not empty when the success field is false, and is empty when the success field is true.

""

errorMessage

string

The business error message. This field is not empty when the success field is false, and is empty when the success field is true.

""

data Job

The data structure that represents the details of the instance generated by the deployed job.

accessDeniedDetail

string

The access denial details. This field is returned only when the user does not have the permissions to perform the operation.

""

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****\n",
  "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": {
      "currentJobStatus": "RUNNING",
      "failure": {
        "message": "Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.",
        "reason": "KubernetesDeploymentNotProgressing",
        "failedAt": 1660120062
      },
      "running": {
        "observedFlinkJobRestarts": 4,
        "observedFlinkJobStatus": "RUNNING"
      },
      "healthScore": 0,
      "riskLevel": ""
    },
    "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"
        ]
      },
      "cdcYamlArtifact": {
        "cdcYaml": "",
        "additionalDependencies": [
          ""
        ]
      },
      "kind": "SQLSCRIPT"
    },
    "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": "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"
  },
  "accessDeniedDetail": "\"\""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.