跳转到主要内容
1签 (OneSign)

导出一页设备明细

本页内容

导出指定范围内的一页设备数据。

适用场景

已取得导出权限,需要按业务范围归档设备明细时使用。

开始前

请先在开发者中心完成 API 接入配置,并为目标应用授予本次操作所需的权限。尚未完成首次调用时,请先阅读快速开始。

  • 单独取得设备导出权限,并确认导出来源、筛选范围和当日剩余额度。一次请求只导出一页。
所需权限
enterprise:ExportDevices 加所选数据源的 enterprise:ReadDevices 或 enterprise:ReadOverflowDevices,并取得设备隐私准入
认证方式
长期 AccessKey(AKP),服务端 HMAC 签名

权限、应用范围和来源 IP 均需符合接入配置。详细说明见访问权限。

调用步骤

  1. 选择必要的筛选条件和导出范围。
  2. 逐页导出并记录进度。
  3. 安全保存结果,避免输出到公开日志。

导出受权限和数量限制;继续导出时使用上次返回的分页信息。

请求方式

POST /api/v1/apps/{app_id}/devices/export
操作标识
exportDevices
请求域名
https://www.onesignios.com
频率限制
账号与 API 应用的额度同时生效。达到限额时按 Retry-After 等待。

请求参数

字段必填说明
app_id 是

业务应用的完整 ID,来自列出应用或预留新应用的响应。

类型:string · 位置:Path

查看取值约束
  • 格式 ^A[a-f0-9]{32}$

示例:A11111111111111111111111111111111

AccessKey 认证请求头

下表适用于 AccessKey 调用,由服务端 SDK 自动生成。使用长期或临时凭据自行实现 HTTP 调用时,请按照请求签名说明处理。

字段必填说明
Authorization 是

AccessKey 调用的认证签名,格式为 CS1-HMAC-SHA256 Credential=密钥ID,Signature=签名。使用 SDK 时自动生成。

类型:string · 位置:Header

Content-Type 是

传 application/json,可附 charset=utf-8。

类型:string · 位置:Header

X-Api-Date 是

UTC 时间,格式 YYYY-MM-DDTHH:mm:ssZ。与服务器的时间偏差最多 300 秒。

类型:string · 位置:Header

查看取值约束
  • 数据格式 date-time
X-Api-Nonce 是

每次请求生成 16 个随机字节,转为 32 位小写十六进制。重试时重新生成。

类型:string · 位置:Header

查看取值约束
  • 格式 ^[a-f0-9]{32}$
X-Api-Content-Sha256 是

实际发送的正文原始字节的 SHA-256 小写十六进制。GET 计算空字节串。

类型:string · 位置:Header

查看取值约束
  • 格式 ^[a-f0-9]{64}$
X-Api-Environment 是

生产环境传 production。

类型:string · 位置:Header

查看取值约束
  • 固定值 production
X-Api-Idempotency-Key 是

同一次业务重试保持原值及原始请求体,更换 nonce 重新签名。有效记录保留 90 天。

类型:string · 位置:Header

查看取值约束
  • 格式 ^[A-Za-z0-9_-]{16,64}$

本接口仅支持长期 AccessKey,不支持临时凭据或 OAuth Bearer。查看认证方式对照。

请求体

请求体使用 application/json,最多 16 KiB。请为本次操作保存幂等键,重试时复用原值。

字段必填说明
source 是

设备明细的数据来源,devices 为已登记设备,overflow 为超限记录。

类型:string

查看取值约束
  • 可选值 devices / overflow
  • devices — 已登记设备
  • overflow — 安装量超限尝试

示例:devices

state 是

当前记录的处理状态或请求筛选的状态。

类型:string

查看取值约束
  • 可选值 all / pending / recovered
  • all — 全部记录
  • pending — 尚未恢复准入
  • recovered — 已恢复准入

示例:all

limit 是

本次导出最多包含的设备行数,另受账号当日额度限制。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 500

示例:100

cursor 是

上一页返回的游标。首次 GET 请求省略,首次设备导出在正文传空字符串。翻页时保持原筛选条件。

类型:string

查看取值约束
  • 格式 ^(?:F(?:[a-f0-9]{24,64}|[a-f0-9]{8}-[a-f0-9]{16}|instance:[a-f0-9]{40}))?$

示例:""

成功响应

HTTP 200 返回 JSON。请记录 request_id,排查问题时可提供此值。查看成功、失败与异步结果的区别。

如何判断结果

首次取得 content_base64 后先解码,再计算解码内容的 SHA-256 与 sha256 比较;校验成功后才保存 JSONL 文件。

