CreateAirflow - 创建Airflow实例

更新时间:
复制 MD 格式

在工作空间下创建Airflow实例。

接口说明

在工作空间下创建 Airflow 实例。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateAirflow

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

WorkspaceId

string

DMS 工作空间 ID。

8630242382****

AirflowName

string

Airflow 实例名称。

testairflow

Description

string

Airflow 实例描述。

order scheduler

AppSpec

string

Airflow 实例的规格,取值为:SMALLMEDIUMLARGEXLARGEX2LARGE

SMALL

WorkerServerlessReplicas

integer

Worker 节点扩展的数量。

0

VpcId

string

VPC ID。

vpc-uf63r6coyiw9o5****

VSwitchId

string

交换机 ID。

vsw-8vbaf073jawozfp****

SecurityGroupId

string

安全组 ID。

sg-bp108t8ldzeyk1****

OssBucketName

string

OSS Bucket 名称。

oss-test

OssPath

string

存放日志的 OSS 路径。

/airflow

StartupFile

string

Airflow 容器的启动脚本。

default/startup.sh

RequirementFile

string

安装包的路径。

default/requirements.txt

DagsDir

string

Airflow 扫描的 dag 目录。

default/dags

PluginsDir

string

Airflow 实例扫描的插件目标。

default/plugins

GracefulShutdownTimeout

integer

Worker 退出时的超时时间

60

EnableServerless

boolean

是否开启 Worker 弹性

DataMountInfoList

array

数据挂载信息列表

DataMountInfo

OSS 存储绑定

AirflowVersion

string

Airflow 版本,支持 3.1 或 2.10

3.1

ClientToken

string

客户端 Token,用于保证请求的幂等性。

token-****

ZoneId

string

Region 下的可用区 ID。

cn-hangzhou-h

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

AccessDeniedDetail

string

拒接访问的信息。

NOT_FOUND

Root

object

Airflow 数据字典。

AirflowName

string

Airflow 实例的名称。

testairflow

AppSpec

string

Airflow 实例的规格。

SMALL

AppType

string

类型。

airflow

DagsDir

string

Airflow 扫描 dag 的目录。

default/dags

DeployErrorMsg

string

错误日志信息。

vpc not found

Description

string

Airflow 的描述信息。

order scheduler

GmtCreated

string

创建时间。

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

OssBucketName

string

OSS Bucket 名称。

oss-test

OssPath

string

OSS 路径。

/airflow

PluginsDir

string

Airflow 扫描的插件目录。

default/plugins

RequirementFile

string

可安装包的路径。

default/requirements.txt

SecurityGroupId

string

安全组 ID。

sg-2ze1nak7h0alg1xxx

StartupFile

string

Airflow 实例的启动时加载的文件,可设置环境变量等。

default/startup.sh

Status

string

Airflow 实例状态。

DEPLOYING

AirflowId

string

Airflow 的实例 ID。

af-****

VSwitchId

string

交换机 ID。

vsw-8vbaf073jawozfpbg****

VpcId

string

VPC ID。

vpc-uf63r6coyiw9o5gf****

WorkerServerlessReplicas

integer

Worker 扩展节点的数量。

0

WorkspaceId

string

工作空间 ID。

86302423828****

ZoneId

string

可用区 ID。

cn-hangzhou-h

AirflowVersion

string

Airflow 版本

3.1

CustomAirflowCfg

array

自定义 Airflow 配置

string

自定义 Airflow 配置项

celery.worker_concurrency=10

DataMountInfoList

array

数据挂载信息列表

DataMountInfo

数据挂载

EnableServerless

boolean

是否开启 Worker 弹性

GracefulShutdownTimeout

integer

Worker 退出时的超时时间

60

Message

string

日志信息。

Successful

HttpStatusCode

integer

HTTP 状态码。

200

ErrorCode

string

错误码。

UnknownError

Success

boolean

请求是否成功,返回值:

  • true:请求成功。

  • false:请求失败。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "AccessDeniedDetail": "NOT_FOUND",
  "Root": {
    "AirflowName": "testairflow",
    "AppSpec": "SMALL",
    "AppType": "airflow",
    "DagsDir": "default/dags",
    "DeployErrorMsg": "vpc not found",
    "Description": "order scheduler",
    "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-****",
    "VSwitchId": "vsw-8vbaf073jawozfpbg****",
    "VpcId": "vpc-uf63r6coyiw9o5gf****",
    "WorkerServerlessReplicas": 0,
    "WorkspaceId": "86302423828****",
    "ZoneId": "cn-hangzhou-h",
    "AirflowVersion": "3.1",
    "CustomAirflowCfg": [
      "celery.worker_concurrency=10"
    ],
    "DataMountInfoList": [
      {
        "OssBucket": "",
        "Prefix": "",
        "MountFolderName": "",
        "ReadOnly": true
      }
    ],
    "EnableServerless": true,
    "GracefulShutdownTimeout": 60
  },
  "Message": "Successful",
  "HttpStatusCode": 200,
  "ErrorCode": "UnknownError",
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情