CreateCustomSchema
- 印刷する
- PDF
CreateCustomSchema
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
概要
ユーザー定義スキーマを作成します。
リクエスト
API URL
URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/schema
Method: POST
リクエストヘッダ
共通の設定に明示されたリクエストヘッダが必要です。
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}
リクエストボディ
| パラメータ名 | 必須の有無 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| prodName | Yes | String | スキーマ名 | |
| fields | Yes | List | 商品のスキーマ定義 | |
| useCustomResource | No | Boolean | default: false | Custom Resource使用の有無 |
FieldDto
構文
private String name;
private DataType dataType;
private boolean metric = false;
private boolean dimension = false;
private Boolean counter = false;
private boolean isIdDimension = false;
private Map<Interval, Set<Calculation>> aggregations;
private String desc;
フィールド
| パラメータ名 | 必須の有無 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| name | Yes | String | Product Schema名 | |
| dataType | Yes | DataType | - 当該fieldがMetricである場合、STRING, INTEGER, FLOAT, LONG - 当該fieldがDimensionである場合、STRINGタイプが有効 | MetricまたはDimensionのデータタイプを明示 |
| metric | No | Boolean | default : false | 当該FieldがMetricであることを明示 |
| dimension | No | Boolean | default : false | 当該FieldがDimensionであることを明示 |
| counter | No | Boolean | default : false | |
| isIdDimension | No | Boolean | default：falseで、Dimensionのうち必ず一つはidDimensionに設定する必要あり | - 当該fieldがDimensionである場合のみ設定可能 - ユーザーが定義した商品に対してEvent Rule作成時に当該Dimensionを基準に区分される |
| aggregations | No | Map<Interval, Set | - interval : Min1, Min5, Min30, Hour2, Day1 - Calculation : COUNT,SUM,MAX,MIN,AVG | - 当該fieldがMetricであるときにのみ設定可能 - 集計周期と集計関数の設定 |
| desc | No | String | Product Schemaの説明 |
例
リクエスト例
下記はcustom resourceを使用するMyProductというスキーマを作成する例です。
POST /cw_fea/real/cw/api/schema
Host: cw.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}
Payload:
{
"prodName": "Custom/MyProduct",
"fields": [
{
"dataType": "STRING",
"name": "dimensionName",
"dimension": true,
"metric": false,
"counter": false,
"idDimension": true,
"desc": "description"
},
{
"dataType": "FLOAT",
"name": "metricName",
"dimension": false,
"metric": true,
"counter": false,
"desc": "description",
"aggregations": {
"Min1": [
"AVG",
"SUM",
"MIN",
"MAX",
"COUNT"
],
"Min5": [
"AVG",
"SUM",
"MIN",
"MAX",
"COUNT"
],
"Min30": [
"AVG",
"SUM",
"MIN",
"MAX",
"COUNT"
],
"Hour2": [
"AVG",
"SUM",
"MIN",
"MAX",
"COUNT"
],
"Day1": [
"AVG",
"SUM",
"MIN",
"MAX",
"COUNT"
]
}
}
],
"useCustomResource": true
}
レスポンス例
エラーなく照会が完了すると、HTTP code 200と商品キー(cw_key)を含む簡単なJSON形式のレスポンスが返されます。
{
"cw_key": "xxxxxxxxxxxxxxxxxx"
}
この記事は役に立ちましたか?