ジャンプ先

• リクエスト
• レスポンス
• 例

Sparkを実装として使用した、ラスター・ファイルのHDFSへのロード

post

/spatialviewer/api/v1/raster/spark/operations/load

リクエスト

サポートされるメディア・タイプ

• application/json

問合せパラメータ

• async(optional): boolean
  ジョブの非同期実行が必要かどうかを示します。デフォルトでは、この値はfalseです。

本文()

必要な詳細をすべて含むラスター・ロード・オブジェクト

ルート・スキーマ: RasterLoadOperationPayloadObject

型: object

ソースの表示

• dfsBlockSizeMB: number
  アップロード・ラスターのタイル・サイズを決定するために使用される値。

  例: 128
• inputPaths: string
  カンマで区切られたファイル・パス

  例: /opt/oracle/oracle-spatial-graph/spatial/raster/HOL/data/raster/hawaii.tif,/opt/oracle/oracle-spatial-graph/spatial/raster/HOL/data/raster/maui.tif
• memoryMB(optional): number
  Hadoopでのジョブの実行のためにメモリーを予約する目的で使用される値。この値をSparkエンドポイントに送信すると、その値は無視されます。

  例: 160
• outputDirectory: string
  出力ディレクトリ名。ディレクトリはHDFS内に作成されます(まだ存在しない場合)。デフォルトはuploadです。ディレクトリ名の規則に従い、特殊文字は「:」を含めて無効です。

  例: upload
• overlap: number
  最小値: 1

  最大値: 200

  ラスターの重複値

  例: 2

{
    "type":"object",
    "properties":{
        "overlap":{
            "type":"number",
            "description":"Raster overlap value",
            "example":2,
            "minimum":1,
            "maximum":200
        },
        "inputPaths":{
            "type":"string",
            "description":"File paths separed by comma",
            "example":"/opt/oracle/oracle-spatial-graph/spatial/raster/HOL/data/raster/hawaii.tif,/opt/oracle/oracle-spatial-graph/spatial/raster/HOL/data/raster/maui.tif"
        },
        "outputDirectory":{
            "type":"string",
            "description":"Output directory name. Directory will be created inside the HDFS (If it not exists yet). By default: upload. It follow the rules for directory names, special characters are not valid even ':'",
            "example":"upload"
        },
        "memoryMB":{
            "type":"number",
            "description":"Value used to reserve memory for run the job in hadoop. If you send this value to the spark endpoint the value will be ignored.",
            "example":160
        },
        "dfsBlockSizeMB":{
            "type":"number",
            "description":"Value used to determine the tiles size of the upload rasters.",
            "example":128
        }
    },
    "required":[
        "outputDirectory",
        "overlap",
        "inputPaths",
        "dfsBlockSizeMB"
    ]
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

201レスポンス

ラスター・ロード操作は正常に実行されました

本文()

ルート・スキーマ: RasterLoadOperationSuccessResponse

型: object

ソースの表示

• o:successCode(optional): string
  成功コード。

  例: SVR-00200
• response(optional): object response
  成功レスポンスの詳細
• status(optional): string
  成功またはエラー

  例: sucess
• title(optional): string
  レスポンスの説明

  例: Success Response.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"sucess"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Success Response."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-00200"
        },
        "response":{
            "type":"object",
            "description":"Details about the success response",
            "properties":{
                "message":{
                    "type":"string",
                    "description":"Success message",
                    "example":"Rasters load finished successfully, jobId: job_1533232152884_0462"
                },
                "items":{
                    "type":"array",
                    "description":"List the details of the uploaded rasters individually.",
                    "items":{
                        "$ref":"#/definitions/RasterLoadRasterDetailsEntry"
                    }
                }
            }
        }
    }
}

ネストされたスキーマ: response

型: object

成功レスポンスの詳細

ソースの表示

• items(optional): array items
  アップロードされたラスターの詳細を個別に一覧表示します。
• message(optional): string
  成功メッセージ

  例: Rasters load finished successfully, jobId: job_1533232152884_0462

{
    "type":"object",
    "description":"Details about the success response",
    "properties":{
        "message":{
            "type":"string",
            "description":"Success message",
            "example":"Rasters load finished successfully, jobId: job_1533232152884_0462"
        },
        "items":{
            "type":"array",
            "description":"List the details of the uploaded rasters individually.",
            "items":{
                "$ref":"#/definitions/RasterLoadRasterDetailsEntry"
            }
        }
    }
}

ネストされたスキーマ: items

型: array

アップロードされたラスターの詳細を個別に一覧表示します。

ソースの表示

• 配列: object RasterLoadRasterDetailsEntry

{
    "type":"array",
    "description":"List the details of the uploaded rasters individually.",
    "items":{
        "$ref":"#/definitions/RasterLoadRasterDetailsEntry"
    }
}

ネストされたスキーマ: RasterLoadRasterDetailsEntry

型: object

ソースの表示

• inputFile(optional): string
  入力ファイル・パス。

  例: /net/den01spo/scratch/swap/spatialviewer/data/rasters/kahoolawe.tif
• metadata(optional): string
  生成されたラスター・メタデータのパス。

  例: /user/hdfs/spatial_raster/metadata/af766de6bf3ea93700163ee99ca6d61c88501ae6.loc
• outputFile(optional): string
  特殊な形式のアップロードされたラスターのパス。

  例: /user/hdfs/upload/kahoolawe.tif.ohif
• thumbnail(optional): string
  このラスター・ファイルに対して生成されたサムネイルのパス。

  例: /net/den01spo/scratch/swap/spatialviewer//thumb/user/hdfs/upload/kahoolawe.tif.ohif.tif

{
    "type":"object",
    "properties":{
        "inputFile":{
            "type":"string",
            "description":"Input file path.",
            "example":"/net/den01spo/scratch/swap/spatialviewer/data/rasters/kahoolawe.tif"
        },
        "metadata":{
            "type":"string",
            "description":"Path of the generated raster metadata.",
            "example":"/user/hdfs/spatial_raster/metadata/af766de6bf3ea93700163ee99ca6d61c88501ae6.loc"
        },
        "outputFile":{
            "type":"string",
            "description":"Path of the uploaded raster in a special format.",
            "example":"/user/hdfs/upload/kahoolawe.tif.ohif"
        },
        "thumbnail":{
            "type":"string",
            "description":"Path of the generated thumbnail for this raster file.",
            "example":"/net/den01spo/scratch/swap/spatialviewer//thumb/user/hdfs/upload/kahoolawe.tif.ohif.tif"
        }
    }
}

202レスポンス

ラスター・ロード操作がスケジュールされました

本文()

ルート・スキーマ: RasterOperationAcceptedResponse

型: object

ソースの表示

• o:successCode(optional): string
  成功コード。

  例: SVR-00205
• response(optional): string
  ジョブ・ステータス・トラッキングURL

  例: http://system4.example.com:8088
• status(optional): string
  成功またはエラー

  例: sucess
• title(optional): string
  レスポンスの説明

  例: Job was accepted.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"sucess"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Job was accepted."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-00205"
        },
        "response":{
            "type":"string",
            "description":"Job status tracking URL",
            "example":"http://system4.example.com:8088"
        }
    }
}

406レスポンス

無効なパラメータ

本文()

ルート・スキーマ: RasterOperationsInvalidParametersResponse

型: object

ソースの表示

• detail(optional): string
  不良パラメータに関するレスポンス詳細情報メッセージ

  例: newDiretory: New Directory name can not be null, overlap: Overlap value can not be null
• o:errorCode(optional): string
  エラー・コード。

  例: SVR-E0010
• status(optional): string
  成功またはエラー

  例: error
• title(optional): string
  レスポンスの説明

  例: Invalid parameters.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Invalid parameters."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Error code.",
            "example":"SVR-E0010"
        },
        "detail":{
            "type":"string",
            "description":"Response details information message about the bad parameters",
            "example":"newDiretory: New Directory name can not be null, overlap: Overlap value can not be null"
        }
    }
}

