Skip to main content

Socket List v2

リクエスト#

GET https://api.dmdata.jp/v2/socket

Socket Start v2 で発行したWebSocketに関するリストを取得する。

クエリパラメータ#

パラメータ名必須デフォルト説明
idいいえInteger
WebSocket IDを指定、指定された場合他のクエリパラメータは無視される
statusいいえString
WebSocketの状態。デォルトではすべて表示。
接続待機・期限切れ: waiting、接続中: open、接続終了: closed
cursorTokenいいえString
次のリソースを取得する。レスポンス内のnextTokenの値を指定する
詳しくはこちら
limitいいえ20Integer
アイテムの数。最大100まで

APIに必要な権限#

  • socket.list

レスポンス#

APIは常にJSONを返答します。

status: ok#

成功時に次のような内容を返答します。

{
"responseId": "2c343ee3f1007df5",
"responseTime": "2021-04-01T00:00:00.000Z",
"status": "ok",
"items": [
{
"id": 0,
"ticket": null,
"types": [
"VPWW54",
"VXSE51",
"VXSE52",
"VXSE53"
],
"test": "no",
"classifications": [
"telegram.weather",
"telegram.earthquake"
],
"ipAddress": "192.168.0.0",
"status": "open",
"server": "websocket-03",
"start": "2021-04-01T00:00:00.000Z",
"end": null,
"ping": "2021-04-01T00:00:00.000Z",
"appName": null
}
]
}
プロパティ名出現説明
responseIdいつもString
API処理ID
responseTimeいつもISO8601Time
API処理時刻
statusいつもString
成功時は "ok"、失敗時(エラー)は "error"
itemsいつもArray<Object>
アイテムリスト
items[].idいつもInteger
WebSocket ID
items[].ticketいつもString
WebSocketに接続するためのticket
items[].classificationsいつもArray<String>
WebSocketで受け取る配信区分
items[].testいつもString
including の時のみ、XML電文のテストをWebsocketで受け取る
items[].typesいつもArray<String>|Null
WebSocketで受け取るデータ種類コードリスト。Null時は受け取る配信区分の全部を受け取る
items[].formatsいつもArray<String>
WebSocketで受け取る情報フォーマット
items[].appNameいつもString|Null
アプリ名
items[].startいつもISO8601Time
作成時間、または接続開始時間
items[].endいつもISO8601Time|Null
接続終了時間
items[].pingいつもISO8601Time|Null
Ping-Pongチェック時間
items[].ipAddressいつもString|Null
接続IPアドレス
items[].serverいつもString|Null
接続先のWebSocketサーバー名
items[].statusいつもString
接続待機・期限切れ: waiting、接続中: open、接続終了: closed。
nextToken状況String
次のリソースがある場合に出現。詳しくはこちら

status: error#

APIは各種エラーを次の通り返答します。

{
"responseId": "66d23c0cede77d82",
"responseTime": "2021-04-01T00:00:00.000Z",
"status": "error",
"error": {
"message": "...",
"code": 400
}
}
プロパティ名出現説明
errorいつもObject
エラー情報。
error.messageいつもString
エラーメッセージ、標準エラーおよび別表参照。
error.codeいつもInteger
HTTPステータスコード。

標準エラーを出力します。