Lista los emparejamientos de dispositivos PolarClaw.
Pruébelo ahora
Test
Autorización de RAM
Sintaxis de la solicitud
POST HTTP/1.1Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| ApplicationId |
string |
Sí |
El ID de la aplicación. |
pa-************** |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
Esquema de respuesta. |
||
| RequestId |
string |
El ID de la solicitud. |
A7E6A8FD-C50B-46B2-BA85-D8B8D3****** |
| Message |
string |
El mensaje de respuesta. |
successful |
| Code |
integer |
El código de estado de la respuesta. |
200 |
| ApplicationId |
string |
El ID de la aplicación. |
pa-************** |
| Pending |
array<object> |
Una lista de solicitudes de emparejamiento pendientes. |
|
|
object |
Detalles de una solicitud de emparejamiento pendiente. |
||
| PairRequestId |
string |
El ID de la solicitud de emparejamiento. |
test-1778647932986 |
| DeviceId |
string |
El ID único del dispositivo. |
device-784x37k0vko734fk |
| PublicKey |
string |
La clave pública Ed25519. |
test-pubkey-base64url |
| DisplayName |
string |
El nombre para mostrar del dispositivo. |
test |
| Platform |
string |
El sistema operativo. |
linux |
| DeviceFamily |
string |
La familia del dispositivo. |
server |
| ClientId |
string |
El ID del cliente. |
cli |
| ClientMode |
string |
El modo del cliente. |
cli |
| Role |
string |
El rol del dispositivo. |
operator |
| Roles |
array |
La lista de roles. |
|
|
string |
El rol del dispositivo. |
operator |
|
| Scopes |
array |
La lista de ámbitos de permisos. |
|
|
string |
Un ámbito de permisos. |
operator.read |
|
| RemoteIp |
string |
La dirección IP remota del solicitante. |
127.0.0.1 |
| Silent |
boolean |
Indica si se trata de un emparejamiento silencioso. |
false |
| IsRepair |
boolean |
Indica si la solicitud es para reparar un emparejamiento existente. |
false |
| Ts |
integer |
La marca de tiempo de la solicitud de emparejamiento, en milisegundos Unix. |
1778660347550 |
| Paired |
array<object> |
Una lista de dispositivos emparejados. |
|
|
object |
Detalles de un dispositivo emparejado. |
||
| DeviceId |
string |
El ID único del dispositivo. |
f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c |
| DisplayName |
string |
El nombre para mostrar del dispositivo. |
empty |
| Platform |
string |
El sistema operativo. |
linux |
| DeviceFamily |
string |
La familia del dispositivo. |
empty |
| ClientId |
string |
El ID del cliente. |
cli |
| ClientMode |
string |
El modo del cliente. |
cli |
| Role |
string |
El rol del dispositivo. |
operator |
| Scopes |
array |
La lista de ámbitos de permisos. |
|
|
string |
Un ámbito de permisos. |
operator.admin |
|
| CreatedAtMs |
integer |
La hora en que se creó el emparejamiento del dispositivo, en milisegundos Unix. |
1778659807727 |
| LastSeenAtMs |
integer |
La hora en que el dispositivo estuvo activo por última vez, en milisegundos Unix. |
1778659807727 |
Ejemplos
Respuesta exitosa
JSON Formato
{
"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
}
]
}Códigos de error
Consulte Códigos de error para ver la lista completa.
Notas de la versión
Consulte Notas de la versión para ver la lista completa.