GetDeploymentsByName - Realtime Compute for Apache Flink

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /api/v2/namespaces/{namespace}/deployments/name/{deploymentName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
namespace	string	Yes	The name of the project.	default-namespace
deploymentName	string	Yes	The name of the deployed job.	test

Request parameters

Parameter	Type	Required	Description	Example
workspace	string	Yes	The ID of the workspace.	a14bd5d90a****
ignoreJobSummary	boolean	No	Specifies whether to exclude job summary information, such as jobName and status, from the response. Set this to true to return only the JobId and improve performance.	true
ignoreResourceSetting	boolean	No	Specifies whether to exclude resource configuration information, such as parallelism and the number of CUs, to reduce the response size.	true

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 request was successful.	true
httpCode	integer	The HTTP status code. A value of 200 is returned. Use the success parameter to determine whether the request was successful.	200
errorCode	string	The error code. This is returned only when the request fails.	""
errorMessage	string	The error message. This is returned only when the request fails.	""
data	array	The response data.
	Deployment	The details of the job instance.

The deploymentName is a user-defined logical identifier and is not guaranteed to be unique. This operation returns a list of all deployments that match the specified name. The results are sorted by creation time in descending order. This lets you easily view the latest deployment or compare it with historical versions.

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": [
    {
      "deploymentId": "00000000-0000-0000-0000-0000012312****",
      "namespace": "default-namespace",
      "name": "deploymentName",
      "engineVersion": "vvr-6.0.0-flink-1.15",
      "description": "this is a deployment description",
      "creator": "27846363877456****",
      "creatorName": "****@streamcompute.onaliyun.com",
      "modifier": "27846363877456****",
      "modifierName": "****@streamcompute.onaliyun.com",
      "deploymentHasChanged": true,
      "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"
      },
      "flinkConf": {
        "taskmanager.numberOfTaskSlots": "1"
      },
      "logging": {
        "loggingProfile": "oss",
        "log4j2ConfigurationTemplate": "xml格式文本",
        "log4jLoggers": [
          {
            "loggerName": "StdOutErrConsoleAppender",
            "loggerLevel": "ERROR"
          }
        ],
        "logReservePolicy": {
          "openHistory": true,
          "expirationDays": 7
        }
      },
      "jobSummary": {
        "starting": 1,
        "running": 2,
        "cancelling": 0,
        "cancelled": 5,
        "finished": 4,
        "failed": 6
      },
      "deploymentTarget": {
        "mode": "PER_JOB",
        "name": "vvp-workload"
      },
      "executionMode": "STREAMING",
      "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,
          "jobmanagerResourceSettingSpec": {
            "cpu": 2,
            "memory": "4 GiB"
          },
          "taskmanagerResourceSettingSpec": {
            "cpu": 2,
            "memory": "4 GiB"
          }
        }
      },
      "batchResourceSetting": {
        "maxSlot": 10,
        "basicResourceSetting": {
          "parallelism": 4
        }
      },
      "labels": {
        "test": "test",
        "test2": 1
      },
      "localVariables": [
        {
          "name": "test",
          "value": "datagen"
        }
      ],
      "workspace": "edcef******b4f",
      "createdAt": "1714058507\n",
      "modifiedAt": "1714058843",
      "referencedDeploymentDraftId": "00000000-0000-0000-0000-000000000003"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.