You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

Copy page
Download PDF
Call methods
Common parameters
Copy page
Download PDF
Common parameters
Common request parameters are the request parameters that each interface needs to use. Each time developers use the Volcano Engine API to send a request, they need to carry these common request parameters. Otherwise, the request will fail. The first letters of common request parameters are all capitalized to distinguish them from interface request parameters.​
Action and Version​
tip​
Action and Version must be in the Query.​
​
Name​
Type​
Is it required?​
Parameter format​
Description​
Action​
String​
Yes​
[a-zA-Z]+​
The name of the interface, which is related to the specific interface, indicates the action to be executed.​
Version​
String​
Yes​
YYYY-MM-DD​
The interface version information. The current version is 2022-01-01.​
X-Expires​
Int​
No​
300​
The valid time of the signature in seconds, default is 900 seconds if not specified.​
​
Signature parameters​
Signature parameters are an essential part of the request and can be in the Header or Query.​
  • Scenarios in Header​
  • ​
    Name​
    Type​
    Is it required?​
    Description​
    X-Date​
    String​
    Yes​
    20201103T104027Z, at UTC time, accurate to the second.​
    Authorization​
    String​
    Yes​
    HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature=​
    ​
  • The following table shows the meaning of the information in Authorization.​
  • ​
    Name​
    Type​
    Remarks​
    AccessKey​
    String​
    The requested AK.​
    ShortDate​
    String​
    The short time of the request, accurate to the day. Use UTC time, for example: 20180101.​
    Region​
    String​
    The requested region, for example, China (Beijing): cn-beijing.​
    ServiceName​
    String​
    Requested service, currently rds_mysql.​
    SignedHeaders​
    String​
    Headers participating in the signature, separated by semicolons.​
    Signature​
    String​
    The calculated signature. For details about signature calculation, refer to Signature mechanism.​
    X-TT-Logid​
    String​
    The ID of the request. Keep the algorithm generation consistent.​
    ​
  • Scenarios in Query​
tip​
The information of X-Date and Authorization can directly exist in the Query.​
  • ​
    Name​
    Type​
    Is it required?​
    Description​
    X-Date​
    String​
    Yes​
    20181103T104027Z. It uses UTC time and is accurate to the second.​
    X-Algorithm​
    String​
    Yes​
    Fixed value, HMAC-SHA256; reserved for future expansion.​
    X-Credential​
    String​
    Yes​
    Consists of {AccessKey}/{ShortDate}/{Region}/{Service}/request.​
    X-SignedHeaders​
    String​
    Yes​
    Headers participating in the signature, separated by semicolons.​
    X-Signature​
    String​
    Yes​
    The calculated signature. For details about signature calculation, refer to Signature mechanism.​
    ​
For more details, refer to Common parameters.​
​
Last updated: 2025.12.23 21:46:10