导入 API

一般的处理流程如下：

使用方准备好一个用于导入操作的 ZIP 文件。有关该 API 两种形式的详细信息，请参见下文。
如果调用成功，API 将返回操作结果。
调用失败时将返回错误信息。

使用 POST 导入 ZIP 文件

标题	导入 API
示例	参见下方的示例章节。
描述	在请求正文中提供要导入的文件内容。
URL	api/atlas/admin/import
方法	POST
URL 参数	无
数据参数	无
成功响应	以 JSON 形式返回 AtlasImporResult。详见下文。
错误响应	系统内部处理的错误将以 AtlasBaseException 形式返回。

导入服务器上可用的 ZIP 文件

标题	导入 API
示例	参见下方的示例章节。
描述	提供要导入的文件路径。
URL	api/atlas/admin/importfile
方法	POST
URL 参数	无
数据参数	无
成功响应	以 JSON 形式返回 AtlasImporResult。详见下文。
错误响应	系统内部处理的错误将以 AtlasBaseException 形式返回。
说明	要导入的文件必须位于服务器上 FILENAME 参数所指定的位置。

导入的方法签名

@POST
@Path("/import")
@Produces("application/json; charset=UTF-8")
@Consumes("multipart/form-data")

导入文件的方法签名

@POST
@Path("/importfile")
@Produces("application/json; charset=UTF-8")
@Consumes("application/json")

导入选项 导入过程中可用的选项请参见此处。

AtlasImportResult 响应 API 将以 AtlasImportResult 定义的格式返回导入操作的结果：

AtlasImportParameters：包含导入操作期间应用的选项的名称-值对集合。
Metrics：操作指标。包括导入的类型数量、导入的实体数量等详细信息。
Processed Entities：包含已处理实体的 GUID 列表。
Operation Status：操作的整体状态。取值为 SUCCESS、PARTIALSUCCESS、_FAIL。

使用 CURL 调用的示例

以下调用使用 POST 导入 QuickStart 数据库。

curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data"
            -H "Cache-Control: no-cache"
            -F request=@importOptions.json
            -F data=@quickStartDB.zip
            "http://localhost:21000/api/atlas/admin/import"

request 参数为可选参数。若要在不使用任何选项的情况下运行导入，请使用：

curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data"
            -H "Cache-Control: no-cache"
            -F data=@quickStartDB.zip
            "http://localhost:21000/api/atlas/admin/import"

下面的调用使用服务器上的 ZIP 文件对 QuickStart 数据库执行导入操作。

curl -X POST -u adminuser:password -H "Cache-Control: no-cache" -d ./importOptions.json
"http://localhost:21000/api/atlas/admin/importFile" > quickStartDB-import-result.json

下面是包含 hive_db 的导入所产生的 AtlasImportResult JSON。

processedEntities 包含所有已导入实体的 guid。

metrics 包含所导入类型和实体的明细统计，以及对其执行的操作，即 created（新建）或 updated（更新）。

{
    "request": {
        "options": {}
    },
    "userName": "admin",
    "clientIpAddress": "10.0.2.2",
    "hostName": "10.0.2.15",
    "timeStamp": 1491285622823,
    "metrics": {
        "duration": 9143,
        "typedef:enum": 0,
        "typedef:struct": 0,
        "entity:hive_column:created": 461,
        "entity:hive_storagedesc:created": 20,
        "entity:hive_process:created": 12,
        "entity:hive_db:created": 5,
        "entity:hive_table:created": 20,
        "entity:hdfs_path:created": 2,
        "typedef:entitydef": 0,
        "typedef:classification": 3
    },
    "processedEntities": [
        "2c4aa713-030b-4fb3-98b1-1cab23d9ac81",
        "e4aa71ed-70fd-4fa7-9dfb-8250a573e293",
       ...
        "ea0f9bdb-1dfc-4e48-9848-a006129929f9",
        "b5e2cb41-3e7d-4468-84e1-d87c320e75f9"
    ],
    "operationStatus": "SUCCESS"
}

导入 API

导入 API

使用 POST 导入 ZIP 文件

导入服务器上可用的 ZIP 文件

使用 CURL 调用的示例

评论