调用GetDeployment获取已部署作业的详细信息。

调试

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

请求头

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

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

工作空间ID。

请求语法

GET /api/v2/namespaces/{namespace}/deployments/{deploymentId} HTTP/1.1

请求参数

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

项目空间名称。
deploymentId String Path 是 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，返回空值。
data Deployment
  • 当success为true，返回查询的作业信息；
  • 当success为false，返回空值。

示例

请求示例

GET /api/v2/namespaces/default-namespace/deployments/58718c99-3b29-4c5e-93bb-c9fc4ec6**** HTTP/1.1
Host:ververica.cn-hangzhou.aliyuncs.com
workspace:a14bd5d90a****
Content-Type:application/json

正常返回示例

XML格式 

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

<GetDeploymentResponse>
    <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>
    <success>true</success>
    <httpCode>200</httpCode>
    <errorCode>""</errorCode>
    <errorMessage>""</errorMessage>
    <data>
        <deploymentId>00000000-0000-0000-0000-00000000****</deploymentId>
        <namespace>default-namespace</namespace>
        <name>deploymentName</name>
        <engineVersion>vvr-6.0.0-flink-1.15</engineVersion>
        <description>this is a deployment description</description>
        <deploymentHasChanged>true</deploymentHasChanged>
        <artifact>
            <jarArtifact>
                <jarUri>https://oss//bucket//test.jar</jarUri>
                <entryClass>org.apapche.flink.test</entryClass>
            </jarArtifact>
            <kind>SQLSCRIPT</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>
        <jobSummary>
            <starting>1</starting>
            <running>1</running>
            <cancelling>1</cancelling>
            <cancelled>1</cancelled>
            <finished>1</finished>
            <failed>1</failed>
        </jobSummary>
        <deploymentTarget>
            <mode>PER_JOB</mode>
            <name>vvp-workload</name>
        </deploymentTarget>
        <executionMode>STREAMING</executionMode>
    </data>
</GetDeploymentResponse>

JSON格式 

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

{
  "requestId" : "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success" : true,
  "httpCode" : 200,
  "errorCode" : "\"\"",
  "errorMessage" : "\"\"",
  "data" : {
    "deploymentId" : "00000000-0000-0000-0000-00000000****",
    "namespace" : "default-namespace",
    "name" : "deploymentName",
    "engineVersion" : "vvr-6.0.0-flink-1.15",
    "description" : "this is a deployment description",
    "deploymentHasChanged" : true,
    "artifact" : {
      "jarArtifact" : {
        "jarUri" : "https://oss//bucket//test.jar",
        "entryClass" : "org.apapche.flink.test",
        "additionalDependencies" : [ ]
      },
      "kind" : "SQLSCRIPT"
    },
    "logging" : {
      "loggingProfile" : "oss",
      "log4j2ConfigurationTemplate" : "xml格式文本",
      "log4jLoggers" : [ {
        "loggerName" : "StdOutErrConsoleAppender",
        "loggerLevel" : "ERROR"
      } ],
      "logReservePolicy" : {
        "openHistory" : true,
        "expirationDays" : 7
      }
    },
    "jobSummary" : {
      "starting" : 1,
      "running" : 1,
      "cancelling" : 1,
      "cancelled" : 1,
      "finished" : 1,
      "failed" : 1
    },
    "deploymentTarget" : {
      "mode" : "PER_JOB",
      "name" : "vvp-workload"
    },
    "executionMode" : "STREAMING"
  }
}