ListAirflows - 获取工作空间的Airflow实例列表

获取工作空间的Airflow实例列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListAirflows

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

WorkspaceId

string

DMS 工作空间 ID。

86302423828****

MaxResults

integer

分页大小。

20

NextToken

string

下一次查询的令牌(Token)。

f056501ada12****

PageIndex

integer

当前页码,从 1 开始。

1

Skip

integer

跳过 n 条记录,用于分页。

5

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

拒接访问的信息。

NOT_FOUND

Root

object

数据详情。

List

array<object>

数据列表。

object

PluginsDir

string

Airflow 扫描的插件目录。

default/plugins

RequirementFile

string

依赖包的文件路径。

default/requirements.txt

Status

string

Airflow 实例状态。

DEPLOYED

Description

string

Airflow 实例描述。

test

ZoneId

string

Region 下的可用区 ID。

cn-hangzhou-h

AirflowId

string

Airflow 实例 ID。

af-7a6ygsh80d****

SecurityGroupId

string

安全组 ID。

sg-2ze1nak7h0alg1w****

VSwitchId

string

交换机 ID。

vsw-uf6sxdc22x7sbdb****

WorkspaceId

string

DMS 工作空间 ID。

8630242382****

DagsDir

string

Airflow 扫描的 dag 目录。

default/dags

WorkerServerlessReplicas

integer

Worker 节点数量。

0

GmtCreated

string

Airflow 实例创建时间。

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

CustomAirflowCfg

array

自定义配置。

string

配置项。

k=v

DeployErrorMsg

string

发布错误信息。

quota exists

VpcId

string

VPC ID。

vpc-8vbbfm33dy0y1pek****

OssPath

string

OSS 路径。

/airflow

AppSpec

string

Airflow 规格。

SMALL

OssBucketName

string

OSS Bucket 名称。

osstest

AirflowName

string

Airflow 实例名称。

test-airflow

AppType

string

类型。

AIRFLOW

StartupFile

string

Airflow 启动时加载的脚本目录。

default/startup.sh

TotalCount

integer

符合条件的 Airflow 总数据量。

100

Message

string

错误信息。

Successful

HttpStatusCode

integer

HTTP 状态码。

200

ErrorCode

string

错误码,请求异常时返回。

UnknownError

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

true

NextToken

string

下一次查询的令牌(Token)。

NesLoKLEdIZrKhDT7I2gS****

RequestId

string

Reuqest ID。

67E910F2-4B62-5B0C-ACA3-7547695C****

MaxResults

integer

分页大小。

20

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "NOT_FOUND",
  "Root": {
    "List": [
      {
        "PluginsDir": "default/plugins",
        "RequirementFile": "default/requirements.txt",
        "Status": "DEPLOYED",
        "Description": "test",
        "ZoneId": "cn-hangzhou-h",
        "AirflowId": "af-7a6ygsh80d****",
        "SecurityGroupId": "sg-2ze1nak7h0alg1w****",
        "VSwitchId": "vsw-uf6sxdc22x7sbdb****",
        "WorkspaceId": "8630242382****",
        "DagsDir": "default/dags",
        "WorkerServerlessReplicas": 0,
        "GmtCreated": "2025-08-12T05:46:01.000+0000",
        "CustomAirflowCfg": [
          "k=v"
        ],
        "DeployErrorMsg": "quota exists",
        "VpcId": "vpc-8vbbfm33dy0y1pek****",
        "OssPath": "/airflow",
        "AppSpec": "SMALL",
        "OssBucketName": "osstest",
        "AirflowName": "test-airflow",
        "AppType": "AIRFLOW",
        "StartupFile": "default/startup.sh"
      }
    ],
    "TotalCount": 100
  },
  "Message": "Successful",
  "HttpStatusCode": 200,
  "ErrorCode": "UnknownError",
  "Success": true,
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "MaxResults": 20
}

错误码

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

变更历史

更多信息,参考变更详情