PolarClaw のデバイスペアリングを一覧表示します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ApplicationId |
string |
必須 |
アプリケーション ID。 |
pa-************** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンススキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
A7E6A8FD-C50B-46B2-BA85-D8B8D3****** |
| Message |
string |
レスポンスメッセージ。 |
successful |
| Code |
integer |
レスポンスのステータスコード。 |
200 |
| ApplicationId |
string |
アプリケーション ID。 |
pa-************** |
| Pending |
array<object> |
保留中のペアリングリクエストのリスト。 |
|
|
object |
保留中のペアリングリクエストの詳細。 |
||
| PairRequestId |
string |
ペアリングリクエスト ID。 |
test-1778647932986 |
| DeviceId |
string |
一意のデバイス ID。 |
device-784x37k0vko734fk |
| PublicKey |
string |
Ed25519 公開鍵。 |
test-pubkey-base64url |
| DisplayName |
string |
デバイスの表示名。 |
test |
| Platform |
string |
オペレーティングシステム。 |
linux |
| DeviceFamily |
string |
デバイスファミリー。 |
server |
| ClientId |
string |
クライアント ID。 |
cli |
| ClientMode |
string |
クライアントモード。 |
cli |
| Role |
string |
デバイスロール。 |
operator |
| Roles |
array |
ロールのリスト。 |
|
|
string |
デバイスロール。 |
operator |
|
| Scopes |
array |
権限スコープのリスト。 |
|
|
string |
権限スコープ。 |
operator.read |
|
| RemoteIp |
string |
リクエスト元のリモート IP アドレス。 |
127.0.0.1 |
| Silent |
boolean |
サイレントペアリングであるかどうか。 |
false |
| IsRepair |
boolean |
既存のペアリングを修復するためのリクエストであるかどうか。 |
false |
| Ts |
integer |
ペアリングリクエストのタイムスタンプ (UNIX ミリ秒単位)。 |
1778660347550 |
| Paired |
array<object> |
ペアリング済みデバイスのリスト。 |
|
|
object |
ペアリング済みデバイスの詳細。 |
||
| DeviceId |
string |
一意のデバイス ID。 |
f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c |
| DisplayName |
string |
デバイスの表示名。 |
empty |
| Platform |
string |
オペレーティングシステム。 |
linux |
| DeviceFamily |
string |
デバイスファミリー。 |
empty |
| ClientId |
string |
クライアント ID。 |
cli |
| ClientMode |
string |
クライアントモード。 |
cli |
| Role |
string |
デバイスロール。 |
operator |
| Scopes |
array |
権限スコープのリスト。 |
|
|
string |
権限スコープ。 |
operator.admin |
|
| CreatedAtMs |
integer |
デバイスペアリングの作成時刻 (UNIX ミリ秒単位)。 |
1778659807727 |
| LastSeenAtMs |
integer |
デバイスの最終アクティブ時刻 (UNIX ミリ秒単位)。 |
1778659807727 |
例
成功レスポンス
JSONJSON
{
"RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Pending": [
{
"PairRequestId": "test-1778647932986",
"DeviceId": "device-784x37k0vko734fk",
"PublicKey": "test-pubkey-base64url",
"DisplayName": "test",
"Platform": "linux",
"DeviceFamily": "server",
"ClientId": "cli",
"ClientMode": "cli",
"Role": "operator",
"Roles": [
"operator"
],
"Scopes": [
"operator.read"
],
"RemoteIp": "127.0.0.1",
"Silent": false,
"IsRepair": false,
"Ts": 1778660347550
}
],
"Paired": [
{
"DeviceId": "f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c",
"DisplayName": "empty",
"Platform": "linux",
"DeviceFamily": " empty",
"ClientId": "cli",
"ClientMode": "cli",
"Role": "operator",
"Scopes": [
"operator.admin"
],
"CreatedAtMs": 1778659807727,
"LastSeenAtMs": 1778659807727
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。