用 next_cursor 继续下一页。幂等重放可能只返回回执,内容为 null,应安全保存首次交付的文件。

返回字段

字段按对象层级列出,[] 表示数组元素。“必返”指该对象出现时字段是否必须存在,值仍可能允许为 null;具体类型见展开说明。

字段必返说明
request_id 是

平台生成的请求标识。排查问题时请提供此值。

类型:string

查看取值约束
  • 格式 ^[a-f0-9]{32}$

示例:00000000000000000000000000000000

data 是

本次调用的业务结果,结构取决于操作。

类型:object

data.id 是

本次设备导出的回执 ID。

类型:string

查看取值约束
  • 格式 ^X[a-f0-9]{32}$

示例:Xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

data.app_id 是

业务应用的完整 ID,来自列出应用或预留新应用的响应。

类型:string

查看取值约束
  • 格式 ^A[a-f0-9]{32}$

示例:A11111111111111111111111111111111

data.source 是

设备明细的数据来源,devices 为已登记设备,overflow 为超限记录。

类型:string

查看取值约束
  • 可选值 devices / overflow
  • devices — 已登记设备
  • overflow — 安装量超限尝试

示例:devices

data.file_name 是

包含扩展名的文件名称。

类型:string

查看取值约束
  • 格式 ^A[a-f0-9]{32}-(?:devices|overflow)\.jsonl$

示例:A11111111111111111111111111111111-devices.jsonl

data.format 是

接口返回的文件格式。

类型:string

查看取值约束
  • 固定值 jsonl

示例:jsonl

data.rows 是

本次导出包含的 JSONL 行数。

类型:integer

查看取值约束
  • 最小值 0
  • 最大值 500

示例:1

data.next_cursor 是

传给下一次请求的 cursor。为 null 表示已到末页。

类型:string | null

查看取值约束
  • string (格式 ^F(?:[a-f0-9]{24,64}|[a-f0-9]{8}-[a-f0-9]{16}|instance:[a-f0-9]{40})$)

示例:null

data.sha256 是

实际文件、分片或导出内容的 SHA-256,小写十六进制。

类型:string

查看取值约束
  • 格式 ^[a-f0-9]{64}$

示例:ef85e00c69648b4d59e6348701c07ad29f72b817dd8257b06f8fb6871b689c52

data.content_base64 是

首次交付的 Base64 导出内容;幂等重放可能不再返回内容。取得后先解码,再校验 sha256。

类型:string | null

查看取值约束
  • 最多字符 1500000

调用示例

请把示例中的应用 ID、资源 ID和业务数据替换为自己账号的真实返回值,再选择一种语言运行。安装、文件放置和 CLOUDSIGN_BASE_URL 等配置见SDK 使用说明。

下载示例依赖

Python 标准库示例使用 cloudsign_request.py;使用 SDK 时仅需准备所选语言。长期 Secret 保存在服务端,浏览器和移动端使用OAuth 授权。

运行前先配置 CLOUDSIGN_IDEMPOTENCY_KEY 并持久保存,它代表这一次写入。网络重试沿用原值,开始另一项操作时生成新值。查看生成命令与运行准备 →

调用示例
HTTP 请求
POST /api/v1/apps/A11111111111111111111111111111111/devices/export 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: production
Content-Type: application/json
X-Api-Idempotency-Key: <本次业务保存的幂等键>

{
    "source": "devices",
    "state": "all",
    "limit": 100,
    "cursor": ""
}
Python 标准库调用
Python
from cloudsign_request import request
import os

result = request(
    'POST',
    '/api/v1/apps/A11111111111111111111111111111111/devices/export',
    payload={'source': 'devices', 'state': 'all', 'limit': 100, 'cursor': ''},
    idempotency_key=os.environ["CLOUDSIGN_IDEMPOTENCY_KEY"],
)
print(result["request_id"])
Python SDK 调用
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.export_devices(
    app='A11111111111111111111111111111111',
    parameters={'source': 'devices', 'state': 'all', 'limit': 100, 'cursor': ''},
    idempotency_key=os.environ["CLOUDSIGN_IDEMPOTENCY_KEY"],
)
print(result["request_id"])
PHP SDK 调用
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->exportDevices(
        'A11111111111111111111111111111111',
        ['source' => 'devices', 'state' => 'all', 'limit' => 100, 'cursor' => ''],
        $requiredEnv('CLOUDSIGN_IDEMPOTENCY_KEY')
    );
    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 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.exportDevices(
        "A11111111111111111111111111111111",
        {"source": "devices", "state": "all", "limit": 100, "cursor": ""},
        requiredEnv('CLOUDSIGN_IDEMPOTENCY_KEY')
    );
    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 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.ExportDevices(
		ctx,
		"A11111111111111111111111111111111",
		map[string]any{"source": "devices", "state": "all", "limit": 100, "cursor": ""},
		os.Getenv("CLOUDSIGN_IDEMPOTENCY_KEY"),
	)
    if err != nil { fail(err); return }
    fmt.Println(result.RequestID)
}
Java SDK 调用
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.exportDevices(
                "A11111111111111111111111111111111",
                object("source", "devices", "state", "all", "limit", 100, "cursor", ""),
                env("CLOUDSIGN_IDEMPOTENCY_KEY")
            );
            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 SDK
