Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to query parameter template details of a cloud database instance for MongoDB.
Description: The DescribeDBInstanceParamTplDetail API is in public beta. During this period, this interface is only applicable to beta test participants.
A maximum of 20 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: DescribeDBInstanceParamTplDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-25. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| TplId | Yes | String | Parameter template ID. Use the DescribeDBInstanceParamTpl interface to obtain template ID. |
| ParamName | No | String | Parameter name. Pass in this value to retrieve parameter details of this field. Leave it empty to return all parameters. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceEnumParams | Array of InstanceEnumParam | Enumeration class parameter details list. |
| InstanceIntegerParams | Array of InstanceIntegerParam | Integer parameter detail list. |
| InstanceTextParams | Array of InstanceTextParam | Text parameter details list. |
| InstanceMultiParams | Array of InstanceMultiParam | Multi-value parameter details list. |
| TotalCount | Integer | Total number of parameters. |
| MongoVersion | String | Instance version supported by the template. - MONGO_36_WT: Version of the MongoDB 3.6 WiredTiger storage engine. - MONGO_40_WT: Version of the MongoDB 4.0 WiredTiger storage engine. - MONGO_42_WT: Version of the MongoDB 4.2 WiredTiger storage engine. - MONGO_44_WT: Version of the MongoDB 4.4 WiredTiger storage engine. - MONGO_50_WT: Version of the MongoDB 5.0 WiredTiger storage engine. - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. - MONGO_80_WT: version of the MongoDB 8.0 WiredTiger storage engine. |
| ClusterType | String | Template adapts to cluster type. - REPLSET: replica set instance. - SHARD: shard instance. -STANDALONE: Single-node instance. |
| TplName | String | Parameter template name. |
| 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. |
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceParamTplDetail
<Common request parameters>
{
"TplId": "tpl-2284g3nmw"
}
{
"Response": {
"ClusterType": "REPLSET",
"InstanceEnumParams": [
{
"CurrentValue": "off",
"DefaultValue": "off",
"EnumValue": [
"off",
"slowOp",
"all"
],
"NeedRestart": "0",
"ParamName": "operationProfiling.mode",
"Status": 1,
"Tips": [
"",
"specifies which operations should be profiled."
],
"ValueType": "enum"
},
{
"CurrentValue": "snappy",
"DefaultValue": "snappy",
"EnumValue": [
"snappy",
"zlib",
"zstd",
"none"
],
"NeedRestart": "1",
"ParamName": "storage.wiredTiger.collectionConfig.blockCompressor",
"Status": 1,
"Tips": [
"",
"you can uses zstd for journal compression and data compression."
],
"ValueType": "enum"
}
],
"InstanceIntegerParams": [
{
"CurrentValue": "100",
"DefaultValue": "100",
"Max": "65536",
"Min": "0",
"NeedRestart": "0",
"ParamName": "operation.profiling.slowOpThresholdMs",
"Status": 1,
"Tips": [
"",
"the slow operation time threshold, in milliseconds."
],
"Unit": "",
"ValueType": "integer"
},
{
"CurrentValue": "600000",
"DefaultValue": "600000",
"Max": "2147483647",
"Min": "1",
"NeedRestart": "0",
"ParamName": "setParameter.cursorTimeoutMillis",
"Status": 1,
"Tips": [
"",
"sets the expiration threshold in milliseconds for idle cursors before MongoDB removes them."
],
"Unit": "",
"ValueType": "integer"
},
{
"CurrentValue": "33554432",
"DefaultValue": "33554432",
"Max": "268435456",
"Min": "33554432",
"NeedRestart": "0",
"ParamName": "setParameter.internalQueryMaxBlockingSortMemoryUsageBytes",
"Status": 1,
"Tips": [
"",
"internal query exec max blocking sort bytes."
],
"Unit": "",
"ValueType": "integer"
},
{
"CurrentValue": "5",
"DefaultValue": "5",
"Max": "60",
"Min": "0",
"NeedRestart": "0",
"ParamName": "setParameter.maxTransactionLockRequestTimeoutMillis",
"Status": 1,
"Tips": [
"",
"the maximum amount of time in milliseconds that multi-document transactions should wait to acquire locks required by the operations in the transaction."
],
"Unit": "",
"ValueType": "integer"
},
{
"CurrentValue": "60",
"DefaultValue": "60",
"Max": "300",
"Min": "5",
"NeedRestart": "0",
"ParamName": "setParameter.transactionLifetimeLimitSeconds",
"Status": 1,
"Tips": [
"",
"specifies the lifetime of multi-document transactions."
],
"Unit": "",
"ValueType": "integer"
}
],
"InstanceMultiParams": [],
"InstanceTextParams": [],
"MongoVersion": "MONGO_50_WT",
"RequestId": "5dedc31c-ee80-4a12-9ed3-6003504b5a57",
"TotalCount": 7,
"TplName": "demo"
}
}
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 |
|---|---|
| InvalidParameter | Parameter error |
| InvalidParameter.PermissionDenied | The current sub-account has no permission to perform this operation. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários