ListDeployments
Retrieves information about all deployed jobs.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
stream:ListDeployments |
list |
*All Resource
|
None | None |
Request syntax
GET /api/v2/namespaces/{namespace}/deployments HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| namespace |
string |
Yes |
The namespace name. |
default-namespace |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspace |
string |
Yes |
The workspace ID. |
a14bd5d90a**** |
| pageSize |
integer |
No |
The number of entries per page. Valid values: 1 to 100. Default value: 10. |
10 |
| pageIndex |
integer |
No |
The page number. Minimum value: 1. Default value: 1. |
1 |
| name |
string |
No |
The deployment name. |
vvp_ds_0522 |
| executionMode |
string |
No |
The execution mode of the deployment. Valid values:
|
STREAMING |
| status |
string |
No |
The latest job status of the deployment. Valid values:
|
RUNNING |
| creator |
string |
No |
The UID of the creator. |
183899668******* |
| modifier |
string |
No |
The UID of the modifier. |
183899668******* |
| labelKey |
string |
No |
The label key. |
key |
| labelValueArray |
string |
No |
The label values. Separate multiple values with semicolons. |
value1,value2 |
| sortName |
string |
No |
The sort field. Data can be returned in descending order of creation time or modification time. Valid values:
|
gmt_create |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| requestId |
string |
The request ID. |
CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
| success |
boolean |
Indicates whether the request is successful. |
true |
| httpCode |
integer |
The HTTP status code. Fixed value: 200. |
200 |
| errorCode |
string |
|
"" |
| errorMessage |
string |
|
"" |
| pageIndex |
integer |
The page number. |
1 |
| pageSize |
integer |
The number of entries per page. |
10 |
| totalSize |
integer |
The total number of entries that meet the query conditions. |
1 |
| data |
array |
|
|
| Deployment |
The job data. |
Examples
Success response
JSON format
{
"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"
]
},
"cdcYamlArtifact": {
"cdcYaml": "",
"additionalDependencies": [
""
]
},
"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
}
},
"labels": {
"test": "test",
"test2": 1
},
"localVariables": [
{
"name": "test",
"value": "datagen"
}
],
"workspace": "edcef******b4f",
"createdAt": "1714058507\n",
"modifiedAt": "1714058843",
"referencedDeploymentDraftId": "00000000-0000-0000-0000-000000000003"
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.