Fetch Configuration Template - ListUMongoDBConfigTemplate
Overview
Fetch Configuration Template
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListUMongoDBConfigTemplate . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
DataSet | array[ConfigTemplate] | Configuration Template List | Yes |
Data Model
ConfigTemplate
Field Name | Type | Description Information | Required |
---|---|---|---|
TemplateId | string | Template ID | No |
TemplateName | string | Template Name | No |
MongodbVersion | string | Mongo Version | No |
ClusterType | string | Cluster Type | No |
TemplateType | string | Template Type UsersTemplate DefaultTemplate | No |
CreateTime | int | Creation Time | No |
ModifyTime | int | Modification Time | No |
DeleteTime | int | Deletion Time | No |
Description | string | Template Description | No |
Example
Request Example
https://api.surfercloud.com/?Action=ListUMongoDBConfigTemplate
&Region=cn-zj
&ProjectId=KcWyOTpE
Response Example
{
"Action": "ListUMongoDBConfigTemplateResponse",
"DataSet": [
{
"ClusterType": "tfPvRgzA",
"CreateTime": 7,
"DeleteTime": 5,
"Description": 9,
"ModifyTime": 8,
"MongodbVersion": "SOTymeGF",
"TemplateId": "TgbWNpkG",
"TemplateName": "RFFuHJKR",
"TemplateType": "WvyshOce"
}
],
"Message": "DzwqjoYl",
"RetCode": 0
}