このサービスは、空間データセットに対して空間ビニングを実行します。
post
/spatialviewer/api/v1/hadoop/binningJob
リクエスト
サポートされるメディア・タイプ
- application/json
問合せパラメータ
- asynchronous: boolean
trueの場合、この操作は非同期で実行されます。デフォルト値:
false
ジョブ詳細
ルート・スキーマ: BinningJobInfo
型:
ソースの表示
object
- cellHeight(optional): number(double)
形状が矩形の場合は、矩形の高さを指定します。例:
2.5
- cellWidth(optional): number(double)
六角形または矩形の幅。例:
5
- dataPath(optional): string
HDFS内のファイルのパス。useIndexがfalseの場合は、このプロパティを指定します。例:
/user/oracle/spatialviewer/tweetsJune.json
- gridMaxX(optional): number(double)
ビニング・グリッドの最小外接矩形(MBR)の最大のX値。例:
175
- gridMaxY(optional): number(double)
ビニング・グリッドの最小外接矩形(MBR)の最大のY値。例:
75
- gridMinX(optional): number(double)
ビニング・グリッドの最小外接矩形(MBR)の最小のX値。例:
-175
- gridMinY(optional): number(double)
ビニング・グリッドの最小外接矩形(MBR)の最小のY値。例:
-75
- indexName(optional): string
索引の名前。useIndexがtrueの場合は、このプロパティを指定します。例:
TweetsJune
- inputFormatClass(optional): string
入力形式クラス。useIndexがfalseの場合は、このプロパティを指定します。例:
oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat
- jarWithNeededClasses(optional): string
カスタムRecordInfoProviderまたはInputFormatのようなユーザー定義クラスを持つJAR名。InputFormatクラスまたはRecordInfoProviderクラスがAPI、またはHadoop APIクラスにない場合、ユーザー定義クラスのJARが提供されます。このjarを使用するには、/opt/oracle/oracle-spatial-graph/spatial/web-server/spatialviewer/WEB-INF/libディレクトリに追加し、サーバーを再起動する必要があります。useIndexがfalseの場合に設定可能なオプションのプロパティ。例:
myjar.jar
- outputPath(optional): string
Hadoopジョブの出力パス。例:
/user/oracle/spatialviewer/binResult
- recordInfoProviderClass(optional): string
空間情報を提供するクラス。useIndexがfalseの場合は、このプロパティを指定します。例:
oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider
- resultName(optional): string
結果名。例:
Binning Count TweetsJune
- shape(optional): string
デフォルト値:
hexagon
指定可能な値:[ "hexagon", "rectangle" ]
ビニング・グリッドのセルの形状。指定可能な値はhexagonまたはrectangleです。例:hexagon
- srid(optional): integer(int32)
ジオメトリのSRID。useIndexがfalseの場合は、このプロパティを指定します。例:
8307
- thematicAttribute(optional): string
テーマ・フィールドには、指定されたRecordInfoProviderクラスの関数getExtraFieldsによって返されたフィールド、またはビンのレコード数を指定するカウント属性によって返されたフィールドのいずれかを指定できます。例:
count
- tolerance(optional): number(double)
空間操作を実行するときに使用される許容差を表すdouble値。useIndexがfalseの場合は、このプロパティを指定します。例:
0.05
- useIndex(optional): boolean
索引が入力として使用される場合はtrue、それ以外の場合はfalse例:
true
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
要求が成功しました。
レスポンスには、HDFS内の結果の場所が含まれています。
また、ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダbinning_resultsに保存されます。結果は、表示用にMap API VectorLayer (OM.layer.VectorLayer)のデータ・ソースとして使用できます。
レスポンスには、HDFS内の結果の場所が含まれています。
また、ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダbinning_resultsに保存されます。結果は、表示用にMap API VectorLayer (OM.layer.VectorLayer)のデータ・ソースとして使用できます。
ルート・スキーマ: BinningJobResponse
型:
ソースの表示
object
- o:successCode(optional): string
成功コード。例:
SV-05004
- response(optional): string
レスポンスには、HDFS内の結果の場所が含まれています。例:
hdfs://<namenode>:8020/user/oracle/spatialviewer/binResult
- status(optional): string
成功またはエラー例:
success
- title(optional): string
サービスのタイトル。例:
Create binning job.
202レスポンス
非同期リクエストを受け入れました。
レスポンスには、ジョブを追跡するためのリソース・マネージャWebアプリケーションのURLが含まれています。
また、ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダbinning_resultsに保存されます。結果は、表示用にMap API VectorLayer (OM.layer.VectorLayer)のデータ・ソースとして使用できます。
レスポンスには、ジョブを追跡するためのリソース・マネージャWebアプリケーションのURLが含まれています。
また、ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダbinning_resultsに保存されます。結果は、表示用にMap API VectorLayer (OM.layer.VectorLayer)のデータ・ソースとして使用できます。
ルート・スキーマ: AsyncBinningJobResponse
型:
ソースの表示
object
- o:successCode(optional): string
成功コード。例:
SV-05004
- response(optional): string
レスポンスには、ジョブを追跡するためのリソース・マネージャWebアプリケーションのURLが含まれています。SpatialViewer Hadoop構成でこの値を参照してください(ユーザーズ・ガイドの第1.8.4章「Oracle Big Data ApplianceでOracle SpatialViewerの構成」を参照してください)。パラメータはyarn.resourcemanager.webapp.addressです。例:
http://resource.manager.webapp:8088
- status(optional): string
成功またはエラー例:
success
- title(optional): string
サービスのタイトル。例:
Create binning job.
例
次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、索引tweetsJanuaryを使用してビニング分析を実行する方法を示しています。
curl -v -X POST "http://localhost:8045/spatialviewer/api/v1/hadoop/binningJob" -H "accept: application/json" -H "content-type: application/json" -d "{ \"useIndex\": true, \"indexName\": \"tweetsJanuary\", \"gridMinX\": -175, \"gridMinY\": -75, \"gridMaxX\": 175, \"gridMaxY\": 75, \"shape\": \"hexagon\", \"cellWidth\": 5, \"thematicAttribute\": \"count\", \"outputPath\": \"/user/oracle/binResult\", \"resultName\": \"Binning Count Tweets\"}"
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 200 OK Date: Wed, 15 Nov 2017 17:50:38 GMT 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 Content-Type: application/json
レスポンス本文の例
次の例は、レスポンス本文の内容をJSON形式で示したものです。
{"status" : "success", "title" : "Create binning job.", "o:successCode" : "SV-05004", "response" : "hdfs://localhost:8020/user/oracle/binResult"}