All Products
Search
Document Center

Common request parameters

Last Updated: May 23, 2018

Common request parameters are the common parameters that each interface must use.

Parameter Description Required
Authorization The authentication information used to verify the validity of the request. The format is AccessKeyId:Signature. Yes
Content-Length The HTTP request content length as defined in RFC 2616. Yes
Content-Type The HTTP request content type as defined in RFC 2616. Yes
Content-MD5 The 128-bit MD5 hash value of the HTTP protocol message body is converted to Base64-encoded results. We recommend that you add this message to all requests to prevent requests from being tampered. Yes
Date The creation time of the request. Currently, only the GMT format is supported. If the difference between the creation time and the MNS server time exceeds 15 minutes, invalid request is returned. Yes
Host The host access value, for example: cr.cn-hangzhou.aliyuncs.com. Yes
Accept The type of the returned value required by the client, application/json and application/xml are supported. Yes
x-acs-version The API version, see API versions. Yes
x-acs-region-id Region indicates the physical location of Container Registry, see Region list. Yes
x-acs-signature-nonce The unique random number used to prevent network replay attacks. Different random numbers must be used for different requests. Yes
x-acs-signature-method The user signature method. Currently, only HMAC-SHA1 is supported. Yes

Example

  1. GET /namespaces HTTP/1.1
  2. Authorization: acs ACSbW2iBbyX1Pk9N:mp/6Wdr18V3qAc5gbgsqMe/iB0c
  3. Content-Length: 0
  4. Content-Type: application/json;charset=utf-8
  5. Date: Wed, 23 May 2018 12:00:01 GMT
  6. Host: cr.cn-hangzhou.aliyuncs.com
  7. Accept: application/json
  8. x-acs-version: 2016-06-07
  9. x-acs-region-id: cn-hangzhou
  10. x-acs-signature-nonce: f63659d4-10ac-483b-99da-ea8fde61eae3
  11. x-acs-signature-version: 1.0
  12. x-acs-signature-method: HMAC-SHA1
  13. User-Agent: cr-sdk-python/3.0.0 (Darwin/15.2.0/x86_64;2.7.10)

Common response parameters

System returns a unique RequestId in response to every interface call request, regardless of whether the request is successful.

XML Example:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Interface name + Response>
  3. <!--Return request tag-->
  4. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  5. <!--Returned data result-->
  6. </Interface name + Response>

JSON Example:

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
  3. /* Returned data result */
  4. }