---
title: "Schema照会"
slug: "analytics-cloudsearch-getschema"
updated: 2026-09-17T09:57:26Z
published: 2026-09-17T09:57:26Z
canonical: "api.ncloud-docs.com/analytics-cloudsearch-getschema"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Schema照会

該当Domainに設定された検索設定(Schema)を照会します。該当リクエストを実行する前に[Domain作成](/docs/ja/analytics-cloudsearch-createdomain)が必要です。

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

## リクエスト

### リクエストパラメータ

| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
| --- | --- | --- | --- | --- |
| name | Yes | string |  | 作成されているDomain名 |

## レスポンス

| フィールド名 | タイプ | 説明 | 備考 |
| --- | --- | --- | --- |
| document | [Schema](/docs/ja/common-apidatatype-csschema) | 検索設定 |  |

### レスポンスStatus

| HTTP Status | Desc |
| --- | --- |
| 200 | OK(照会完了) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |

## 例示

### リクエスト例示

```
GET https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/car_dev/schema

GET /CloudSearch/real/v1/domain/car_dev/schema HTTP/1.1
Host:cloudsearch.apigw.ntruss.com
accept:application/json

x-ncp-apigw-signature-v2: cDwtHuQeGmwWyNmwlN6XIGA66zge4iMXvfoDQNna05g=
x-ncp-apigw-timestamp: 1545817618751
x-ncp-iam-access-key: teGTwtcSEGA7fu28BGGi
```

### レスポンス例示

```
{
  "document": {
    "primarySectionName": "docid",
    "sections": [
      {
        "docProperties": [
          {
            "type": "string",
            "name": "dp_docid"
          }
        ],
        "name": "docid"
      },
      {
        "docProperties": [
          {
            "type": "string",
            "name": "dp_brand"
          }
        ],
        "name": "brand"
      },
      {
        "docProperties": [
          {
            "type": "string",
            "name": "dp_name"
          }
        ],
        "name": "name"
      },
      {
        "docProperties": [
          {
            "type": "string",
            "name": "dp_price"
          }
        ],
        "name": "price"
      },
      {
        "docProperties": [
          {
            "type": "float",
            "name": "dp_name2"
          }
        ],
        "name": "name2"
      }
    ],
    "indexes": [
      {
        "documentTermWeight": "sum_wgt",
        "buildInfos": [
          {
            "sections": [
              "brand"
            ],
            "sectionTermWeight": "1.0 * stw_2p(tf, 0.5, 0.25, 0., length / 128.0)",
            "indexProcessors": [
              {
                "type": "hanaterm",
                "method": "sgmt",
                "option": "+korea +josacat +eomicat"
              }
            ],
            "name": "index_build_0"
          },
          {
            "sections": [
              "name"
            ],
            "sectionTermWeight": "1.0 * stw_2p(tf, 0.5, 0.25, 0., length / 128.0)",
            "indexProcessors": [
              {
                "type": "hanaterm",
                "method": "sgmt",
                "option": "+korea +josacat +eomicat"
              }
            ],
            "name": "index_build_1"
          }
        ],
        "name": "brand_name"
      },
      {
        "documentTermWeight": "sum_wgt",
        "buildInfos": [
          {
            "sections": [
              "price"
            ],
            "sectionTermWeight": "1.0 * stw_2p(tf, 0.5, 0.25, 0., length / 128.0)",
            "indexProcessors": [
              {
                "type": "hanaterm",
                "method": "sgmt",
                "option": "+korea +josacat +eomicat"
              }
            ],
            "name": "index_build_0"
          }
        ],
        "name": "price"
      }
    ]
  }
}
```