GetAirflow - 获取Airflow实例详情_数据管理 DMS-阿里云帮助中心

查询Airflow实例详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:GetAirflow

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AirflowId	string	是	Airflow 实例 ID。	af-b3a7f110a6vmvn7****
WorkspaceId	string	是	工作空间 ID。	8630242382****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	Reuqest ID。	E0D21075-CD3E-4D98-8264-****
AccessDeniedDetail	string	访问失败的信息。	NOT_FOUND
Root	object	数据明细。
AirflowName	string	Airflow 名称。	testairflow
AppSpec	string	Airflow 规格。	SMALL
AppType	string	类型。	AIRFLOW
CustomAirflowCfg	array	自定义配置。
	string	配置明细。	smtp.username=test
DagsDir	string	Airflow 扫描的 dag 目录。	default/dags
DeployErrorMsg	string	发布错误信息。	Deployed
Description	string	Airflow 的描述。	test airflow
GmtCreated	string	创建时间。	2025-08-12T05:46:01.000+0000
OssBucketName	string	OSS Bucket 名字。	osstest
OssPath	string	OSS 路径。	/airflow
PluginsDir	string	Airflow 扫描的插件目录。	default/plugins
RequirementFile	string	依赖包的配置文件。	default/requirements.txt
SecurityGroupId	string	安全组 ID。	sg-2ze9gj646bkv****
StartupFile	string	Airflow 启动前加载的脚本。	default/startup.sh
Status	string	Airflow 实例状态。	DEPLOYED
AirflowId	string	Airflow 的 ID。	af-7a6ygsh80dx1jn****
VSwitchId	string	交换机 ID。	vsw-bp1931trfxkvf74v****
VpcId	string	VPC ID。	vpc-2zevqv4obraqd5p****
WorkerServerlessReplicas	integer	Worker 节点数量。	0
WorkspaceId	string	DMS 工作空间 ID。	8630242382****
ZoneId	string	Region 下的可用区 ID。	cn-hangzhou-h
RegionId	string	地域 ID。	cn-hangzhou
Message	string	错误信息。	Unknown error
HttpStatusCode	integer	状态码。	200
ErrorCode	string	错误码。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidAirflow.NotFound	The specified Airflow does not exist.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。