Docs

Transit Router

Call methods

Common Parameters

Common request parameters are required each time you call an API to send a request. If any of the common request parameters are not included, the request fails.

The initial letter of every common request parameter is capitalized to distinguish them from API-specific request parameters.

Action&Version

Action and Version must be included in the query string when you make an API request.

Name	Type	Required	Format	Description
Action	String	Yes	[a-zA-Z]+	Name of an API, indicating the operation to be performed.
Version	String	Yes	YYYY-MM-DD	The version number of the API. The current version is 2020-04-01.
X-Expires	Int	No	300	Validity period of the signature. Unit: seconds. If you do not enter any value, 900 is used by default.

Signature parameters

Signature parameters are required in a request, and can be included in 'Header' or 'Query'.

Name	Type	Required	Description
X-Date	String	Yes	The request timestamp, accurate to the second in UTC time. Example: 20201103T104027Z.
Authorization	String	Yes	HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}.

Parameters in Authorization:

Name	Type	Remark
AccessKey	String	AccessKey of the request.
ShortDate	String	Short date of the request, accurate to the day. UTC time, e.g., 20180201.
Region	String	The Region ID for the request, such as cn-guangzhou. For more information on Regions, refer to Region sets and Regions.
Service	String	The service to be requested. Set the value to transitrouter when you call the Transit Router (TR) API.
SignedHeaders	String	The headers that are used for the signature. Multiple parameter values are separated with semicolons ( ; ).
Signature	String	Calculated signature. For more information on the signature calculation method, refer to Signature method.

Signature parameters in Query

The X-Date parameter and the Authorization parameter can be stored in `Query`.

Name	Type	Required	Description
X-Date	String	Yes	The request timestamp, accurate to the second in UTC time. Example: 20201103T104027Z.
X-Algorithm	String	Yes	Set the value to HMAC-SHA256.
X-Credential	String	Yes	composed of {AccessKey}/{ShortDate}/{Region}/{Service}/request.
X-SignedHeaders	String	Yes	The Header involved in the signature. Separate multiple Headers with semicolons ( ; ).
X-Signature	String	Yes	Calculated signature. For more information on the signature calculation method, refer to Signature method.

Last updated: 2025.03.24 15:17:02