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	いいえ	20	Integer アイテムの数。最大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ステータスコード。

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