This topic describes the common request parameters and common response parameters of the EventBridge API.

Common request headers

Common request parameters must be included in all API requests.

Parameter Examples Required Description
Authorization acs <yourAccessKeyId>:<yourSignature> Yes The authentication information that is used to verify the validity of the request. Specify the information in the AccessKeyId:Signature format.
Content-Length 0 Yes The length of the HTTP request body. The length is defined in RFC 2616.
Content-Type application/json Yes The type of the HTTP request body. The type is defined in RFC 2616.
Content-MD5 0e30656********0bc6f70bbdfe Yes The Base64-encoded 128-bit MD5 hash value of the HTTP request body. We recommend that you set this parameter for all requests to prevent the requests from being tampered with.
Date Wed, 16 Dec 2015 11:18:47 GMT Yes The time when the request was created. The time must be in GMT.
Host cs.aliyuncs.com Yes The endpoint of the request, for example, 1234567890123456.eventbridge.aliyuncs.com.
Accept application/json Yes The type of the response that is required by the client. Valid values: application/json and application/xml.
x-eventbridge-version 2020-04-01 Yes The version number of the API. The current version is 2020-04-01.
x-acs-region-id cn-beijing No The region ID.
x-acs-signature-nonce f63659d4-10ac-483b-99da-ea8fde61**** No A unique random number that is used to prevent network replay attacks. You must use different random numbers for different requests.
x-acs-signature-method HMAC-SHA1 Yes The signature method. Valid value: HMAC-SHA1.

Examples

POST /openapi/createEventBus HTTP/1.1
Host: 123456789098****.eventbridge.cn-hangzhou.aliyuncs.com
Accept: application/json
Date: Sat, 18 Apr 2020 05:30:41 GMT
x-eventbridge-version: 2020-04-01
Authorization: acs vZ3VL0SuJdHi****:Jo2PbTj******zYAYoYslKLvWzg=
Content-Type: application/json;charset=UTF-8
Content-Length: 26

Common response headers

Every response returns a unique request ID regardless of whether the call is successful. API responses are returned in a unified format. API responses use the HTTP response format where a 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call.

JSON format

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166****"
    /* Response data */
}