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

列出已签发的只读凭据

本页内容

查询由当前长期 AccessKey 签发的临时只读凭据。

适用场景

需要查看有效凭据,或选择需要撤销的凭据时使用。

开始前

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

  • 使用签发这些凭据的原长期 AccessKey,并保持应用 ID 一致。
所需权限
enterprise:CreateSessions 或 distribution:CreateSessions,账号须已开放短期凭据
认证方式
长期 AccessKey(AKP),服务端 HMAC 签名

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

调用步骤

  1. 使用原长期 AccessKey。
  2. 查询该应用的临时凭据。
  3. 核对状态和截止时间。

不再需要的凭据可通过 撤销单个只读凭据 撤销。

请求方式

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

请求参数

字段必填说明
app_id 是

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

类型:string · 位置:Path

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

示例:A11111111111111111111111111111111

limit 否

本次最多读取的记录数,具体范围见本行约束。

类型:integer · 位置:Query

查看取值约束
  • 默认值 50
  • 最小值 1
  • 最大值 100

示例:2

cursor 否

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

类型:string · 位置:Query

查看取值约束
  • 格式 ^AKT[a-f0-9]{40}$
AccessKey 认证请求头

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

字段必填说明
Authorization 是

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

类型: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

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

请求体

GET 请求不发送正文。签名中的正文摘要取零字节内容的 SHA-256。

成功响应

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

如何判断结果

根据 state、截止时间和最近使用时间管理临时凭据。结果只有元数据,不包含 Secret 或安全令牌。

返回字段

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

字段必返说明
request_id 是

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

类型:string

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

示例:00000000000000000000000000000000

data 是

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

类型:object

data.items 是

与当前请求条件匹配的记录。数组元素的字段见下方各行。

类型:object[]

data.items[].id 是

该条记录的公开标识。调用后续接口时请完整保留,包括前缀。

类型:string

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

示例:AKT9999999999999999999999999999999999999999

data.items[].app_id 是

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

类型:string

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

示例:A11111111111111111111111111111111

data.items[].name 是

签发时填写的临时只读凭据名称。

类型:string

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

示例:自动化查询

data.items[].actions 是

授权动作名称。查询或修改资源时仍须满足资源范围和来源 IP 条件。

类型:string[]

data.items[].actions[] 是

数组中每个元素的取值要求。

类型:string

查看取值约束
  • 可选值 enterprise:ReadApps / enterprise:ReadVersions / enterprise:ReadJobs / distribution:ReadApps / distribution:ReadVersions / distribution:ReadSettings / enterprise:ReadStatistics / distribution:ReadStatistics / enterprise:ReadPricing / distribution:ReadPricing / enterprise:ReadVersionStatistics

示例:enterprise:ReadApps

data.items[].rpm 是

每分钟最多允许的请求次数,同时受账号和 API 应用额度约束。

类型:integer

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

示例:60

data.items[].created_at 是

记录创建时间,Unix 秒。

类型:integer

查看示例

示例:1793920000

data.items[].expires_at 是

此临时凭据的截止时间,Unix 秒;同时受原父密钥和授权是否有效限制。

类型:integer

查看示例

示例:1793920900

data.items[].last_used_at 是

最近一次使用凭据的时间,Unix 秒。0 表示尚无记录。

类型:integer

查看示例

示例:0

data.items[].state 是

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

类型:string

查看取值约束
  • 可选值 active / expired / revoked
  • active — 有效
  • expired — 已过期
  • revoked — 已撤销

示例:active

data.next_cursor 是

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

类型:string | null

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

示例:null

调用示例

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

下载示例依赖

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

调用示例
HTTP 请求
GET /api/v1/apps/A11111111111111111111111111111111/sessions?limit=2 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
Python 标准库调用
Python
from cloudsign_request import request

result = request(
    'GET',
    '/api/v1/apps/A11111111111111111111111111111111/sessions',
    params={'limit': 2},
)
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.list_sessions(
    app='A11111111111111111111111111111111',
    limit=2,
)
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->listSessions(
        'A11111111111111111111111111111111',
        2,
        null
    );
    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.listSessions(
        "A11111111111111111111111111111111",
        { limit: 2, cursor: null }
    );
    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.ListSessions(
		ctx,
		"A11111111111111111111111111111111",
		2,
		"",
	)
    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.listSessions(
                "A11111111111111111111111111111111",
                2,
                null
            );
            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, ListSessions};
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: ListSessions = serde_json::from_value(json!({
        "app_id": "A11111111111111111111111111111111",
        "limit": 2i64
    }))?;
    let result = client.list_sessions(&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_list_sessions input = {.presence_app_id = CLOUDSIGN_FIELD_VALUE, .app_id = "A11111111111111111111111111111111", .presence_limit = CLOUDSIGN_FIELD_VALUE, .limit = INT64_C(2)};
    status = cloudsign_build_list_sessions(&input, &built);
    if (status != CLOUDSIGN_OK) goto done;
    status = cloudsign_send_built_request(client, built, &result);
    if (status == CLOUDSIGN_OK) {
        status = cloudsign_decode_list_sessions(result, &decoded);
        if (status != CLOUDSIGN_OK) goto done;
        const cloudsign_model_session_list *data = cloudsign_response_list_sessions(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": {
        "items": [
            {
                "id": "AKT9999999999999999999999999999999999999999",
                "app_id": "A11111111111111111111111111111111",
                "name": "自动化查询",
                "actions": [
                    "enterprise:ReadApps"
                ],
                "rpm": 60,
                "created_at": 1793920000,
                "expires_at": 1793920900,
                "last_used_at": 0,
                "state": "active"
            }
        ],
        "next_cursor": null
    }
}

错误处理

失败或中断后

另一长期密钥查询不到原凭据时,先核对签发关系,不扩大应用授权来找回 Secret。无需继续访问的凭据及时撤销。

相关错误码

HTTP错误码处理方式
403AccessDenied检查当前身份的动作、资源范围、来源 IP 及功能准入。
400InvalidQuery检查参数名称、格式、范围和 URI 编码,删除重复参数。
404NotFound核对路径中各标识是否完整、属于同一业务应用且在当前授权范围内。
401InvalidCredentials凭据无效、已停用,或请求签名不匹配。核对 AK、环境、正文摘要和签名头。
429Throttled请求达到限额,按 Retry-After 返回的秒数等待,再以新 nonce 发起请求。
公共错误、重试与幂等说明 →