Domain照会

登録するDomain情報を照会します。

GET https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/{name}

リクエスト

リクエストパラメータ

パラメータ名	必須	タイプ	説明
name	Yes	string	作成されているDomain名
haveContainer	Yes	boolean	コンテナ情報照会区分
haveUsgae	Yes	boolean	Domain使用量情報照会区分

レスポンス

フィールド名	必須	タイプ	説明	備考
autoCompleteChangeable	Yes	string	自動完成インデックス変更可能区分	ENABLE, DISABLE
autocompleteSchema	Yes	AutoCompleteSchema	自動完成設定
containerChangeable	Yes	string	検索用コンテナ変更可能区分	ENABLE, DISABLE
containers	Yes	List<Container>	コンテナ情報
createdDate	Yes	string	Domain作成時間
description	Yes	string	Domain説明
domainStatus	Yes	string	サービスステータス
domainUsage	Yes	DomanUsage	Domain使用量
indexerCount	Yes	number	インデックス用コンテナ数
name	Yes	string	Domain名
schema.document	Yes	Schema		検索設定
schemaChangeable	Yes	string	スキーマ修正可能区分	ENABLE, DISABLE
searcherCount	Yes	number	検索用コンテナ数
type	Yes	string	コンテナタイプ	small, medium, large, xlarge, xxlarge, xxxlarge
updatedDate	Yes	string	最終アップデート時間

レスポンスStatus

HTTP Status	Desc
200	OK(照会完了)
400	Bad Request
401	Unauthorized
401	there is no such service
403	Forbidden
404	Not Found
500	Internal Server Error

例示

リクエスト例示

GET https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/car

GET /CloudSearch/real/v1/domain/car HTTP/1.1:
Host:cloudsearch.apigw.ntruss.com
accept:application/json
x-ncp-iam-access-key:teGTwtcSEGA7fu28BGGi
x-ncp-apigw-signature-v2:Woa5hYjEe1D1LANFlWFe80g9zolMFDhQyoA5bmc8SJ0=
x-ncp-apigw-timestamp:1545635161290

レスポンス例示

{
  "name": "car_beta",
  "description": "",
  "domainStatus": "RUNNING",
  "containerChangeable": "ENABLE",
  "schemaChangeable": "ENABLE",
  "autoCompleteChangeable": "ENABLE",
  "type": "small",
  "indexerCount": 1,
  "searcherCount": 1,
  "schema": {
    "document": {
      "primarySectionName": "docid",
      "sections": [
        {
          "name": "docid"
        },
        {
          "name": "brand"
        },
        {
          "name": "name"
        },
        {
          "docProperties": [
            {
              "type": "string",
              "name": "dp_color"
            }
          ],
          "name": "color"
        },
        {
          "docProperties": [
            {
              "type": "uint32",
              "name": "dp_price"
            }
          ],
          "name": "price"
        },
        {
          "docProperties": [
            {
              "type": "string",
              "name": "dp_type"
            }
          ],
          "name": "type"
        },
        {
          "docProperties": [
            {
              "type": "uint32",
              "name": "dp_sell_cnt"
            }
          ],
          "name": "sell_cnt"
        },
        {
          "name": "image_url"
        }
      ],
      "indexes": [
        {
          "name": "brand_name",
          "documentTermWeight": "sum_wgt",
          "buildInfos": [
            {
              "indexProcessors": [
                {
                  "type": "hanaterm",
                  "method": "sgmt",
                  "option": "+korea +josacat +eomicat"
                }
              ],
              "sectionTermWeight": "1.0 * stw_2p(tf, 0.5, 0.25, 0., length / 128.0)",
              "sections": [
                "brand",
                "name"
              ],
              "name": "index_build"
            }
          ]
        }
      ]
    }
  },
  "autocompleteSchema": null,
  "createdDate": "2019-03-01T15:11:27.955Z",
  "updatedDate": "2019-03-01T15:11:33.000Z",
  "containers": [
    {
      "type": "indexer",
      "containerStatus": "running",
      "memoryUsageByte": 351518720
    },
    {
      "type": "searcher",
      "containerStatus": "running",
      "memoryUsageByte": 287113216
    }
  ],
  "domainUsage": {
    "nextIndexingUpdateTime": "2019-03-02 00:50:45",
    "nextCompactionTime": "2019-03-02 01:12:45",
    "waitingDocumentCount": 0,
    "validDocumentCount": 0,
    "totalDocumentCount": 0,
    "totalDocumentSize": 0
  }
}