Retrieve information about all job instances under a deployed job.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
stream:ListJobs |
list |
*All Resource
|
None | None |
Request syntax
GET /api/v2/namespaces/{namespace}/jobs HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| namespace |
string |
Yes |
Project name. |
default-namespace |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspace |
string |
Yes |
Workspace ID. |
a14bd5d90a**** |
| pageIndex |
integer |
No |
Paging parameter. Page index of the requested page. Minimum value is 1. Default value is 1. |
1 |
| pageSize |
integer |
No |
Paging parameter. Number of elements on the requested page. Maximum value is 100. Minimum value is 1. Default value is 10. |
10 |
| deploymentId |
string |
Yes |
Deployed job ID. |
58718c99-3b29-4c5e-93bb-c9fc4ec6**** |
| sortName |
string |
No |
Collation. |
gmt_create |
| sortOrder |
string |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response data. |
||
| requestId |
string |
Request ID. |
CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
| success |
boolean |
Indicates whether the business request succeeded. |
true |
| httpCode |
integer |
Static field with value 200. |
200 |
| errorCode |
string |
|
"" |
| errorMessage |
string |
|
"" |
| pageIndex |
integer |
Paging parameter. Page index of the requested page. |
1 |
| pageSize |
integer |
Paging parameter. Number of elements on the requested page. |
10 |
| totalSize |
integer |
Total number of elements that match the query conditions. |
1 |
| data |
array |
|
|
| Job |
Instance data. |
||
| accessDeniedDetail |
string |
Examples
Success response
JSON format
{
"requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
"success": true,
"httpCode": 200,
"errorCode": "\"\"",
"errorMessage": "\"\"",
"pageIndex": 1,
"pageSize": 10,
"totalSize": 1,
"data": [
{
"jobId": "354dde66-a3ae-463e-967a-0b4107fd****",
"deploymentId": "354dde66-a3ae-463e-967a-0b4107fd****",
"deploymentName": "flinktest",
"namespace": "namespacetest",
"executionMode": "BATCH",
"creator": "27846363877456****",
"creatorName": "****@streamcompute.onaliyun.com",
"modifier": "27846363877456****",
"modifierName": "****@streamcompute.onaliyun.com",
"startTime": 1660190835,
"endTime": 1660277235,
"engineVersion": "vvr-4.0.14-flink-1.13",
"flinkConf": {
"test": "test",
"test2": 1
},
"status": {
"running": {
"observedFlinkJobRestarts": 4,
"observedFlinkJobStatus": "RUNNING"
},
"riskLevel": "",
"failure": {
"message": "Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.",
"reason": "KubernetesDeploymentNotProgressing",
"failedAt": 1660120062
},
"currentJobStatus": "RUNNING",
"healthScore": 0
},
"metric": {
"totalMemoryByte": 4096,
"totalCpu": 2
},
"sessionClusterName": "preview",
"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"
},
"logging": {
"loggingProfile": "oss",
"log4j2ConfigurationTemplate": "xml格式文本",
"log4jLoggers": [
{
"loggerName": "StdOutErrConsoleAppender",
"loggerLevel": "ERROR"
}
],
"logReservePolicy": {
"openHistory": true,
"expirationDays": 7
}
},
"batchResourceSetting": {
"maxSlot": 10,
"basicResourceSetting": {
"parallelism": 4,
"jobmanagerResourceSettingSpec": {
"cpu": 2,
"memory": "4 GiB"
},
"taskmanagerResourceSettingSpec": {
"cpu": 2,
"memory": "4 GiB"
}
}
},
"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
}
},
"restoreStrategy": {
"kind": "LATEST_STATE",
"allowNonRestoredState": true,
"jobStartTimeInMs": 1660293803155,
"savepointId": "354dde66-a3ae-463e-967a-0b4107fd****"
},
"userFlinkConf": {
"taskmanager.numberOfTaskSlots": "1",
"table.exec.state.ttl": "128000s"
},
"localVariables": [
{
"name": "test",
"value": "datagen"
}
],
"workspace": "edcef******b4f",
"createdAt": "1714058507",
"modifiedAt": "1714058800"
}
],
"accessDeniedDetail": ""
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.