Domain name for API request: postgres.tencentcloudapi.com.
This API is used to query the list of parameter templates.
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: DescribeParameterTemplates. |
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. |
Filters.N | No | Array of Filter | Filter conditions. Valid values: TemplateName , TemplateId , DBMajorVersion , DBEngine . |
Limit | No | Integer | The maximum number of results returned per page. Value range: 0-100. Default: 20 . |
Offset | No | Integer | Data offset |
OrderBy | No | String | Sorting metric. Valid values: CreateTime , TemplateName , DBMajorVersion . |
OrderByType | No | String | Sorting order. Valid values: asc (ascending order),desc (descending order). |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The total number of eligible parameter templates |
ParameterTemplateSet | Array of ParameterTemplate | Parameter template list |
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: DescribeParameterTemplates
<Common request parameters>
{
"Filters": [
{
"Name": "TemplateName",
"Values": [
"test"
]
}
],
"Limit": 0,
"Offset": 10,
"OrderBy": "CreateTime",
"OrderByType": "desc"
}
{
"Response": {
"ParameterTemplateSet": [
{
"DBEngine": "postgresql",
"DBMajorVersion": "13",
"TemplateDescription": "test1",
"TemplateId": "674538e8-4a03-5103-896c-9785c960bf02",
"TemplateName": "test1"
},
{
"DBEngine": "postgresql",
"DBMajorVersion": "13",
"TemplateDescription": "test2",
"TemplateId": "423984bb-97fe-5693-a74f-63cc8dfb6c5d",
"TemplateName": "test2"
}
],
"RequestId": "6224e7ed-d7d8-494c-835f-e1612345383f",
"TotalCount": 2
}
}
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.FailedOperationError | Operation failed. Please try again later. |
InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
OperationDenied.CamDeniedError | This operation cannot be performed. |
Was this page helpful?