获取 OSS 令牌 - 探鸽开放平台API文档

请求参数

Path 参数

device_id

string

设备 ID

必需

示例值:

1702D8OBYWWQ

Query 参数

oss_id

string

对象存储桶 ID

必需

示例值:

0

Header 参数

X-Tg-App-Id

string

必需

开发者帐号的APPID

默认值:

Accept-Language

string

必需

请求端的本地语言（zh-cn, zh-tw, en-us, ja, ko, vi, es, pt, ru, tr, de, it, fr, pl, th, ar）

默认值:

示例值:

zh-cnzh-twen-usjakoviesptrutrdeitfrplthar

Authorization

string

必需

服务端接口（API For Server）时传入签名计算后的字符串。客户端接口（API For Client）传入用户登陆态数据access_token。两者不要混用。

默认值:

X-Tg-Signed-Headers

string

必需

参与计算签名的header字段。POST等body有值时请求传入content-length;content-type;x-tg-app-id;x-tg-date，GET等body无值时请求传入x-tg-app-id;x-tg-date

默认值:

x-tg-app-id;x-tg-date

示例值:

content-length;content-type;x-tg-app-id;x-tg-datex-tg-app-id;x-tg-date

X-Tg-Date

string

必需

当前请求的UTC+0时间（注意时区，不是本地时区）

默认值:

20060102T150405Z

X-Tg-Content-Sha256

string

必需

将BODY数据进行SHA256计算后的值

X-Tg-Algorithm

string

必需

目前服务端接口使用的签名算法的版本号和哈希算法

默认值:

TGV1-HMAC-SHA256

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/v2/cloud/server/oss-token/1702D8OBYWWQ?oss_id=0' \
--header 'X-Tg-App-Id;' \
--header 'Accept-Language;' \
--header 'Authorization;' \
--header 'X-Tg-Signed-Headers;' \
--header 'X-Tg-Date;' \
--header 'X-Tg-Content-Sha256;' \
--header 'X-Tg-Algorithm;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

data

object

必需

end_point

string

终端接入点

必需

如：oos-hazz.ctyunapi.cn

access_key_id

string

访问密钥ID

必需

sts.43a05527aa56a4997c35

access_key_secret

string

访问密钥

必需

2ecb918fc0f27c1e055a519f0be8a5e4c2dad693

security_token

string

安全令牌

必需

platform=aliyun时才用到，安全令牌的长度不固定，我们强烈建议您不要对安全令牌的最大长度做任何限制。

expiration

string

失效时间

必需

UTC时间，如：2023-03-23T06:51:34.272Z

expiration_int

integer

失效时间戳

必需

如：1679554294

root_path

string

获得授权的目录

必需

仅能访问次目录及其子目录，如：1702D8OBYWWQ

platform

string

OSS平台

必需

如：ctyun

bucket

string

OSS桶

必需

如：ctyun-private-master-account

ossid

string

OSS ID

必需

如：1

region_id

string

OSS桶所在地区

必需

如：hazz

msg

string

必需

requestid

string

必需

示例

{
    "code": 0,
    "data": {
        "end_point": "string",
        "access_key_id": "string",
        "access_key_secret": "string",
        "security_token": "string",
        "expiration": "string",
        "expiration_int": 0,
        "root_path": "string",
        "platform": "string",
        "bucket": "string",
        "ossid": "string",
        "region_id": "string"
    }
}

🟠400错误

🟠401请登录

🟠403禁止访问

🟠404资源不存在

🔴500服务器内部错误