签发单应用只读凭据
本页内容
为一个指定应用签发有时限的只读访问凭据。
适用场景
需要把有限的查询能力交给另一个服务,而不交付长期密钥时使用。
完整流程见:签发与管理临时只读凭据。
开始前
请先在开发者中心完成 API 接入配置,并为目标应用授予本次操作所需的权限。尚未完成首次调用时,请先阅读快速开始。
- 使用长期 AccessKey,为一个已获授权的应用选择只读动作。有效时长、来源 IP 和请求频率均不能放宽父凭据范围。
- 所需权限
- enterprise:CreateSessions 或 distribution:CreateSessions,账号须已开放短期凭据
- 认证方式
- 长期 AccessKey(AKP),服务端 HMAC 签名
权限、应用范围和来源 IP 均需符合接入配置。详细说明见访问权限。
调用步骤
- 选择一个已获授权的应用。
- 限定读取动作、来源 IP、请求速率和有效时长。
- 安全交付首次返回的整组凭据。
使用时同时提供 AccessKey ID、Secret 和安全令牌,失效后重新签发。
请求方式
/api/v1/apps/{app_id}/sessions- 操作标识
createSession- 请求域名
https://www.onesignios.com- 频率限制
- 账号与 API 应用的额度同时生效。达到限额时按
Retry-After等待。
请求参数
| 字段 | 必填 | 说明 |
|---|---|---|
app_id |
是 | 业务应用的完整 ID,来自列出应用或预留新应用的响应。 查看取值约束
示例: |
AccessKey 认证请求头
下表适用于 AccessKey 调用,由服务端 SDK 自动生成。使用长期或临时凭据自行实现 HTTP 调用时,请按照请求签名说明处理。
| 字段 | 必填 | 说明 |
|---|---|---|
Authorization |
是 | AccessKey 调用的认证签名,格式为 CS1-HMAC-SHA256 Credential=密钥ID,Signature=签名。使用 SDK 时自动生成。 |
Content-Type |
是 | 传 application/json,可附 charset=utf-8。 |
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。 查看取值约束
|
X-Api-Idempotency-Key |
是 | 同一次业务重试保持原值及原始请求体,更换 nonce 重新签名。有效记录保留 90 天。 查看取值约束
|
本接口仅支持长期 AccessKey,不支持临时凭据或 OAuth Bearer。查看认证方式对照。
请求体
请求体使用 application/json,最多 16 KiB。请为本次操作保存幂等键,重试时复用原值。
| 字段 | 必填 | 说明 |
|---|---|---|
name |
是 | 便于识别临时查询用途的名称。 查看取值约束
示例: |
actions |
是 | 授权动作名称。查询或修改资源时仍须满足资源范围和来源 IP 条件。 |
actions[] |
是 | 数组中每个元素的取值要求。 查看取值约束
示例: |
networks |
是 | 允许访问的来源 IP 或 CIDR 网段,最终范围受父密钥限制。 查看取值约束
|
duration_seconds |
是 | 申请临时只读访问的时长,单位为秒,不能超过父凭据和账号允许范围。 查看取值约束
示例: |
rpm |
是 | 每分钟最多允许的请求次数,同时受账号和 API 应用额度约束。 查看取值约束
示例: |
成功响应
HTTP 200 返回 JSON。请记录 request_id,排查问题时可提供此值。查看成功、失败与异步结果的区别。
如何判断结果
首次保存完整的 AccessKey ID、Secret 和安全令牌,使用时三者缺一不可。幂等重放可能返回 credentials=null,列表查询也不能找回 Secret。
临时凭据只供获准的查询,不可付款、上传、申请下载凭证或继续签发下一层凭据。
返回字段
字段按对象层级列出,[] 表示数组元素。“必返”指该对象出现时字段是否必须存在,值仍可能允许为 null;具体类型见展开说明。
| 字段 | 必返 | 说明 |
|---|---|---|
request_id |
是 | 平台生成的请求标识。排查问题时请提供此值。 查看取值约束
示例: |
data |
是 | 本次调用的业务结果,结构取决于操作。 |
data.id |
是 | 该条记录的公开标识。调用后续接口时请完整保留,包括前缀。 查看取值约束
示例: |
data.app_id |
是 | 业务应用的完整 ID,来自列出应用或预留新应用的响应。 查看取值约束
示例: |
data.name |
是 | 签发时填写的临时只读凭据名称。 查看取值约束
示例: |
data.actions |
是 | 授权动作名称。查询或修改资源时仍须满足资源范围和来源 IP 条件。 |
data.actions[] |
是 | 数组中每个元素的取值要求。 查看取值约束
示例: |
data.rpm |
是 | 每分钟最多允许的请求次数,同时受账号和 API 应用额度约束。 查看取值约束
示例: |
data.created_at |
是 | 记录创建时间,Unix 秒。 查看示例示例: |
data.expires_at |
是 | 此临时凭据的截止时间,Unix 秒。 查看示例示例: |
data.last_used_at |
是 | 最近一次使用凭据的时间,Unix 秒。0 表示尚无记录。 查看示例示例: |
data.state |
是 | 当前记录的处理状态或请求筛选的状态。 查看取值约束
示例: |
data.credentials |
是 | 首次成功签发时交付的 ID、Secret 与安全令牌。幂等重放时可能为 null。 |
data.credentials.access_key_id |
是 | 签名请求的凭据标识。 查看取值约束
示例: |
data.credentials.access_key_secret |
是 | 用于本地计算签名的 Secret,在服务端安全保存。 查看取值约束
示例: |
data.credentials.security_token |
是 | 临时会话令牌,AKT 请求须放进 X-Api-Security-Token。 查看取值约束
示例: |
调用示例
请把示例中的应用 ID、资源 ID和业务数据替换为自己账号的真实返回值,再选择一种语言运行。安装、文件放置和 CLOUDSIGN_BASE_URL 等配置见SDK 使用说明。
下载示例依赖
Python 标准库示例使用 cloudsign_request.py;使用 SDK 时仅需准备所选语言。长期 Secret 保存在服务端,浏览器和移动端使用OAuth 授权。
运行前先配置 CLOUDSIGN_IDEMPOTENCY_KEY 并持久保存,它代表这一次写入。网络重试沿用原值,开始另一项操作时生成新值。查看生成命令与运行准备 →
调用示例
POST /api/v1/apps/A11111111111111111111111111111111/sessions 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: <本次业务保存的幂等键>
{
"name": "自动化查询",
"actions": [
"enterprise:ReadApps"
],
"networks": [],
"duration_seconds": 900,
"rpm": 60
}Python 标准库调用
from cloudsign_request import request
import os
result = request(
'POST',
'/api/v1/apps/A11111111111111111111111111111111/sessions',
payload={'name': '自动化查询',
'actions': ['enterprise:ReadApps'],
'networks': [],
'duration_seconds': 900,
'rpm': 60},
idempotency_key=os.environ["CLOUDSIGN_IDEMPOTENCY_KEY"],
)
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.create_session(
name='自动化查询',
actions=['enterprise:ReadApps'],
networks=[],
duration_seconds=900,
rpm=60,
app='A11111111111111111111111111111111',
idempotency_key=os.environ["CLOUDSIGN_IDEMPOTENCY_KEY"],
)
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->createSession(
'A11111111111111111111111111111111',
'自动化查询',
['enterprise:ReadApps'],
900,
$requiredEnv('CLOUDSIGN_IDEMPOTENCY_KEY'),
[],
60
);
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.createSession(
"A11111111111111111111111111111111",
{ name: "自动化查询", actions: ["enterprise:ReadApps"], durationSeconds: 900, networks: [], rpm: 60 },
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 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.CreateSession(
ctx,
"A11111111111111111111111111111111",
cloudsign.SessionOptions{Name: "自动化查询", DurationSeconds: 900, RPM: 60, Actions: []string{"enterprise:ReadApps"}, Networks: []string{}},
os.Getenv("CLOUDSIGN_IDEMPOTENCY_KEY"),
)
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.createSession(
"A11111111111111111111111111111111",
"自动化查询",
List.of("enterprise:ReadApps"),
900,
List.of(),
60,
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 1.88+, trusted server. Save as cloudsign-sdk/rust/examples/example.rs.
use cloudsign_openapi::{Client, Credentials, CreateSession};
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: CreateSession = serde_json::from_value(json!({
"app_id": "A11111111111111111111111111111111",
"body": {"name": "自动化查询", "actions": ["enterprise:ReadApps"], "networks": [], "duration_seconds": 900i64, "rpm": 60i64},
"idempotency_key": env::var("CLOUDSIGN_IDEMPOTENCY_KEY")?
}))?;
let result = client.create_session(&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_session_input_actions_item input_value_3_items[] = {CLOUDSIGN_INPUT_SESSION_INPUT_ACTIONS_ITEM_ENTERPRISE_READAPPS};
const cloudsign_input_session_input_actions input_value_3 = {.count = 1, .items = input_value_3_items};
const cloudsign_input_session_input_networks input_value_4 = {.count = 0, .items = NULL};
const cloudsign_input_session_input input_value_2 = {.presence_name = CLOUDSIGN_FIELD_VALUE, .name = "自动化查询", .presence_actions = CLOUDSIGN_FIELD_VALUE, .actions = &input_value_3, .presence_networks = CLOUDSIGN_FIELD_VALUE, .networks = &input_value_4, .presence_duration_seconds = CLOUDSIGN_FIELD_VALUE, .duration_seconds = INT64_C(900), .presence_rpm = CLOUDSIGN_FIELD_VALUE, .rpm = INT64_C(60)};
const cloudsign_input_create_session 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_create_session(&input, &built);
if (status != CLOUDSIGN_OK) goto done;
status = cloudsign_send_built_request(client, built, &result);
if (status == CLOUDSIGN_OK) {
status = cloudsign_decode_create_session(result, &decoded);
if (status != CLOUDSIGN_OK) goto done;
const cloudsign_model_session_issued *data = cloudsign_response_create_session(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": {
"id": "AKT9999999999999999999999999999999999999999",
"app_id": "A11111111111111111111111111111111",
"name": "自动化查询",
"actions": [
"enterprise:ReadApps"
],
"rpm": 60,
"created_at": 1793920000,
"expires_at": 1793920900,
"last_used_at": 0,
"state": "active",
"credentials": {
"access_key_id": "AKT9999999999999999999999999999999999999999",
"access_key_secret": "CSK_sssssssssssssssssssssssssssssssssssssssssss",
"security_token": "CST_ttttttttttttttttttttttttttttttttttttttttttt"
}
}
}错误处理
失败或中断后
首次凭据未妥善保存时撤销该凭据,再明确创建新的一组。不要通过反复重放假定能取回 Secret;父密钥撤销后临时凭据也不能继续访问。
相关错误码
| HTTP | 错误码 | 处理方式 |
|---|---|---|
| 403 | SessionsDisabled | 账号尚未允许签发只读临时凭据。检查开发者中心的会话设置。 |
| 400 / 403 | InvalidPolicy | 核对申请的动作、应用、网络、时长和限额是否在父凭据授权范围内。 |
| 409 | ParentExpiring | 父密钥剩余有效期不足。缩短申请时长或使用有效父密钥。 |
| 429 | SessionLimit | 有效临时会话已满。撤销不用的会话或等待过期。 |
| 409 | IdempotencyConflict | 同一个幂等键用于不同请求。恢复原请求的正文与路径。独立的新业务操作使用新键。 |
| 401 | InvalidCredentials | 凭据无效、已停用,或请求签名不匹配。核对 AK、环境、正文摘要和签名头。 |
| 429 | Throttled | 请求达到限额,按 Retry-After 返回的秒数等待,再以新 nonce 发起请求。 |