ジャンプ先

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

このサービスは、データ・セット内の空間クラスタを見つけるために使用します

post

/spatialviewer/api/v1/hadoop/clusteringJob

このサービスでは、K-meansアルゴリズムの分散バージョンを使用します。

リクエスト

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

• application/json

問合せパラメータ

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

  デフォルト値: false

本文()

ジョブ詳細

ルート・スキーマ: ClusteringJobInfo

型: object

ソースの表示

• dataPath(optional): string
  HDFS内のファイルのパス。

  例: /user/oracle/spatialviewer/tweetsJune.json
• inputFormatClass(optional): string
  入力形式クラス。

  例: 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ディレクトリに追加し、サーバーを再起動する必要があります。オプションのプロパティ。

  例: myjar.jar
• numberOfClusters(optional): integer(int32)
  検出されるクラスタの数。

  例: 4
• outputPath(optional): string
  Hadoopジョブの出力パス。

  例: /user/oracle/spatialviewer/clusteringResult
• recordInfoProviderClass(optional): string
  空間情報を提供するクラス。

  例: oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider
• resultName(optional): string
  結果名。

  例: Clustering Tweets June
• srid(optional): integer(int32)
  ジオメトリのSRID。

  例: 8307
• tolerance(optional): number(double)
  空間操作を実行するときに使用される許容差を表すdouble値。

  例: 0.05

{
    "type":"object",
    "properties":{
        "dataPath":{
            "type":"string",
            "description":"Path of the file or files in HDFS.",
            "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.",
            "example":"myjar.jar"
        },
        "inputFormatClass":{
            "type":"string",
            "description":"The input format class.",
            "example":"oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat"
        },
        "recordInfoProviderClass":{
            "type":"string",
            "description":"The class that provides the spatial information.",
            "example":"oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider"
        },
        "srid":{
            "type":"integer",
            "description":"SRID of the geometries.",
            "format":"int32",
            "example":8307
        },
        "tolerance":{
            "type":"number",
            "description":"Double value that represents the tolerance used when performing spatial operations. ",
            "format":"double",
            "example":0.05
        },
        "numberOfClusters":{
            "type":"integer",
            "description":"Number of clusters to be found.",
            "format":"int32",
            "example":4
        },
        "outputPath":{
            "type":"string",
            "description":"The Hadoop job output path.",
            "example":"/user/oracle/spatialviewer/clusteringResult"
        },
        "resultName":{
            "type":"string",
            "description":"The result name.",
            "example":"Clustering Tweets June"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

要求が成功しました。

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

ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダclustering_resultsに保存されます。結果は、表示用にMap API VectorLayer (OM.layer.VectorLayer)のデータ・ソースとして使用できます。

本文()

ルート・スキーマ: ClusteringJobResponse

型: object

ソースの表示

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

  例: SV-05005
• response(optional): string
  レスポンスには、HDFS内の結果の場所が含まれています。

  例: hdfs://<namenode>:8020/user/oracle/spatialviewer/clusteringResult
• status(optional): string
  成功またはエラー

  例: success
• title(optional): string
  サービスのタイトル。

  例: Create clustering job.

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

202レスポンス

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

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

さらに、ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダclustering_resultsに保存されます。結果は、表示用にMap API VectorLayer (OM.layer.VectorLayer)のデータ・ソースとして使用できます。

本文()

ルート・スキーマ: AsyncClusteringJobResponse

型: object

ソースの表示

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

  例: SV-05005
• 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 clustering job.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Create clustering job."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05005"
        },
        "response":{
            "type":"string",
            "description":"The response contains the resource manager web application URL to track the job. See this value in the SpatialViewer Hadoop configuration (refer to user's guide chapter 1.8.4 Configuring the Oracle SpatialViewer on Oracle Big Data Appliance). The parameter is yarn.resourcemanager.webapp.address.",
            "example":"http://resource.manager.webapp:8088"
        }
    }
}

先頭に戻る

例

次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、クラスタリング分析を実行する方法を示しています。

curl -v -X POST "http://localhost:8045/spatialviewer/api/v1/hadoop/clusteringJob" -H  "accept: application/json" -H  "content-type: application/json" -d "{  \"dataPath\": \"/user/oracle/tweets.json\", \"inputFormatClass\": \"oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat\",  \"recordInfoProviderClass\": \"oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider\",  \"srid\": 8307,  \"tolerance\": 0.05,  \"numberOfClusters\": 5,  \"outputPath\": \"/user/oracle/clusteringResult\",  \"resultName\": \"Clustering 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 clustering job.", "o:successCode" : "SV-05005", "response" : "hdfs://localhost:8020/user/oracle/clusteringResult"} 

先頭に戻る