Instructions for Parameter Management Interfaces
Last Updated：2021-10-29
Get a parameter list
Return the database parameter list under this instance
Request structure
GET /v{version}/instance/{instanceId}/parameter HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization authorization stringRequest header field
There are no other special header fields except the common header field.
Request parameters
| Parameter Name | Type | Required | Parameter Position | Description |
|---|---|---|---|---|
| version | string | Yes | URL parameters | API Version Number |
| instanceId | string | Yes | URL parameters | Instance ID |
Return header field
| Parameter Name | Type | Description |
|---|---|---|
| ETag | string | When modifying the current version number, the current Etag is returned by the header mode |
Return parameter
| Parameter Name | Type | Description |
|---|---|---|
| parameters | List parameter | The array composed of Parameter |
Request example
GET /v{version}/instance/{instanceId}/parameter HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization bce-auth-v1/rdsak/2016-07-03T06:13:13Z/1800/x-bce-date/{signature}Return example
HTTP/1.1 200 OK
x-bce-request-id 7869616F-7A68-6977-656E-406261696475
ETag:xxx-xxx-xxx
Content-Type: application/json
Content-Length: 567
{
"parameters": [
{
"name" : "wait_timeout",
"defaultValue" : "28800",
"value" : "1",
"pendingValue" : "",
"type" : "integer",
"dynamic" : true,
"modifiable" : true,
"allowedValues" : "60-86400",
"desc" : “Timeout for the server to wait for non-interactive connections."
},
{
"name" : "lower_case_table_names",
"defaultValue" : "1",
"value" : "1",
"pendingValue" : "2",
"type" : "string",
"dynamic" : false,
"modifiable" : true,
"allowedValues" : "0,1,2",
"desc" : "The table name needs to distinguish the text-transform mode."
},
{
"name" : "sql_mode",
"defaultValue" : "",
"value": ""
"pendingValue" : "",
"type" : "set<string>",
"dynamic" : true,
"modifiable" : true,
"allowedValues" : "ALLOW_INVALID_DATES, ANSI_QUOTES, ERROR_FOR_DIVISION_BY_ZERO, HIGH_NOT_PRECEDENCE, IGNORE_SPACE, NO_AUTO_CREATE_USER, NO_AUTO_VALUE_ON_ZERO, NO_BACKSLASH_ESCAPES, NO_DIR_IN_CREATE, NO_ENGINE_SUBSTITUTION, NO_FIELD_OPTIONS, NO_KEY_OPTIONS, NO_TABLE_OPTIONS, NO_UNSIGNED_SUBTRACTION, NO_ZERO_DATE, NO_ZERO_IN_DATE, ONLY_FULL_GROUP_BY, PAD_CHAR_TO_FULL_LENGTH, PIPES_AS_CONCAT, REAL_AS_FLOAT, STRICT_ALL_TABLES, STRICT_TRANS_TABLES",
"desc" : "SQL syntax and validation mode.”
}
]
}Modify a configuration parameter
Note
Modify cloud database RDS for MySQL’s parameter configuration.
Request structure
PUT /v{version}/instance/{instanceId}/parameter HTTP/1.1
HOST: rds.bj.baidubce.com
x-bce-if-match: {ETag}
Authorization authorization string
{
"parameters" : parameters
}Request header field
| Parameter Name | Type | Description |
|---|---|---|
| x-bce-if-match | string | ETag value got via query interface |
Request Parameters
| Parameter Name | Type | Required? | Parameter Position | Description |
|---|---|---|---|---|
| version | string | Yes | URL Parameters | API Version Number |
| instanceId | string | Yes | URL Parameters | Instance ID |
| parameters | List parameter | Yes | RequestBody Parameters | List of parameters to be modified |
Parameter structure
| Parameter Name | Type | Description |
|---|---|---|
| name | string | Parameter Name |
| value | string | Parameter Values |
Return header field
No other special header fields are available, except for common header fields.
Return parameter
No specific parameters are returned.
Request example
GET /v{version}/instance/{instanceId}/parameter HTTP/1.1
HOST: rds.bj.baidubce.com
x-bce-if-match: V11
Authorization bce-auth-v1/rdsak/2016-07-03T06:13:13Z/1800/x-bce-date/{signature}
{
"parameters" : [
{
"name" : "lower_case_table_names",
"value": "2"
},
{
"name" : "wait_timeout",
"value": "86400"
},
{
"name" : "sql_mode",
"value": "ALLOW_INVALID_DATES,ANSI_QUOTES,REAL_AS_FLOAT"
}
]
}Return example
HTTP/1.1 200 OK
x-bce-request-id 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
Content-Length: 0