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

最近更新时间:2021-09-17

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

公共请求参数

名称类型是否必须示例值描述
FormatStringjson返回值的类型,支持json。默认为json。
VersionString|2019-06-30API版本号,为日期形式:YYYY-MM-DD。
AccessKeyIdStringkey-test紫光云颁发给用户的访问服务所用的密钥ID。
SignatureStringPc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D签名结果串。
SignatureMethodstring|HMAC-SHA1签名方式,目前仅支持HMAC-SHA1。
TimestampString2019-06-30T12:00:00Z请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ
SignatureVersionString1.0签名算法版本,目前的版本是1.0。
SignatureNonceString16343456325226唯一随机数,用于防止网络重放攻击。在不同请求间要使用不同的随机数值。
请求示例



https://api.unicloud.com/transaction?Format=json
&Version=2019-06-30&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=16343456325226&SignatureVersion=1.0&AccessKeyId=key-test
&OwnerId=12345678&Timestamp=2019-06-30T12:00:00Z
&Action=OrderDetail
&OrderId=10000

公共返回参数

名称类型示例值描述
RequestIdString4C467B38-3910-447D-87BC-AC049166F216请求ID。无论成功与否,系统都会返回一个唯一识别码给用户。 此参数用于识别每一次请求。
返回示例


{    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",    "Order": {        "Id": "1144119593783001088",        "ItemCount": 1,        "UserName": "haha",        "ProductCategory": "DATA_HARD_DISK",        "ProductRegionId": "8b128f0c-e9ad-472c-9c20-451b9f310e94",        "ProductRegionName": "cloudos-tj",        "ProductDescription": "{\"conf\":{\"地域\":\"天津\",\"硬盘规格\":\"高性能HDD云硬盘 50GB\",\"计费模式\":\"按小时实时付费\"}}",        "ProductRentCount": 0,        "ProductRentUnit": "HOURS",        "Items": [
            {                "id": 1144119593787195392,                "orderId": 1144119593783001088,                "orderNo": "P21784954245923",                "productId": 7489,                "productSku": "UNIS_PC_TJ_A_DATADISK_NORMAL-50GB",                "productName": "DATA_HARD_DISK",                "productCategory": "DATA_HARD_DISK",                "productDescription": "{\"conf\":{\"地域\":\"天津\",\"硬盘规格\":\"高性能HDD云硬盘 50GB\",\"计费模式\":\"按小时实时付费\"}}",                "quantity": 1,                "totalPrice": 0,                "productStartTime": 1561614342000,                "productEndTime": 1561614342000,                "productRentUnit": "HOURS",                "productRentCount": 0,                "isParent": true,                "instanceId": "35d272a7-4c2b-4079-aa50-45e6f7fa31b6"
            }
        ],        "PayType": "CHARGING_HOURS",        "OrderStatus": "PAID",        "PayTypeName": "按小时实时付费",        "TotalPrice": 0,        "PaidAmount": 0,        "FinalPrice": 0,        "OrderCategory": "NEW",        "DueTime": 1561700743000,        "CancelType": null,        "Note": null,        "OrderNo": "P21784954245923",        "PayTime": 1561614343000,        "CreateTime": 1561614343000,        "UpdateTime": 1561614343000,        "Quantity": 1,        "ChargeType": "postpaid",        "Payments": null
    }
}