Domain 조회

등록한 도메인 정보를 조회합니다.

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

요청

요청 파라미터

파라미터 명	필수 여부	타입	설명
name	Yes	string	생성되어져 있는 Domain 이름
haveContainer	Yes	boolean	컨테이너 정보 조회 여부
haveUsgae	Yes	boolean	도메인 사용량 정보 조회 여부

응답

필드명	필수 여부	타입	설명	비고
autoCompleteChangeable	Yes	string	자동 완성 색인 변경 가능 여부	ENABLE, DISABLE
autocompleteSchema	Yes	AutoCompleteSchema	자동 완성 설정
containerChangeable	Yes	string	검색용 컨테이너 변경 가능 여부	ENABLE, DISABLE
containers	Yes	List<Container>	컨테이너 정보
createdDate	Yes	string	도메인 생성 시간
description	Yes	string	도메인 설명
domainStatus	Yes	string	서비스 상태
domainUsage	Yes	DomanUsage	도메인 사용량
indexerCount	Yes	number	색인용 컨테이너 수
name	Yes	string	도메인 이름
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.gov-ntruss.com/CloudSearch/real/v1/domain/car

응답 예시

{
  "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
  }
}