// Rust 1.88+, trusted server. Save as cloudsign-sdk/rust/examples/example.rs.
use cloudsign_openapi::{Client, Credentials, ExportDevices};
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: ExportDevices = serde_json::from_value(json!({
        "app_id": "A11111111111111111111111111111111",
        "body": {"source": "devices", "state": "all", "limit": 100i64, "cursor": ""},
        "idempotency_key": env::var("CLOUDSIGN_IDEMPOTENCY_KEY")?
    }))?;
    let result = client.export_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 请求与响应。

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_device_export_input input_value_2 = {.presence_source = CLOUDSIGN_FIELD_VALUE, .source = CLOUDSIGN_INPUT_DEVICE_EXPORT_INPUT_SOURCE_DEVICES, .presence_state = CLOUDSIGN_FIELD_VALUE, .state = CLOUDSIGN_INPUT_DEVICE_EXPORT_INPUT_STATE_ALL, .presence_limit = CLOUDSIGN_FIELD_VALUE, .limit = INT64_C(100), .presence_cursor = CLOUDSIGN_FIELD_VALUE, .cursor = ""};
    const cloudsign_input_export_devices input = {.presence_app_id = CLOUDSIGN_FIELD_VALUE, .app_id = "A11111111111111111111111111111111", .presence_body = CLOUDSIGN_FIELD_VALUE, .body = &input_value_2, .presence_idempotency_key = CLOUDSIGN_FIELD_VALUE, .idempotency_key = getenv("CLOUDSIGN_IDEMPOTENCY_KEY")};
    status = cloudsign_build_export_devices(&input, &built);
    if (status != CLOUDSIGN_OK) goto done;
    status = cloudsign_send_built_request(client, built, &result);
    if (status == CLOUDSIGN_OK) {
        status = cloudsign_decode_export_devices(result, &decoded);
        if (status != CLOUDSIGN_OK) goto done;
        const cloudsign_model_device_export *data = cloudsign_response_export_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;
}
JSON 响应
{
    "request_id": "00000000000000000000000000000000",
    "data": {
        "id": "Xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
        "app_id": "A11111111111111111111111111111111",
        "source": "devices",
        "file_name": "A11111111111111111111111111111111-devices.jsonl",
        "format": "jsonl",
        "rows": 1,
        "next_cursor": null,
        "sha256": "ef85e00c69648b4d59e6348701c07ad29f72b817dd8257b06f8fb6871b689c52",
        "content_base64": "eyJkZXZpY2VfaWQiOiJGYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYSIsImlwIjpudWxsLCJyZWdpb24iOm51bGwsImZpcnN0X3NlZW5fYXQiOjE3OTQxODIzMDAsImxhc3Rfc2Vlbl9hdCI6MTc5NDE4MjQwMCwicmVjb3JkZWRfbGF1bmNoZXMiOjd9Cg=="
    }
}

错误处理

失败或中断后

响应丢失先用原幂等键恢复回执,不能声称一定能重新取得同一文件。需再次导出时使用新的业务请求,并注意再次占用导出额度。

相关错误码

HTTP错误码处理方式
429PrivacyQuotaExceeded账号当日设备行数额度不足。请依据 Retry-After 再查询。
403AccessDenied检查当前身份的动作、资源范围、来源 IP 及功能准入。
400InvalidInput按请求体字段表核对类型、枚举与必填项,排除未知或重复字段。
409IdempotencyConflict同一个幂等键用于不同请求。恢复原请求的正文与路径。独立的新业务操作使用新键。
401InvalidCredentials凭据无效、已停用,或请求签名不匹配。核对 AK、环境、正文摘要和签名头。
429Throttled请求达到限额,按 Retry-After 返回的秒数等待,再以新 nonce 发起请求。
公共错误、重试与幂等说明 →