本介面用於通過已部署作業名稱搜尋並擷取指定工作空間和專案空間下匹配的已部署工作執行個體
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
stream:GetDeploymentsByName |
get |
*全部資源
|
無 | 無 |
請求文法
GET /api/v2/namespaces/{namespace}/deployments/name/{deploymentName} HTTP/1.1路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| namespace |
string |
是 |
專案空間名稱 |
default-namespace |
| deploymentName |
string |
是 |
已部署作業名稱 |
test |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| workspace |
string |
是 |
工作空間 ID |
a14bd5d90a**** |
| ignoreJobSummary |
boolean |
否 |
是否忽略返回結果中的作業摘要資訊（如 jobName、status），僅返回 JobId，用於提升效能 |
true |
| ignoreResourceSetting |
boolean |
否 |
是否忽略資源配置資訊（如 parallelism、CU 數量），減少返回資料體積 |
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
響應資料。 |
||
| requestId |
string |
請求 ID。 |
CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
| success |
boolean |
表示業務請求是否成功。 |
true |
| httpCode |
integer |
業務狀態代碼，統一為 200；使用 success 表示業務請求是否成功。 |
200 |
| errorCode |
string |
當 success 為 false 時，該值不為空白，表示業務錯誤碼；當 success 為 true 時，該值為空白。 |
"" |
| errorMessage |
string |
當 success 為 false 時，該值不為空白，表示業務錯誤資訊；當 success 為 true 時，該值為空白。 |
"" |
| data |
array |
響應資料。 |
|
| Deployment |
本資料結構代表已部署作業產生的執行個體詳情。 |
由於 deploymentName 是使用者自訂的邏輯標識，不保證唯一性，該介面將返回所有名稱匹配的部署記錄列表，按建立時間倒序排列，便於查看最新部署或對比歷史版本。
樣本
正常返回樣本
JSON格式
{
"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"
]
},
"cdcYamlArtifact": {
"cdcYaml": "",
"additionalDependencies": [
""
]
},
"kind": "SQLSCRIPT"
},
"flinkConf": {
"taskmanager.numberOfTaskSlots": "1"
},
"logging": {
"loggingProfile": "default",
"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": "default-queue\t"
},
"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"
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。