Big Data Spatial and GraphのREST API

データを階層のエンティティに分類するためのサービス

post

/spatialviewer/api/v1/hadoop/categorizationJob

このサービスは、データを階層のエンティティに分類するための方法を提供します。大陸部、国、および州などの境界のレベルが定義されている一連の特定のカタログの場合、ユーザー・データのレコードを階層データ・セットの各レベルに結合できます。たとえば、大陸部/国/州/都市という階層内の指定されたHDFSファイルからすべてのツイッターを表示するために使用できます。

リクエスト

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

application/json

問合せパラメータ

asynchronous: boolean

trueの場合、この操作は非同期で実行されます。

デフォルト値: false

ジョブ詳細

ルート・スキーマ: CategorizationJobInfo

型: object

ソースの表示

dataPath(optional): string

分類するHDFS内のファイルのパス。useIndexがfalseの場合は、このプロパティを指定します。

例: /user/oracle/spatialviewer/tweetsJune.json
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
jobtemplates(optional): string

テーマ・マップ(ファイル名)を作成するためのテンプレート。フォルダ/opt/oracle/oracle-spatial-graph/spatial/vector/examplesの例では、国や地域のテンプレートのような一般的に使用されるテンプレートを提供しています。

例: world_continents,world_countries,world_states_provinces
outputPath(optional): string

Hadoopジョブの出力パス。

例: /user/oracle/spatialviewer/catResult
recordInfoProviderClass(optional): string

空間情報を提供するクラス。useIndexがfalseの場合は、このプロパティを指定します。

例: oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider
resultName(optional): string

結果名。

例: Categorization TweetsJune
useIndex(optional): boolean

索引が入力として使用される場合はtrue、それ以外の場合はfalse

例: true
useMVSuggest(optional): string

MVSuggestサービスを使用する必要があるかどうか。ジオメトリを場所の文字列から検出する場合は、MVSuggestサービスを使用します。この場合、指定されたRecordInfoProviderがインタフェース oracle.spatial.hadoop.vector.LocalizableRecordInfoProviderを実装する必要があります。フォルダ/opt/oracle/oracle-spatial-graph/spatial/vector/examplesのMVSuggest (データ・エンリッチメント・サービス)の使用方法の例を参照してください。useIndexがfalseの場合は、このプロパティを指定します。

例: false

{
    "type":"object",
    "properties":{
        "useIndex":{
            "type":"boolean",
            "description":"true if an index is used as input, false otherwise",
            "example":true
        },
        "indexName":{
            "type":"string",
            "description":"The index name. Specify this property if useIndex is true.",
            "example":"TweetsJune"
        },
        "dataPath":{
            "type":"string",
            "description":"Path of the file or files in HDFS to categorize. Specify this property if useIndex is false.",
            "example":"/user/oracle/spatialviewer/tweetsJune.json"
        },
        "jarWithNeededClasses":{
            "type":"string",
            "description":"jar name with the user-defined classes like custom RecordInfoProvider or InputFormat. If the InputFormat class or the RecordInfoProvider class is not in the API, or in the hadoop API classes, then a jar with the user-defined classes must be provided. To be able to use this jar the user must add it in the /opt/oracle/oracle-spatial-graph/spatial/web-server/spatialviewer/WEB-INF/lib directory and restart the server. Optional property that can be set if useIndex is false.",
            "example":"myjar.jar"
        },
        "inputFormatClass":{
            "type":"string",
            "description":"The input format class. Specify this property if useIndex is false.",
            "example":"oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat"
        },
        "recordInfoProviderClass":{
            "type":"string",
            "description":"The class that provides the spatial information. Specify this property if useIndex is false.",
            "example":"oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider"
        },
        "useMVSuggest":{
            "type":"string",
            "description":"If the MVSuggest service has to be used or not. If the geometry must be found from a location string, then use the MVSuggest service. In this case the provided RecordInfoProvider has to implement the interface oracle.spatial.hadoop.vector.LocalizableRecordInfoProvider. See examples on how to use the MVSuggest (data enrichment service) in the folder /opt/oracle/oracle-spatial-graph/spatial/vector/examples. Specify this property if useIndex is false.",
            "example":false
        },
        "jobtemplates":{
            "type":"string",
            "description":"The templates to create the thematic maps (file names). The examples in the folder /opt/oracle/oracle-spatial-graph/spatial/vector/examples provide commonly used templates like countries or world regions templates.",
            "example":"world_continents,world_countries,world_states_provinces"
        },
        "outputPath":{
            "type":"string",
            "description":"The Hadoop job output path.",
            "example":"/user/oracle/spatialviewer/catResult"
        },
        "resultName":{
            "type":"string",
            "description":"The result name.",
            "example":"Categorization TweetsJune"
        }
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

要求が成功しました。

レスポンスには、HDFS内の結果の場所が含まれています。

さらに、ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダcategorization_resultsに保存されます。

ルート・スキーマ: CategorizationJobResponse

型: object

ソースの表示

o:successCode(optional): string

成功コード。

例: SV-05003
response(optional): string

レスポンスには、HDFS内の結果の場所が含まれています。

例: hdfs://<namenode>:8020/user/oracle/spatialviewer/catResult
status(optional): string

成功またはエラー

例: success
title(optional): string

サービスのタイトル。

例: Create categorization job.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Create categorization job."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05003"
        },
        "response":{
            "type":"string",
            "description":"The response contains the location of the results in HDFS.",
            "example":"hdfs://<namenode>:8020/user/oracle/spatialviewer/catResult"
        }
    }
}

202レスポンス

非同期リクエストを受け入れました。

レスポンスには、ジョブを追跡するためのリソース・マネージャWebアプリケーションのURLが含まれています。

さらに、ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダcategorization_resultsに保存されます。

ルート・スキーマ: AsyncCategorizationJobResponse

型: object

ソースの表示

o:successCode(optional): string

成功コード。

例: SV-05003
response(optional): string

レスポンスには、ジョブを追跡するためのリソース・マネージャWebアプリケーションのURLの場所が含まれています(Hadoopパラメータyarn.resourcemanager.webapp.addressの構成を参照してください)。

例: http://resource.manager.webapp:8088
status(optional): string

成功またはエラー

例: success
title(optional): string

サービスのタイトル。

例: Create categorization job.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Create categorization job."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05003"
        },
        "response":{
            "type":"string",
            "description":"The response contains the location of the resource manager web application URL to track the job (see in the configuration the Hadoop parameter yarn.resourcemanager.webapp.address).",
            "example":"http://resource.manager.webapp:8088"
        }
    }
}

先頭に戻る

例

次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、テンプレートworld_continents、world_countriesおよびworld_states_provincesを使用して索引tweetsJanuaryのデータを分類する方法を示しています。

curl -v -X POST "http://localhost:8045/spatialviewer/api/v1/hadoop/categorizationJob" -H  "accept: application/json" -H  "content-type: application/json" -d "{  \"useIndex\": true,  \"indexName\": \"tweetsJanuary\",  \"jobtemplates\": \"world_continents,world_countries,world_states_provinces\",  \"outputPath\": \"/user/oracle/catResult\",  \"resultName\": \"Categorization 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 categorization job.", "o:successCode" : "SV-05003", "response" : "hdfs://localhost:8020/user/oracle/catResult"}

先頭に戻る