ConfigAirflow
Update an Airflow instance's custom configuration
Operation description
Configure the airflow.cfg file for DMS Airflow.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AirflowId |
string |
Yes |
The unique ID of the Airflow instance. |
af-b3a7f110a6vmvn7xxxxxx |
| CustomAirflowCfg |
array |
Yes |
The list of custom Airflow configurations. |
|
|
string |
No |
A custom Airflow configuration setting. |
celery.worker_concurrency=10 |
|
| WorkspaceId |
string |
Yes |
The DMS workspace ID. |
8630242382**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
67E910F2-4B62-5B0C-ACA3-7547695C**** |
| AccessDeniedDetail |
string |
Details of the access denial. |
NOT_FOUND |
| Root |
object |
Information about the Airflow instance. |
|
| AirflowName |
string |
The name of the Airflow instance. |
testairflow |
| AppSpec |
string |
The Airflow instance specifications. |
SMALL |
| AppType |
string |
The application type. |
AIRFLOW |
| CustomAirflowCfg |
array |
The custom configuration. |
|
|
string |
Configuration details. |
smtp.username=test |
|
| DagsDir |
string |
The DAG directory that Airflow scans. |
default/dags |
| DeployErrorMsg |
string |
The deployment error message. |
vpc not found |
| Description |
string |
The description of the Airflow instance. |
test airflow |
| GmtCreated |
string |
The timestamp when the instance was created. |
2025-08-12T05:46:01.000+0000 |
| OssBucketName |
string |
The name of the OSS bucket. |
oss-test |
| OssPath |
string |
The OSS path. |
/airflow |
| PluginsDir |
string |
The plugin directory that Airflow scans. |
default/plugins |
| RequirementFile |
string |
The configuration file for dependencies. |
default/requirements.txt |
| SecurityGroupId |
string |
The security group ID. |
sg-2ze1nak7h0alg1xxx |
| StartupFile |
string |
The script that runs before Airflow starts. |
default/startup.sh |
| Status |
string |
The status of the Airflow instance. |
DEPLOYING |
| AirflowId |
string |
The ID of the Airflow instance. |
af-7a6ygsh80dx1jn**** |
| VSwitchId |
string |
The VSwitch ID. |
vsw-bp1931trfxkvf74v**** |
| VpcId |
string |
The VPC ID. |
vpc-uf63r6coyiw9o5gf**** |
| WorkerServerlessReplicas |
integer |
The number of worker nodes. |
0 |
| WorkspaceId |
string |
The DMS workspace ID. |
86302423828**** |
| ZoneId |
string |
The zone ID. |
cn-hangzhou-h |
| Message |
string |
The error message. |
Instance not found. |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| ErrorCode |
string |
The error code. |
UnknownError |
| Success |
boolean |
Indicates whether the request succeeded. Valid values:
|
true |
Examples
Success response
JSON format
{
"RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
"AccessDeniedDetail": "NOT_FOUND",
"Root": {
"AirflowName": "testairflow",
"AppSpec": "SMALL",
"AppType": "AIRFLOW",
"CustomAirflowCfg": [
"smtp.username=test"
],
"DagsDir": "default/dags",
"DeployErrorMsg": "vpc not found",
"Description": "test airflow",
"GmtCreated": "2025-08-12T05:46:01.000+0000",
"OssBucketName": "oss-test",
"OssPath": "/airflow",
"PluginsDir": "default/plugins",
"RequirementFile": "default/requirements.txt",
"SecurityGroupId": "sg-2ze1nak7h0alg1xxx",
"StartupFile": "default/startup.sh",
"Status": "DEPLOYING",
"AirflowId": "af-7a6ygsh80dx1jn****",
"VSwitchId": "vsw-bp1931trfxkvf74v****",
"VpcId": "vpc-uf63r6coyiw9o5gf****",
"WorkerServerlessReplicas": 0,
"WorkspaceId": "86302423828****",
"ZoneId": "cn-hangzhou-h"
},
"Message": "Instance not found.",
"HttpStatusCode": 200,
"ErrorCode": "UnknownError",
"Success": true
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.