417レスポンス

ラスター・ロード操作は、実装の選択でのエラーにより失敗しました

本文()

ルート・スキーマ: RasterLoadOperationUnsuccessResponse

型: object

ソースの表示

• detail(optional): string
  失敗したジョブに関するレスポンス詳細情報メッセージ。Hadoopの場合は、ログ詳細をダウンロードするURLのようなログに関する情報を含めることができます。

  例: Raster load finished unsuccessfully
• o:errorCode(optional): string
  エラー・コード。

  例: SVR-E0020
• status(optional): string
  成功またはエラー

  例: error
• title(optional): string
  レスポンスの説明

  例: Invalid parameters.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Invalid parameters."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Error code.",
            "example":"SVR-E0020"
        },
        "detail":{
            "type":"string",
            "description":"Response details information message about the failed job. For hadoop can contain information about the logs like an URL to download the log details.",
            "example":"Raster load finished unsuccessfully"
        }
    }
}

500レスポンス

不明なエラー

本文()

ルート・スキーマ: RasterErrorGenericResponse

型: object

ソースの表示

• detail(optional): string
  レスポンスの詳細情報

  例: Unknow error
• o:errorCode(optional): string
  成功コード。

  例: SVR-E0001
• status(optional): string
  成功またはエラー

  例: error
• title(optional): string
  レスポンスの説明

  例: Error while processing REST request.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Error while processing REST request."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-E0001"
        },
        "detail":{
            "type":"string",
            "description":"Response details information",
            "example":"Unknow error"
        }
    }
}

503レスポンス

GDAL設定が不完全です

本文()

ルート・スキーマ: GDALSetUpIsIncompleteResponse

型: object

ソースの表示

• detail(optional): string
  情報メッセージ

  例: GDAL library is not correctly set up. Check the admin settings or your GDAL installation
• o:errorCode(optional): string
  エラー・コード。

  例: SVR-E0012
• status(optional): string
  成功またはエラー

  例: error
• title(optional): string
  レスポンスの説明

  例: GDAL library is not correctly set up.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"GDAL library is not correctly set up."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Error code.",
            "example":"SVR-E0012"
        },
        "detail":{
            "type":"string",
            "description":"Informative message",
            "example":"GDAL library is not correctly set up. Check the admin settings or your GDAL installation"
        }
    }
}

先頭に戻る

例

Sparkを使用してラスター・ファイルをhdfsにロードし、ロード・ジョブをスケジュールまたは開始します。

次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、Sparkを実装として使用してラスター・ロードを送信する方法を示しています。

curl -X POST "http://localhost:8045/spatialviewer/api/v1/raster/spark/operations/load?async=false" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"outputDirectory\":\"upload\",\"overlap\":\"2\",\"blockSizeMB (MB)\":\"128\",\"inputPaths\":\"/net/den01spo/scratch/swap/spatialviewer/data/rasters/hawaii.tif\"}"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例

HTTP/1.1 200 OK Date: Wed, 22 Aug 2018 22:32:56 GMT Content-Type: application/json Access-Control-Allow-Origin: * Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST, DELETE, PUT Access-Control-Allow-Headers: Content-Type, Accept Transfer-Encoding: chunked

レスポンス本文の例

次の例は、レスポンス本文の内容をJSON形式で示したものです

{ "status" : "success", "title" : "Success Response.", "o:successCode" : "SVR-00200", "response" : { "message" : "Rasters load finished successfully, jobId: application_1533232152884_0600", "items" : [ { "inputFile" : "/net/den01spo/scratch/swap/spatialviewer/data/rasters/hawaii.tif", "metadata" : "/user/hdfs/spatial_raster/metadata/78e9beec959cf0c81a582b49fba227ea288b1ddb.loc", "outputFile" : "/user/hdfs/upload/hawaii.tif.ohif", "thumbnail" : "/net/den01spo/scratch/swap/spatialviewer//thumb/user/hdfs/upload/hawaii.tif.ohif.tif" } ] } }

先頭に戻る