---
title: "コネクタの作成"
slug: "datastream-postexport"
updated: 2026-09-17T09:57:39Z
published: 2026-09-17T09:57:39Z
canonical: "api.ncloud-docs.com/datastream-postexport"
---

> ## 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.

# コネクタの作成

VPC環境で利用できます。

コネクタを作成します。

              参考

              

トピックごとにコネクタは1個だけ作成できます。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| POST | /api/v1/topics/{topicId}/connectors |

### リクエストヘッダ

Data Stream APIで共通して使用されるヘッダの詳細は、[Data Streamのリクエストヘッダ](/docs/ja/datastream-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `topicId` | String | Required | トピック ID - [トピックリストの照会](/docs/ja/datastream-gettopic)を参照 |

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `description` | String | Optional | コネクタの説明 (最大200文字) |
| `consumerSpec` | String | Required | コンシューマ仕様(コネクタ処理性能) - `SMALL` \| `MEDIUM` - `SMALL`: コンテナ1台でパーティションごとに1秒当たり最大250Kbyteをサポート - `MEDIUM`: コンテナ2台でパーティションごとに1秒当たり最大500Kbyteをサポート |
| `exportType` | String | Required | コネクタのタイプ - `OBJECT_STORAGE` (有効値) |
| `location` | String | Required | 保存場所のパス - `s3a://{bucket}/{path}`形式で入力 |
| `includeTopicInPath` | Boolean | Required | 保存パスにトピック名のディレクトリを作成するか - `true` \| `false` - `true`: 作成 - `false`: 作成しない |
| `dateFormat` | String | Required | 配下の保存バスに日付形式を使用するか - `NONE` \| `YEAR` \| `MONTH` \| `DAY` \| `HOUR` - `NONE`: 使用しない - `YEAR`: year={yyyy}/を使用 - `MONTH`: year={yyyy}/month={MM}/を使用 - `DAY`: year={yyyy}/month={MM}/day={dd}/を使用 - `HOUR`: year={yyyy}/month={MM}/day={dd}/hour={HH}/を使用 |
| `roleNrn` | String | Required | コネクタ接続時に使用される Data Streamサービスのロール(Role)に対するリソース識別値 |
| `flushInterval` | Number | Optional | ストレージにメッセージを記録する際、ファイル作成周期(分) - 1~10 (デフォルト: 10) |
| `flushCount` | Number | Optional | ストレージにメッセージを記録する際、保存メッセージ数(個) - 5,000~50,000 (デフォルト: 5,000) |
| `schemaType` | String | Optional | メッセージ Valueのシリアル化方式 - `STRING`,`JSON`,`AVRO`,`PROTOBUF` (デフォルト:`STRING`) |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request POST 'https://datastream.apigw.ntruss.com/api/v1/topics/mgNWA*****/connectors' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "description": "Connector",
  "consumerSpec": "SMALL",
  "exportType": "OBJECT_STORAGE",
  "location": "s3a://datastream***",
  "includeTopicInPath": false,
  "dateFormat": "NONE",
  "roleNrn": "nrn:PUB:IAM::****:Role/********-36d4-11f0-a3f1-246e966ebeb4",
  "flushInterval": 10,
  "flushCount": 5000,
  "schemaType": "STRING"
}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `id` | String | - | コネクタ ID |
| `topicId` | String | - | トピック ID |
| `status` | String | - | コネクタの状態 - `RUNNING` \| `FAILED` - `RUNNING`: 正常に動作(有効化) - `FAILED`: 動作エラー - コネクタ設定後にバケットを削除した場合 - コネクタ設定後、バケットにアクセス制御を設定してアクセスが不可能な場合 - コネクタ設定後、そのバケットをロックバケットに設定した場合 |
| `connectorName` | String | - | コネクタ名 |
| `description` | String | - | コネクタの説明 |
| `consumerSpec` | String | - | コンシューマ仕様(コネクタ処理性能) - `SMALL` \| `MEDIUM` - `SMALL`: コンテナ1台でパーティションごとに1秒当たり最大250Kbyteをサポート - `MEDIUM`: コンテナ2台でパーティションごとに1秒当たり最大500Kbyteをサポート |
| `exportType` | String | - | コネクタのタイプ - `OBJECT_STORAGE` (有効値) |
| `location` | String | - | 保存パス |
| `locationWithTopicName` | String | - | トピック名ディレクトリが含まれた保存パス |
| `objectStorageLocation` | String | - | Object Storageのパス |
| `includeTopicInPath` | Boolean | - | 保存パスにトピック名のディレクトリを作成するか - `true` \| `false` - `true`: 作成 - `false`: 作成しない |
| `dateFormat` | String | - | 配下の保存バスに日付形式を使用するか - `NONE` \| `YEAR` \| `MONTH` \| `DAY` \| `HOUR` - `NONE`: 使用しない - `YEAR`: year={yyyy}/を使用 - `MONTH`: year={yyyy}/month={MM}/を使用 - `DAY`: year={yyyy}/month={MM}/day={dd}/を使用 - `HOUR`: year={yyyy}/month={MM}/day={dd}/hour={HH}/を使用 |
| `roleNrn` | String | - | コネクタ接続時に使用される Data Streamサービスのロール(Role)に対するリソース識別値 |
| `groupId` | String | - | コネクタグループ ID |
| `createdDate` | String | - | コネクタ作成日時 - ISO 8601形式 - `YYYY-MM-DDThh:mm:ssZ` |
| `flushInterval` | Number | - | ストレージにメッセージを記録する際、ファイル作成周期(分) - 1~10 (デフォルト: 10) |
| `flushCount` | Number | - | ストレージにメッセージを記録する際、保存メッセージ数(個) - 5,000~50,000 (デフォルト: 5,000) |
| `schemaType` | String | - | メッセージ Valueのシリアル化方式 - `STRING`,`JSON`,`AVRO`,`PROTOBUF` (デフォルト:`STRING`) |

### レスポンスステータスコード

Data Stream APIで共通して使用されるレスポンスステータスコードの詳細は、[Data Streamのレスポンスステータスコード](/docs/ja/datastream-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
    "id": "xlThN*****",
    "topicId": "mgNWA*****",
    "status": "RUNNING",
    "connectorName": "connector-h2a***-ds***",
    "description": "Connector",
    "consumerSpec": "SMALL",
    "exportType": "OBJECT_STORAGE",
    "location": "s3a://datastream***/ds***",
    "locationWithTopicName": "s3a://datastream***/ds***",
    "objectStorageLocation": "https://console.ncloud.com/objectStorage/objectStorageList?bucketName=datastream***&folderPrefix=ds***",
    "includeTopicInPath": false,
    "dateFormat": "NONE",
    "roleNrn": "nrn:PUB:IAM::****:Role/********-36d4-11f0-a3f1-246e966ebeb4",
    "groupId": "connect-h2a***-ds***",
    "createdDate": "2025-06-05T12:56:45Z",
    "flushInterval": 10,
    "flushCount": 5000,
    "schemaType": "STRING"
}
```