本接口用于通过已部署作业名称搜索并获取指定工作空间和项目空间下匹配的已部署作业实例
调试
您可以在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"
]
},
"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"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。