文档中心 > 公共参数
公共参数

最近更新时间:2022-01-18

公共参数分为公共请求参数和公共返回参数。

公共请求参数

名称

类型

是否必须

示例值

描述

Format

String

json

返回值的类型,支持json。默认为json。

Version

String

2020-07-30

API版本号,为日期形式:YYYY-MM-DD。

AccessKeyId

String

key-test

紫光云云颁发给用户的访问服务所用的密钥ID。

Signature

String

Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D

签名结果串。

SignatureMethod

string

HMAC-SHA1

签名方式,目前仅支持HMAC-SHA1。

Timestamp

String

2020-07-30T12:00:00Z

请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ。

SignatureVersion

String

2.0

签名算法版本,目前的版本是1.0。

SignatureNonce

String

16343456325226

唯一随机数,用于防止网络重放攻击。在不同请求间要使用不同的随机数值。

请求示例

https://api.unicloud.com/network
?Format=json
&Version=2020-07-30
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=16343456325226
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2019-06-30T12:00:00Z

公共返回参数

名称

类型

示例值

描述

RequestId

String

4C467B38-3910-447D-87BC-AC049166F216

请求ID。无论成功与否,系统都会返回一个唯一识别码给用户。此参数用于识别每一次请求。

返回示例

{
 "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
 /* 返回结果数据 */
}