All Products
Search
Document Center

Data Management:GetAirflow

Last Updated:Sep 22, 2025

Queries the details of an Airflow instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

AirflowId

string

Yes

The ID of the Airflow instance.

af-b3a7f110a6vmvn7****

WorkspaceId

string

Yes

The ID of the workspace.

8630242382****

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

E0D21075-CD3E-4D98-8264-****

AccessDeniedDetail

string

Details about the access failure.

NOT_FOUND

Root

object

The data details.

AirflowName

string

The name of the Airflow instance.

testairflow

AppSpec

string

The specifications of the Airflow instance.

SMALL

AppType

string

The type.

AIRFLOW

CustomAirflowCfg

array

The custom configurations.

string

The configuration details.

smtp.username=test

DagsDir

string

The DAG directory that Airflow scans.

default/dags

DeployErrorMsg

string

The publishing error message.

Deployed

Description

string

The description of the Airflow instance.

test airflow

GmtCreated

string

The time when the instance was created.

2025-08-12T05:46:01.000+0000

OssBucketName

string

The name of the OSS bucket.

osstest

OssPath

string

The OSS path.

/airflow

PluginsDir

string

The plugin directory that Airflow scans.

default/plugins

RequirementFile

string

The configuration file for dependent packages.

default/requirements.txt

SecurityGroupId

string

The ID of the security group.

sg-2ze9gj646bkv****

StartupFile

string

The script that is loaded before Airflow starts.

default/startup.sh

Status

string

The status of the Airflow instance.

DEPLOYED

AirflowId

string

The ID of the Airflow instance.

af-7a6ygsh80dx1jn****

VSwitchId

string

The ID of the vSwitch.

vsw-bp1931trfxkvf74v****

VpcId

string

The ID of the VPC.

vpc-2zevqv4obraqd5p****

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

RegionId

string

The region ID.

cn-hangzhou

Message

string

The error message.

Unknown error

HttpStatusCode

integer

The status code.

200

ErrorCode

string

The error code.

UnknownError

Success

boolean

Indicates whether the request was successful. The following values are returned:

  • true: The request was successful.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "RequestId": "E0D21075-CD3E-4D98-8264-****",
  "AccessDeniedDetail": "NOT_FOUND",
  "Root": {
    "AirflowName": "testairflow",
    "AppSpec": "SMALL",
    "AppType": "AIRFLOW",
    "CustomAirflowCfg": [
      "smtp.username=test"
    ],
    "DagsDir": "default/dags",
    "DeployErrorMsg": "Deployed",
    "Description": "test airflow",
    "GmtCreated": "2025-08-12T05:46:01.000+0000",
    "OssBucketName": "osstest",
    "OssPath": "/airflow",
    "PluginsDir": "default/plugins",
    "RequirementFile": "default/requirements.txt",
    "SecurityGroupId": "sg-2ze9gj646bkv****",
    "StartupFile": "default/startup.sh",
    "Status": "DEPLOYED",
    "AirflowId": "af-7a6ygsh80dx1jn****",
    "VSwitchId": "vsw-bp1931trfxkvf74v****",
    "VpcId": "vpc-2zevqv4obraqd5p****",
    "WorkerServerlessReplicas": 0,
    "WorkspaceId": "8630242382****",
    "ZoneId": "cn-hangzhou-h",
    "RegionId": "cn-hangzhou"
  },
  "Message": "Unknown error",
  "HttpStatusCode": 200,
  "ErrorCode": "UnknownError",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

404 InvalidAirflow.NotFound The specified Airflow does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.