Release Notes
Product Announcements
Domain name for API request: postgres.tencentcloudapi.com.
This API is used to query all parameters supported by a database version and engine.
A maximum of 1000 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDefaultParameters. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| DBMajorVersion | Yes | String | The major database version number, such as 11, 12, 13. |
| DBEngine | Yes | String | Database engine, such as postgresql, mssql_compatible. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of parameters |
| ParamInfoSet | Array of ParamInfo | Parameter information Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
None
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDefaultParameters
<Common request parameters>
{
"DBMajorVersion": "13",
"DBEngine": "postgresql"
}
{
"Response": {
"RequestId": "b6cf4dfc-09ce-4ee4-9c3e-0979e105bb4d",
"TotalCount": 4,
"ParamInfoSet": [
{
"Advanced": false,
"ClassificationCN": "Query Optimization",
"ClassificationEN": "Query Tuning",
"CurrentValue": "",
"DefaultValue": "500000",
"EnumValue": [],
"ID": 14092,
"LastModifyTime": "",
"Max": 123124123,
"Min": -1,
"Name": "jit_inline_above_cost",
"NeedReboot": false,
"ParamDescriptionCH": "This example shows you how to set the query cost threshold for JIT compilation to attempt inlining functions and operators. If the query cost exceeds this value, JIT compilation will try to inline",
"ParamDescriptionEN": "Perform JIT inlining if query is more expensive.-1 disables inlining.",
"ParamValueType": "real",
"SpecRelated": false,
"SpecRelationSet": null,
"StandbyRelated": 0,
"Unit": "",
"VersionRelationSet": null
},
{
"Advanced": false,
"ClassificationCN": "AUTOVACUUM",
"ClassificationEN": "Autovacuum",
"CurrentValue": "",
"DefaultValue": "400000000",
"EnumValue": [],
"ID": 14131,
"LastModifyTime": "",
"Max": 2000000000,
"Min": 10000,
"Name": "autovacuum_multixact_freeze_max_age",
"NeedReboot": true,
"ParamDescriptionCH": "This example shows you how to sets the maximum age in multi-transaction scenarios on a table. Reaching this threshold will trigger the Autovacuum Process to avoid wraparound.",
"ParamDescriptionEN": "Multixact age at which to autovacuum a table to prevent multixact wraparound.",
"ParamValueType": "integer",
"SpecRelated": false,
"SpecRelationSet": null,
"StandbyRelated": 0,
"Unit": "",
"VersionRelationSet": null
},
{
"Advanced": false,
"ClassificationCN": "Client connection defaults",
"ClassificationEN": "Client connection defaults",
"CurrentValue": "",
"DefaultValue": "\"$user\", public",
"EnumValue": [],
"ID": 14173,
"LastModifyTime": "",
"Max": 0,
"Min": 0,
"Name": "search_path",
"NeedReboot": false,
"ParamDescriptionCH": "The default search_path",
"ParamDescriptionEN": "Sets the schema search order for names that are not schema-qualified.",
"ParamValueType": "string",
"SpecRelated": false,
"SpecRelationSet": null,
"StandbyRelated": 0,
"Unit": "",
"VersionRelationSet": null
},
{
"Advanced": false,
"ClassificationCN": "Client connection defaults",
"ClassificationEN": "Client connection defaults",
"CurrentValue": "",
"DefaultValue": "150000000",
"EnumValue": [],
"ID": 14175,
"LastModifyTime": "",
"Max": 2000000000,
"Min": 0,
"Name": "vacuum_multixact_freeze_table_age",
"NeedReboot": false,
"ParamDescriptionCH": "When the pg_class.relfrozenxid field of a table reaches the age specified by this setting, VACUUM will perform a full table scan. An aggressive scan, unlike a regular VACUUM, accesses every page that may contain unfrozen XIDs or MXIDs, not just those that might contain dead tuples",
"ParamDescriptionEN": "Multixact age at which VACUUM should scan whole table to freeze tuples.",
"ParamValueType": "integer",
"SpecRelated": false,
"SpecRelationSet": null,
"StandbyRelated": 0,
"Unit": "",
"VersionRelationSet": null
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.DatabaseAccessError | Failed to access database management service. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| InvalidParameter.ParameterCheckError | Failed to check the parameter. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
피드백