Obtains information about all deployments.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| stream:ListDeployments | list | *All Resources * |
| none |
Request syntax
GET /api/v2/namespaces/{namespace}/deployments HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workspace | string | Yes | The workspace ID. | a14bd5d90a**** |
| namespace | string | Yes | The name of the namespace. | default-namespace |
| 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 name of the deployment. | vvp_ds_0522 |
| executionMode | string | No | The execution mode of the deployment. Valid values:
| STREAMING |
| status | string | No | The latest status of the deployment. Valid values:
| RUNNING |
| creator | string | No | The ID of the user who creates the deployment. | 183899668******* |
| modifier | string | No | The ID of the user who modifies the deployment. | 183899668******* |
| labelKey | string | No | The tag key. | key |
| labelValueArray | string | No | The tag value. Separate multiple values with semicolon (;). | value1,value2 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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"
]
},
"kind": "SQLSCRIPT"
},
"flinkConf": {
"taskmanager.numberOfTaskSlots": 1
},
"logging": {
"loggingProfile": "oss",
"log4j2ConfigurationTemplate": "",
"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
}
},
"localVariables": [
{
"name": "test",
"value": "datagen"
}
],
"workspace": "edcef******b4f",
"createdAt": 1714058507,
"modifiedAt": 1714058843
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-09 | The request parameters of the API has changed | View Change Details |
| 2024-05-24 | The request parameters of the API has changed | View Change Details |
| 2023-09-27 | The request parameters of the API has changed | View Change Details |