更新时间:2026-10-21 GMT+08:00
分享

使用API连接AuraJobV2端点并提交作业

当您需要将数据处理能力集成到业务系统中,或通过代码自动化提交Aura作业和查询作业状态时,可以通过API连接AuraJobV2端点。API 提供标准RESTful接口,方便您通过代码调用。

前提条件

  • 已创建AuraJobV2端点且端点状态为“运行中”。具体操作,请参见创建Aura引擎端点。
  • 已获取工作空间ID和AuraJobV2端点名称。
  • 已获取LakeFormation的Catalog名称。

步骤一:创建会话

  1. 使用Postman等工具,调用API连接AuraJobV2端点。

    调用API的具体操作,请参见如何调用API。

    请求示例如下:

    POST /v2/workspaces/{workspace_id}/aura-sessions
    
    {
      "endpoint_name" : "aura-job-iqr0",
      "catalog_context" : {
        "catalog_name" : "aurasql_default"
      }
    }

    参数说明如表1所示,更多信息,请参见创建Session。

    表1 参数说明

    参数

    说明

    示例

    workspace_id

    工作空间的ID。

    302ce559-9759-4586-9885-90d6c0b4****

    endpoint_name

    Aura端点名称。

    aura-job-iqr0

    catalog_name

    LakeFormation的Catalog名称。

    aurasql_default

  2. 返回响应信息,类似如下所示,表示连接AuraJobV2端点成功。

    {
      "session_id" : "ac8111bf-3601-4905-8ddd-b41d3e63****",
      "status" : "RUNNING"
    }

步骤二:提交作业

创建会话后,您可以通过API在指定会话中提交SQL作业。

  1. 使用Postman等工具,调用API在指定会话中执行SQL作业。

    请求示例如下:

    POST /v2/workspaces/{workspace_id}/aura-sessions/statements
    
    {
      "statement" : "select version();",
      "session_id" : "string",
      "is_sync" : true
    }

    参数说明如表2所示,更多信息,请参见在指定Session中执行SQL。

    表2 参数说明

    参数

    说明

    示例

    workspace_id

    工作空间的ID。

    302ce559-9759-4586-9885-90d6c0b4****

    statement

    SQL作业详细信息。

    select version();

    session_id

    会话ID。

    ac8111bf-3601-4905-8ddd-b41d3e63****

    is_sync

    同步执行或异步执行。取值范围:

    • true:同步。
    • false:异步。

    true

  2. 返回响应信息,类似如下所示,表示提交SQL作业成功。

    {
        "status": 0,
        "session_id": "01a0c85e-330d-7fca-93bf-2b5f04cd****",
        "statement_id": "01a0c85e-6167-7f84-bad7-267caa5e****",
        "retry_flag": "NONE",
        "results": [
            {
                "status": "PGRES_TUPLES_OK",
                "statement_id": "01a0c85e-6167-7f84-bad7-267caa5e****",
                "num_rows": 1,
                "row_count": 1,
                "page_count": 1,
                "page_no": 1,
                "err_code": "0",
                "sql_state": "0",
                "message": "",
                "result_set": {
                    "columns": [
                        {
                            "name": "version",
                            "table_id": 0,
                            "column_id": 0,
                            "format": 0,
                            "type": 25,
                            "size": -1,
                            "type_mod": -1
                        }
                    ],
                    "rows": [
                        [
                            "PostgreSQL 9.2.4 (Aura 26.9.0 build bf546b91) compiled at 2026-09-18 13:21:04 commit 3130 last mr 3769  YR SDK version 205.0.0.B021 release"
                        ]
                    ]
                }
            }
        ]
    }

相关操作

  • 在指定会话中执行SQL后,您可以通过API查询SQL语句执行结果。具体操作,请参见查看SQL执行结果。
  • 执行相关操作后,您可以通过API关闭会话。具体操作,请参见关闭Session。

相关文档