Retrieves a list of Airflow instances in a workspace.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| WorkspaceId |
string |
Yes |
The ID of the DMS workspace. |
86302423828**** |
| MaxResults |
integer |
No |
The number of entries per page. |
20 |
| NextToken |
string |
No |
The token that is used to retrieve the next page of results. |
f056501ada12**** |
| PageIndex |
integer |
No |
The page number. The value starts from 1. |
1 |
| Skip |
integer |
No |
The number of records to skip. This is used for paging. |
5 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| AccessDeniedDetail |
string |
The details about the access denial. |
NOT_FOUND |
| Root |
object |
The details of the data. |
|
| List |
array<object> |
The list of data. |
|
|
object |
|||
| AirflowName |
string |
The name of the Airflow instance. |
test-airflow |
| AppSpec |
string |
The specifications of the Airflow instance. |
SMALL |
| AppType |
string |
The type. |
AIRFLOW |
| CustomAirflowCfg |
array |
The custom configuration. |
|
|
string |
The configuration item. |
k=v |
|
| DagsDir |
string |
The DAGs folder that Airflow scans. |
default/dags |
| DeployErrorMsg |
string |
The error message returned when the deployment fails. |
quota exists |
| Description |
string |
The description of the Airflow instance. |
test |
| GmtCreated |
string |
The time when the Airflow instance was created. |
2025-08-12T05:46:01.000+0000 |
| OssBucketName |
string |
The name of the OSS bucket. |
osstest |
| OssPath |
string |
The path in OSS. |
/airflow |
| PluginsDir |
string |
The plugins folder that Airflow scans. |
default/plugins |
| RequirementFile |
string |
The path to the file that contains the dependencies. |
default/requirements.txt |
| SecurityGroupId |
string |
The security group ID. |
sg-2ze1nak7h0alg1w**** |
| Status |
string |
The status of the Airflow instance. |
DEPLOYED |
| AirflowId |
string |
The ID of the Airflow instance. |
af-7a6ygsh80d**** |
| VSwitchId |
string |
The vSwitch ID. |
vsw-uf6sxdc22x7sbdb**** |
| VpcId |
string |
The VPC ID. |
vpc-8vbbfm33dy0y1pek**** |
| WorkerServerlessReplicas |
integer |
The number of worker nodes. |
0 |
| WorkspaceId |
string |
The ID of the DMS workspace. |
8630242382**** |
| ZoneId |
string |
The ID of the zone in the region. |
cn-hangzhou-h |
| StartupFile |
string |
The path to the script that is loaded when Airflow starts. |
default/startup.sh |
| TotalCount |
integer |
The total number of matching Airflow instances. |
100 |
| Message |
string |
The error message. |
Successful |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| ErrorCode |
string |
The error code. This parameter is returned when an error occurs. |
UnknownError |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| NextToken |
string |
The token that is used to retrieve the next page of results. |
NesLoKLEdIZrKhDT7I2gS**** |
| RequestId |
string |
The request ID. |
67E910F2-4B62-5B0C-ACA3-7547695C**** |
| MaxResults |
integer |
The number of entries per page. |
20 |
Examples
Success response
JSON format
{
"AccessDeniedDetail": "NOT_FOUND",
"Root": {
"List": [
{
"AirflowName": "test-airflow",
"AppSpec": "SMALL",
"AppType": "AIRFLOW",
"CustomAirflowCfg": [
"k=v"
],
"DagsDir": "default/dags",
"DeployErrorMsg": "quota exists",
"Description": "test",
"GmtCreated": "2025-08-12T05:46:01.000+0000",
"OssBucketName": "osstest",
"OssPath": "/airflow",
"PluginsDir": "default/plugins",
"RequirementFile": "default/requirements.txt",
"SecurityGroupId": "sg-2ze1nak7h0alg1w****",
"Status": "DEPLOYED",
"AirflowId": "af-7a6ygsh80d****",
"VSwitchId": "vsw-uf6sxdc22x7sbdb****",
"VpcId": "vpc-8vbbfm33dy0y1pek****",
"WorkerServerlessReplicas": 0,
"WorkspaceId": "8630242382****",
"ZoneId": "cn-hangzhou-h",
"StartupFile": "default/startup.sh"
}
],
"TotalCount": 100
},
"Message": "Successful",
"HttpStatusCode": 200,
"ErrorCode": "UnknownError",
"Success": true,
"NextToken": "NesLoKLEdIZrKhDT7I2gS****",
"RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
"MaxResults": 20
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.