文档

ListDeployments - 获取已部署作业列表

更新时间:

获取所有已部署作业的信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v2/namespaces/{namespace}/deployments

请求参数

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

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
pageSizeinteger

分页参数,表示所请求页码元素数量,最大值为 100,最小值为 1,默认值为 10。

10
pageIndexinteger

分页参数,页码索引,表示所请求页码,最小值为 1,默认值为 1。

1
namestring

deployment 名称。

vvp_ds_0522
executionModestring

deployment 执行模式。

STREAMING
statusstring

deployment 最新作业状态。

枚举值:
  • CANCELLEDCANCELLED
  • FAILEDFAILED
  • RUNNINGRUNNING
  • TRANSITIONINGTRANSITIONING
  • FINISHEDFINISHED
RUNNING
creatorstring

创建者 UID。

183899668*******
modifierstring

修改者 UID。

183899668*******
labelKeystring

标签名。

key
labelValueArraystring

标签值,多个值使用分号隔开。

value1,value2

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

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

表示业务请求是否成功。

true
httpCodeinteger

固定值 200。

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

  • 当 success 为 true,返回空值。

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

  • 当 success 为 true,返回空值。

""
pageIndexinteger

分页参数,页码索引,表示所请求页码。

1
pageSizeinteger

分页参数,表示所请求页码元素数量。

10
totalSizeinteger

满足查询条件的所有元素的数量。

1
dataarray
  • 当 success 为 true,返回满足查询条件的作业列表;

  • 当 success 为 false,返回空值。

Deployment

作业数据。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "pageIndex": 1,
  "pageSize": 10,
  "totalSize": 1,
  "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
        }
      },
      "localVariables": [
        {
          "name": "test",
          "value": "datagen"
        }
      ],
      "workspace": "edcef******b4f",
      "createdAt": "1714058507\n",
      "modifiedAt": "1714058843"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-24OpenAPI 入参发生变更查看变更详情
2023-09-27OpenAPI 入参发生变更查看变更详情