コネクタの照会

VPC環境で利用できます。

コネクタ情報を照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/topics/{topicId}/connectors

リクエストヘッダ

Data Stream APIで共通して使用されるヘッダの詳細は、Data Streamのリクエストヘッダをご参照ください。

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

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

フィールド	タイプ	必須の有無	説明
`topicId`	String	Required	トピック ID トピックリストの照会を参照

リクエスト例

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

curl --location --request GET '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}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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をサポート
`location`	String	-	保存パス
`locationWithTopicName`	String	-	トピック名ディレクトリが含まれた保存パス
`objectStorageLocation`	String	-	Object Storageのパス
`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}/を使用
`exportType`	String	-	コネクタのタイプ `OBJECT_STORAGE` (有効値)
`includeTopicInPath`	Boolean	-	保存パスにトピック名のディレクトリを作成するか `true` \| `false` `true`: 作成 `false`: 作成しない
`createdDate`	String	-	コネクタ作成日時 ISO 8601形式 `YYYY-MM-DDThh:mm:ssZ`
`roleNrn`	String	-	コネクタ接続時に使用される Data Streamサービスのロール(Role)に対するリソース識別値
`flushInterval`	Number	-	ストレージにメッセージを記録する際、ファイル作成周期(分) 1~10 (デフォルト: 10)
`flushCount`	Number	-	ストレージにメッセージを記録する際、保存メッセージ数(個) 20~100 (デフォルト: 100)
`groupId`	String	-	コネクタグループ ID
`failedMessage`	String	-	コネクタの状態が失敗`FAILED`の場合、失敗の原因
`failedDate`	String	-	コネクタの状態が失敗`FAILED`の場合、失敗状態に変更された日時

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

Data Stream APIで共通して使用されるレスポンスステータスコードの詳細は、Data Streamのレスポンスステータスコードをご参照ください。

レスポンス例

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

コネクタの状態: 正常

[
    {
        "id": "xlThN*****",
        "topicId": "mgNWA*****",
        "status": "RUNNING",
        "connectorName": "connector-h4j6l-ds001",
        "description": "",
        "consumerSpec": "SMALL",
        "location": "s3a://datastream001",
        "locationWithTopicName": "s3a://datastream001",
        "objectStorageLocation": "https://console.ncloud.com/objectStorage/objectStorageList?bucketName=datastream001&folderPrefix=",
        "dateFormat": "NONE",
        "exportType": "OBJECT_STORAGE",
        "includeTopicInPath": false,
        "createdDate": "2025-05-22T16:39:21Z",
        "roleNrn": "nrn:PUB:IAM::****:Role/********-36**-11**-a**-24****b4",
        "flushInterval": 10,
        "flushCount": 100,
        "groupId": "connect-h**-ds0**"
    }
]

コネクタの状態: 失敗

[
  {
    "id": "1c*****",
    "topicId": "15*****",
    "status": "FAILED",
    "connectorName": "connector-n***-c***",
    "description": "",
    "consumerSpec": "SMALL",
    "location": "s3a://stream-***",
    "locationWithTopicName": "s3a://stream-***/n***-c***",
    "objectStorageLocation": "https://beta-console.ncloud.com/objectStorage/objectStorageList?bucketName=stream-***&folderPrefix=n***-c***",
    "dateFormat": "HOUR",
    "exportType": "OBJECT_STORAGE",
    "includeTopicInPath": true,
    "createdDate": "2025-07-23T14:29:57Z",
    "roleNrn": "nrn:PUB:IAM::***:Role/8733****-10**-1**-a1**-246*****c4",
    "flushInterval": 10,
    "flushCount": 100,
    "groupId": "connect-n***-c***",
    "failedMessage": "Failed to access ObjectStorage: an error occurred during the connection or request.",
    "failedDate": "2025-07-23T14:40:26"
  }
]