列出已登记设备
本页内容
分页查询应用已记录的安装设备信息。
适用场景
确有设备管理用途并已获设备数据权限时使用。
完整流程见:查看安装统计与设备记录。
开始前
请先在开发者中心完成 API 接入配置,并为目标应用授予本次操作所需的权限。尚未完成首次调用时,请先阅读快速开始。
- 具备读取设备数据的独立权限,并限定所需应用与业务用途。网络信息还需对应权限,不能假设每条记录都有 IP。
- 所需权限
- enterprise:ReadDevices 加设备隐私准入。查看或按 IP、地区筛选另需 enterprise:ReadDeviceNetwork
- 认证方式
- 长期 AccessKey(AKP),服务端 HMAC 签名
权限、应用范围和来源 IP 均需符合接入配置。详细说明见访问权限。
调用步骤
- 选择应用和必要的查询条件。
- 按需分页读取设备信息。
- 只保存业务需要的数据,并限制访问人员。
设备记录包含敏感信息,请按自己的数据保护要求处理。
请求方式
/api/v1/apps/{app_id}/devices- 操作标识
listDevices- 请求域名
https://www.onesignios.com- 频率限制
- 账号与 API 应用的额度同时生效。达到限额时按
Retry-After等待。
请求参数
| 字段 | 必填 | 说明 |
|---|---|---|
app_id |
是 | 业务应用的完整 ID,来自列出应用或预留新应用的响应。 查看取值约束
示例: |
limit |
否 | 本次最多读取的记录数,具体范围见本行约束。 查看取值约束
示例: |
cursor |
否 | 上一页返回的游标。首次 GET 请求省略,首次设备导出在正文传空字符串。翻页时保持原筛选条件。 查看取值约束
|
state |
否 | 当前记录的处理状态或请求筛选的状态。 查看取值约束
示例: |
ip |
否 | 获准访问的设备网络 IP。用作筛选条件时需要网络字段权限。 查看取值约束
|
region |
否 | 平台记录的网络地区。用作筛选条件时需要网络字段权限。 查看取值约束
|
AccessKey 认证请求头
下表适用于 AccessKey 调用,由服务端 SDK 自动生成。使用长期或临时凭据自行实现 HTTP 调用时,请按照请求签名说明处理。
| 字段 | 必填 | 说明 |
|---|---|---|
Authorization |
是 | AccessKey 调用的认证签名,格式为 CS1-HMAC-SHA256 Credential=密钥ID,Signature=签名。使用 SDK 时自动生成。 |
X-Api-Date |
是 | UTC 时间,格式 YYYY-MM-DDTHH:mm:ssZ。与服务器的时间偏差最多 300 秒。 查看取值约束
|
X-Api-Nonce |
是 | 每次请求生成 16 个随机字节,转为 32 位小写十六进制。重试时重新生成。 查看取值约束
|
X-Api-Content-Sha256 |
是 | 实际发送的正文原始字节的 SHA-256 小写十六进制。GET 计算空字节串。 查看取值约束
|
X-Api-Environment |
是 | 生产环境传 production。 查看取值约束
|
本接口仅支持长期 AccessKey,不支持临时凭据或 OAuth Bearer。查看认证方式对照。
请求体
GET 请求不发送正文。签名中的正文摘要取零字节内容的 SHA-256。
成功响应
HTTP 200 返回 JSON。请记录 request_id,排查问题时可提供此值。查看成功、失败与异步结果的区别。
如何判断结果
按返回的设备标识和分页信息处理数据。设备标识用于此接口的定位,不把它当作原始 UDID。
返回字段
字段按对象层级列出,[] 表示数组元素。“必返”指该对象出现时字段是否必须存在,值仍可能允许为 null;具体类型见展开说明。
| 字段 | 必返 | 说明 |
|---|---|---|
request_id |
是 | 平台生成的请求标识。排查问题时请提供此值。 查看取值约束
示例: |
data |
是 | 本次调用的业务结果,结构取决于操作。 |
data.app_id |
是 | 业务应用的完整 ID,来自列出应用或预留新应用的响应。 查看取值约束
示例: |
data.generated_at |
是 | 本次结果的生成时间,Unix 秒。 查看取值约束
示例: |
data.source |
是 | 设备明细的数据来源,devices 为已登记设备,overflow 为超限记录。 查看取值约束
示例: |
data.device_identifier |
是 | 设备标识的来源和口径,为应用内统计标识。 查看取值约束
示例: |
data.network_visible |
是 | 本次授权是否允许查看 IP 和地区。 查看示例示例: |
data.consistency |
是 | 分页数据的一致性口径。实时留存记录可能在翻页期间发生变化。 查看取值约束
示例: |
data.legacy_launches_may_exclude_first_open |
是 | 历史启动次数是否可能缺少首次打开。 查看取值约束
示例: |
data.items |
是 | 与当前请求条件匹配的记录。数组元素的字段见下方各行。 查看取值约束
|
data.items[].device_id |
是 | 应用上报并由平台留存的设备标识,用于安装统计和游标查询。 查看取值约束
示例: |
data.items[].ip |
是 | 获准访问的设备网络 IP。用作筛选条件时需要网络字段权限。 查看取值约束
示例: |
data.items[].region |
是 | 平台记录的网络地区。用作筛选条件时需要网络字段权限。 查看取值约束
示例: |
data.items[].first_seen_at |
是 | 首次登记时间,Unix 秒。 查看取值约束
示例: |
data.items[].last_seen_at |
是 | 最近一次记录的打开时间,Unix 秒。 查看取值约束
示例: |
data.items[].recorded_launches |
是 | 已留存的启动次数。 查看取值约束
示例: |
data.next_cursor |
是 | 传给下一次请求的 cursor。为 null 表示已到末页。 查看取值约束
示例: |
调用示例
请把示例中的应用 ID、资源 ID和业务数据替换为自己账号的真实返回值,再选择一种语言运行。安装、文件放置和 CLOUDSIGN_BASE_URL 等配置见SDK 使用说明。
下载示例依赖
Python 标准库示例使用 cloudsign_request.py;使用 SDK 时仅需准备所选语言。长期 Secret 保存在服务端,浏览器和移动端使用OAuth 授权。
调用示例
GET /api/v1/apps/A11111111111111111111111111111111/devices?limit=50&state=all HTTP/1.1
Host: www.onesignios.com
Authorization: CS1-HMAC-SHA256 Credential=<AccessKey ID>,Signature=<签名>
X-Api-Date: <当前 UTC 时间>
X-Api-Nonce: <新生成的 32 位十六进制值>
X-Api-Content-Sha256: <正文摘要>
X-Api-Environment: productionPython 标准库调用
from cloudsign_request import request
result = request(
'GET',
'/api/v1/apps/A11111111111111111111111111111111/devices',
params={'limit': 50, 'state': 'all'},
)
print(result["request_id"])Python SDK 调用
import os
from cloudsign import Client
client = Client(
"https://www.onesignios.com",
os.environ["CLOUDSIGN_ACCESS_KEY_ID"],
os.environ["CLOUDSIGN_ACCESS_KEY_SECRET"],
os.environ.get("CLOUDSIGN_SECURITY_TOKEN", ""),
)
result = client.list_devices(
app='A11111111111111111111111111111111',
params={'limit': 50, 'state': 'all'},
)
print(result["request_id"])PHP SDK 调用
<?php
declare(strict_types=1);
// Extract the PHP SDK source ZIP beside this file. Keep credentials on your server.
require_once __DIR__ . '/cloudsign-sdk/php/Client.php';
$requiredEnv = static function (string $name): string {
$value = getenv($name);
if ($value === false || $value === '') { throw new RuntimeException('Missing environment variable'); }
return $value;
};
try {
$client = new \Cloudsign\Sdk\Client(
$requiredEnv('CLOUDSIGN_BASE_URL'),
$requiredEnv('CLOUDSIGN_ACCESS_KEY_ID'),
$requiredEnv('CLOUDSIGN_ACCESS_KEY_SECRET'),
getenv('CLOUDSIGN_SECURITY_TOKEN') ?: '',
);
$result = $client->listDevices(
'A11111111111111111111111111111111',
['limit' => 50, 'state' => 'all']
);
echo $result['request_id'], PHP_EOL;
} catch (\Cloudsign\Sdk\ApiError $error) {
fwrite(STDERR, 'HTTP ' . $error->status . ' ' . $error->apiCode . '; RequestId: ' . $error->requestId . PHP_EOL);
exit(1);
} catch (Throwable $error) {
fwrite(STDERR, "Check SDK path, runtime and environment variables.\n");
exit(1);
}
Node.js SDK 调用
// Node.js 20+ on a trusted server. Do not bundle this SDK in browsers or Vue.
import { ApiError, Client } from './cloudsign-sdk/node/client.mjs';
const requiredEnv = name => {
const value = process.env[name];
if (!value) throw new Error('Missing environment variable');
return value;
};
try {
const client = new Client(
requiredEnv('CLOUDSIGN_BASE_URL'),
requiredEnv('CLOUDSIGN_ACCESS_KEY_ID'),
requiredEnv('CLOUDSIGN_ACCESS_KEY_SECRET'),
process.env.CLOUDSIGN_SECURITY_TOKEN || '',
);
const result = await client.listDevices(
"A11111111111111111111111111111111",
{"limit": 50, "state": "all"}
);
console.log(result.request_id);
} catch (error) {
if (error instanceof ApiError) console.error(`HTTP ${error.status} ${error.code}; RequestId: ${error.requestId}`);
else console.error('Check SDK path, runtime and environment variables.');
process.exitCode = 1;
}
Go SDK 调用
// Go 1.22+, trusted server. Extract the Go SDK ZIP beside example.go.
package main
import (
"context"
"errors"
"fmt"
"os"
"time"
cloudsign "cloudsign/sdk"
)
func main() {
fail := func(err error) {
var api *cloudsign.APIError
if errors.As(err, &api) {
fmt.Fprintf(os.Stderr, "HTTP %d %s; RequestId: %s\n", api.Status, api.Code, api.RequestID)
} else {
fmt.Fprintln(os.Stderr, "Check SDK path, runtime and environment variables.")
}
os.Exit(1)
}
client, err := cloudsign.New(
os.Getenv("CLOUDSIGN_BASE_URL"),
os.Getenv("CLOUDSIGN_ACCESS_KEY_ID"),
os.Getenv("CLOUDSIGN_ACCESS_KEY_SECRET"),
os.Getenv("CLOUDSIGN_SECURITY_TOKEN"),
)
if err != nil { fail(err); return }
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
defer cancel()
result, err := client.ListDevices(
ctx,
"A11111111111111111111111111111111",
map[string]string{"limit": "50", "state": "all"},
)
if err != nil { fail(err); return }
fmt.Println(result.RequestID)
}
Java SDK 调用
// Java 17+, server-side. Extract the Java SDK ZIP beside Example.java.
import com.cloudsign.openapi.Client;
import java.util.*;
public class Example {
private static String env(String name) {
String value = System.getenv(name);
if (value == null || value.isEmpty()) throw new IllegalArgumentException("Missing environment variable");
return value;
}
private static Map<String,Object> object(Object... pairs) {
var result = new LinkedHashMap<String,Object>();
for (int i = 0; i < pairs.length; i += 2) result.put((String)pairs[i], pairs[i+1]);
return result;
}
public static void main(String[] args) {
try {
var client = new Client(
env("CLOUDSIGN_BASE_URL"),
env("CLOUDSIGN_ACCESS_KEY_ID"),
env("CLOUDSIGN_ACCESS_KEY_SECRET"),
System.getenv().getOrDefault("CLOUDSIGN_SECURITY_TOKEN", "")
);
var result = client.listDevices(
"A11111111111111111111111111111111",
Map.ofEntries(Map.entry("limit", "50"), Map.entry("state", "all"))
);
System.out.println(result.requestId());
} catch (Client.ApiException error) {
System.err.printf("HTTP %d %s; RequestId: %s%n", error.status, error.code, error.requestId);
System.exit(1);
} catch (Exception error) {
if (error instanceof InterruptedException) Thread.currentThread().interrupt();
System.err.println("Check SDK path, runtime and environment variables.");
System.exit(1);
}
}
}
Rust SDK 调用
// Rust 1.88+, trusted server. Save as cloudsign-sdk/rust/examples/example.rs.
use cloudsign_openapi::{Client, Credentials, ListDevices};
use serde_json::json;
use std::{env, error::Error};
async fn run() -> Result<(), Box<dyn Error>> {
let origin = env::var("CLOUDSIGN_BASE_URL")?;
let credentials = Credentials::new(
env::var("CLOUDSIGN_ACCESS_KEY_ID")?,
env::var("CLOUDSIGN_ACCESS_KEY_SECRET")?,
env::var("CLOUDSIGN_SECURITY_TOKEN").ok().filter(|v| !v.is_empty()),
None,
)?;
let client = Client::new(&origin, credentials)?;
let input: ListDevices = serde_json::from_value(json!({
"app_id": "A11111111111111111111111111111111",
"limit": 50i64,
"state": "all"
}))?;
let result = client.list_devices(&input).await?;
println!("{}", result.request_id);
Ok(())
}
#[tokio::main]
async fn main() {
if let Err(error) = run().await {
if let Some(api) = error.downcast_ref::<cloudsign_openapi::Error>() {
eprintln!("HTTP {} {}; RequestId: {}", api.status, api.code, api.request_id.as_deref().unwrap_or(""));
} else {
eprintln!("Check SDK path, runtime, environment variables and business input.");
}
std::process::exit(1);
}
}
C SDK 调用
请求对象和响应对象的使用方式见C SDK 请求与响应。
/* C11, trusted server. Save as example.c in the source ZIP root. */
#include <cloudsign/openapi.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
static int copy_env(char *out, size_t capacity, const char *name, int required) {
const char *value = getenv(name);
if (!value || !*value) return !required;
size_t length = strlen(value);
if (length >= capacity) return 0;
memcpy(out, value, length + 1);
return 1;
}
int main(void) {
cloudsign_credentials credentials = {0};
cloudsign_client *client = NULL;
cloudsign_result *result = NULL;
cloudsign_decoded_response *decoded = NULL;
cloudsign_built_request *built = NULL;
cloudsign_status status = CLOUDSIGN_INVALID_CONFIGURATION;
int initialized = 0, exit_code = 1;
const char *origin = getenv("CLOUDSIGN_BASE_URL");
if (!origin || !copy_env(credentials.access_key_id, sizeof(credentials.access_key_id), "CLOUDSIGN_ACCESS_KEY_ID", 1)
|| !copy_env(credentials.access_key_secret, sizeof(credentials.access_key_secret), "CLOUDSIGN_ACCESS_KEY_SECRET", 1)
|| !copy_env(credentials.security_token, sizeof(credentials.security_token), "CLOUDSIGN_SECURITY_TOKEN", 0)) goto done;
status = cloudsign_global_init();
if (status != CLOUDSIGN_OK) goto done;
initialized = 1;
cloudsign_options options = {.origin = origin, .credentials = &credentials, .timeout_ms = 15000};
status = cloudsign_client_create(&options, &client);
cloudsign_credentials_clear(&credentials);
if (status != CLOUDSIGN_OK) goto done;
const cloudsign_input_list_devices input = {.presence_app_id = CLOUDSIGN_FIELD_VALUE, .app_id = "A11111111111111111111111111111111", .presence_limit = CLOUDSIGN_FIELD_VALUE, .limit = INT64_C(50), .presence_state = CLOUDSIGN_FIELD_VALUE, .state = CLOUDSIGN_INPUT_LIST_DEVICES_STATE_ALL};
status = cloudsign_build_list_devices(&input, &built);
if (status != CLOUDSIGN_OK) goto done;
status = cloudsign_send_built_request(client, built, &result);
if (status == CLOUDSIGN_OK) {
status = cloudsign_decode_list_devices(result, &decoded);
if (status != CLOUDSIGN_OK) goto done;
const cloudsign_model_device_list *data = cloudsign_response_list_devices(decoded);
if (!data) { status = CLOUDSIGN_INVALID_RESPONSE; goto done; }
/* Read typed fields here; NULL/absent is distinct from zero/false. */
(void)data;
puts(cloudsign_decoded_request_id(decoded));
exit_code = 0;
}
done:
if (exit_code) {
if (status == CLOUDSIGN_API_ERROR) fprintf(stderr, "HTTP %ld %s; RequestId: %s\n", cloudsign_result_http_status(result), cloudsign_result_error_code(result), cloudsign_result_request_id(result));
else fputs("Check SDK path, runtime, environment variables and business input.\n", stderr);
}
cloudsign_result_free(result);
cloudsign_decoded_free(decoded);
cloudsign_built_request_free(built);
cloudsign_client_free(client);
if (initialized) cloudsign_global_cleanup();
cloudsign_credentials_clear(&credentials);
return exit_code;
}
{
"request_id": "00000000000000000000000000000000",
"data": {
"app_id": "A11111111111111111111111111111111",
"generated_at": 1794182400,
"device_identifier": "retained_installation_identifier_not_hardware_attestation",
"network_visible": false,
"consistency": "live_retained_records",
"legacy_launches_may_exclude_first_open": true,
"next_cursor": null,
"source": "devices",
"items": [
{
"device_id": "Faaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"ip": null,
"region": null,
"first_seen_at": 1794182300,
"last_seen_at": 1794182400,
"recorded_launches": 7
}
]
}
}错误处理
失败或中断后
字段被隐藏时检查授权,不通过其他接口绕过。分页保留原筛选条件,并按数据最少保留原则控制落库与日志。
相关错误码
| HTTP | 错误码 | 处理方式 |
|---|---|---|
| 403 | PrivacyDisabled | 账号尚未获得设备隐私数据准入,需单独开通。 |
| 429 | PrivacyQuotaExceeded | 账号当日设备行数额度不足。请依据 Retry-After 再查询。 |
| 400 | InvalidQuery | 检查参数名称、格式、范围和 URI 编码,删除重复参数。 |
| 401 | InvalidCredentials | 凭据无效、已停用,或请求签名不匹配。核对 AK、环境、正文摘要和签名头。 |
| 429 | Throttled | 请求达到限额,按 Retry-After 返回的秒数等待,再以新 nonce 发起请求。 |