公共请求参数说明
公共请求参数说明
公共请求参数是云控制台API接口的统一请求参数。公共请求参数主要包括请求的基础信息、请求发起时间和请求签名等。服务器通过校验公共请求参数,对访问进行统一的认证、鉴权等操作。
公共请求参数通过请求头(HTTP HEADER)的方式发送。
任何无效的公共请求参数名称和值,都可能导致请求无效、被拒绝或失败。请确保按照具体的参数说明正确传入参数名与参数值,避免访问失败。
云控制台API的公共请求参数项说明请见下表。
参数名称 | HTTP 头名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|---|
请求ID | x-ycs-requestid | String | 是 | 请求ID,需要确保每次请求不一样 |
请求发起时间 | x-ycs-timestamp | String | 是 | 请求的构造时间,使用ISO8601日期格式(yyyy-MM-dd'T'HH:mm:ss'Z'),按照当前的GMT0时区表示。例如:2018-10-19T05:23:42Z。 |
请求签名 | x-ycs-security-authorization | String | 是 | 请求签名,格式为 Authorization: YCS1-HMAC-SHA1 Credential=10736709-63ca-401f-92ea-2e532045b8f0,SignedHeaders=x-ycs-requestid;x-ycs-timestamp,Signature=YZoSWku+Uu44b5XCZevByvZjcSE=。签名算法参考签名算法说明 |
以创建云服务器为例,请求地址和公共请求参数为:
POST https://cn-east-1.api.yovole.com/v1/vm/create HTTP/1.1
x-ycs-timestamp: 2019-06-19T14:26:26Z
x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=