docs
api
Cloud MongoDB Database(UDB NVMe)
GetUMongoDBCfgTempItem

Get configuration template content - GetUMongoDBCfgTempItem

Overview

Get configuration template content

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUMongoDBCfgTempItem.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
TemplateIdstringConfiguration Template IdYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataSetarray[ConfigTemplateItem]Configuration Template ItemYes

Data Model

ConfigTemplateItem

Field NameTypeDescription InformationRequired
ItemIdstringitemIdNo
TemplateIdstringTemplate IDNo
ConfigNamestringConfiguration NameNo
ConfigValuestringConfiguration ValueNo
CreateTimeintCreation TimeNo
ModifyTimeintModification TimeNo
ConfigOptionConfigOptionsConfiguration OptionsNo
NodeTypestringNode Type: DataNode: Data Node | ConfigSrvNode: Configuration Node | MongosNode: Routing NodeNo

ConfigOptions

Field NameTypeDescription InformationRequired
MongodbVersionstringNo
OptionNamestringNo
OptionValueTypestringNo
OptionValuesstringNo
OptionDefaultValuestringNo
IsDefaultOptionbooleanNo
EnableModifybooleanNo
EnableDisplaybooleanNo
ForceRestartbooleanNo
OptionFormatTypestringNo
AllowedApplyTypestringNo
DescriptionstringNo

Example

Request Example

https://api.surfercloud.com/?Action=GetUMongoDBCfgTempItem
&Region=cn-zj
&ProjectId=jzhnMxWp
&TemplateId=LRRJpzCz

Response Example

{
  "Action": "GetUMongoDBCfgTempItemResponse",
  "DataSet": [
    {
      "ConfigName": "WpTOsYvM",
      "ConfigOption": {},
      "ConfigValue": "BeQDjMdY",
      "CreateTime": 8,
      "ItemId": "ZltgIHYS",
      "ModifyTime": 4,
      "TemplateId": "UqQZTRIx"
    }
  ],
  "Message": "Dcxfnytk",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved