Tüm Ürünler
Search
Belge Merkezi

:ALIYUN::MONGODB::ServerlessInstance

Son Güncelleme:Oct 05, 2026

ALIYUN::MONGODB::ServerlessInstance, ApsaraDB for MongoDB (Serverless) örneği oluşturmak için kullanılır.

Söz dizimi

{
  "Type": "ALIYUN::MONGODB::ServerlessInstance",
  "Properties": {
    "EngineVersion": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "AutoRenew": Boolean,
    "VSwitchId": String,
    "PeriodPriceType": String,
    "Period": Integer,
    "SecurityIPArray": String,
    "StorageEngine": String,
    "AccountPassword": String,
    "VpcId": String,
    "ChargeType": String,
    "NetworkType": String,
    "DBInstanceStorage": Integer,
    "DBInstanceDescription": String,
    "TDEStatus": Boolean
    "Tags": List
  }
}

Özellikler

ÖzellikTürGerekliDüzenlenebilirAçıklamaKısıtlama
EngineVersionStringHayırHayırÖrneğin motor sürümü. Değeri 4,2 olarak ayarlayın.
ZoneIdStringHayırHayırAlan kimliği. Yok
ResourceGroupIdStringHayırEvetKaynak grubu kimliği. Yok
AutoRenewBooleanHayırHayırÖrnek için otomatik yenilemenin etkinleştirilip etkinleştirilmeyeceğini belirtir. Varsayılan değer: false. Geçerli değerler:
  • true: Örnek için otomatik yenilemeyi etkinleştirir.
  • false: Örnek için otomatik yenilemeyi etkinleştirmez.
VSwitchIdStringHayırHayırvSwitch kimliği. Yok
PeriodPriceTypeStringHayırHayırFaturalandırma döngüsünün birimi. Geçerli değerler:
  • Day
  • Month
PeriodIntegerHayırHayırÖrneğin abonelik süresi.
  • PeriodPriceType değeri Day olarak ayarlandığında geçerli değerler: 1, 7 ve 14.
  • PeriodPriceType değeri Month olarak ayarlandığında geçerli değerler: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36 ve 60.

Birim: ay.

SecurityIPArrayStringHayırHayırÖrneğin izin listesindeki IP adresleri. Birden çok IP adresini virgülle (,) ayırın. İzin listesindeki her IP adresi benzersiz olmalıdır. İzin listesi en fazla 1.000 IP adresi içerebilir.

10.23.XX.XX gibi IP adreslerini veya 10.23.XX.XX/24 gibi CIDR bloklarını girebilirsiniz. /24 ifadesi, CIDR bloğunun ön ekinin 24 bit uzunluğunda olduğunu gösterir. 24 yerine 1 ile 32 arasında bir değer kullanabilirsiniz. Yüzde işareti (%) veya 0.0.0.0/0 da girebilirsiniz.

Not Yüzde işareti (%) veya 0.0.0.0/0 girerseniz tüm IP adresleri örneğe erişebilir. Bu durum örnek için güvenlik risklerine neden olabilir. Dikkatli ilerleyin.
StorageEngineStringHayırHayırÖrnek tarafından kullanılan depolama altyapısı. Değeri WiredTiger olarak ayarlayın.

Depolama altyapıları ve MongoDB sürümleri hakkında daha fazla bilgi için bkz. Sürümler ve depolama altyapıları.

AccountPasswordStringHayırEvetVeritabanına bağlanmak için kullanılan parola. Parola 8 ila 32 karakter uzunluğunda olmalıdır.

Parola aşağıdaki karakter türlerinden en az üçünü içermelidir: büyük harfler, küçük harfler, rakamlar ve özel karakterler. Özel karakterler şunları içerir: ! # $ % ^ \ & * ( ) _ + - =.

Not ApsaraDB for MongoDB (Serverless) örnekleri varsayılan bir veritabanı oturum açma hesabı sağlar. Hesabı değiştiremezsiniz ancak hesap parolasını değiştirebilirsiniz.
VpcIdStringHayırHayırSanal özel cloud (VPC) kimliği. Yok
ChargeTypeStringHayırHayırÖrneğin faturalandırma yöntemi. Değeri PrePaid olarak ayarlayın.
NetworkTypeStringHayırHayırÖrneğin ağ türü. Bir ApsaraDB for MongoDB (Serverless) örneğinin ağ türü VPC olmalıdır. Değeri VPC olarak ayarlayın.
DBInstanceStorageIntegerEvetHayırÖrneğin depolama kapasitesi. Geçerli değerler: 1 ila 10.

Birim: GB.

DBInstanceDescriptionStringHayırHayırÖrneğin açıklaması. Açıklama 2 ila 256 karakter uzunluğunda olmalı ve harf, rakam, alt çizgi (_) ve tire (-) içerebilir.

Açıklama bir harfle başlamalıdır.

TDEStatusBooleanHayırEvetŞeffaf Veri Şifrelemenin (TDE) etkinleştirilip etkinleştirilmeyeceğini belirtir. Varsayılan değer: false. Geçerli değerler:
  • true: TDE'yi etkinleştirir.
    Not TDE'yi etkinleştirdikten sonra devre dışı bırakamazsınız.
  • false: TDE'yi etkinleştirmez.
TagsListHayırEvetÖrneğin etiketleri. En fazla 20 etiket ekleyebilirsiniz.

Daha fazla bilgi için bkz. Etiket özellikleri.

Etiket söz dizimi

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]  

Etiket özellikleri

Özellik Tür Gerekli Düzenlenebilir Açıklama Kısıtlama
Key String Evet Hayır Etiket anahtarı. Etiket anahtarı 1 ila 128 karakter uzunluğunda olmalı ve http:// veya https:// içermemelidir. Etiket anahtarı acs: veya aliyun ile başlayamaz.
Value String Hayır Hayır Etiket değeri. Etiket değeri 0 ila 128 karakter uzunluğunda olmalı ve http:// veya https:// içermemelidir. Etiket değeri acs: veya aliyun ile başlayamaz.

Dönüş değerleri

Fn::GetAtt

  • DBInstanceStatus: Örneğin durumu.

  • DBInstanceId: Örneğin kimliği.

  • ConnectionURI: Örneğin bağlantı dizesi.

  • OrderId: Siparişin kimliği.

Örnekler

JSON biçimi

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TDEStatus": {
      "Type": "Boolean",
      "Description": "Specifies whether to enable Transparent Data Encryption (TDE). Valid values:\ntrue: enable TDE\nfalse: disable TDE (default)\nNote: You cannot disable TDE after it is enabled. ",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "Database instance version.Support 4.2",
      "Default": "4.2"
    },
    "ZoneId": {
      "Type": "String",
      "Description": "On which zone to create the instance. If VpcId and VSwitchId is specified, ZoneId is required and VSwitch should be in same zone."
    },
    "ResourceGroupId": {
      "Type": "String",
      "Description": "The ID of the resource group."
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "The vSwitch Id to create mongodb instance."
    },
    "AutoRenew": {
      "Type": "Boolean",
      "Description": "Indicates whether automatic renewal is enabled for the instance. Valid values:true: Automatic renewal is enabled.false: Automatic renewal is not enabled. You must renew the instance manually.Default value: false.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Period": {
      "Type": "Number",
      "Description": "The subscription period of the instance.Default Unit: Month.Valid values: [1~9], 12, 24, 36. Default to 1.",
      "AllowedValues": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        12,
        24,
        36
      ],
      "Default": 1
    },
    "SecurityIPArray": {
      "Type": "String",
      "Description": "Security ips to add or remove."
    },
    "StorageEngine": {
      "Type": "String",
      "Description": "Database storage engine.Support WiredTiger",
      "AllowedValues": [
        "WiredTiger"
      ],
      "Default": "WiredTiger"
    },
    "AccountPassword": {
      "Type": "String",
      "Description": "Root account password, can contain the letters, numbers or underscores the composition, length of 6~32 bit."
    },
    "VpcId": {
      "Type": "String",
      "Description": "The VPC id to create mongodb instance."
    },
    "ChargeType": {
      "Type": "String",
      "Description": "The billing method of the instance.values:PostPaid: Pay-As-You-Go.PrePaid: Subscription.Default value: PostPaid",
      "AllowedValues": [
        "Subscription",
        "PrePaid",
        "PrePay",
        "Prepaid",
        "PayAsYouGo",
        "PostPaid",
        "PayOnDemand",
        "Postpaid"
      ],
      "Default": "PostPaid"
    },
    "NetworkType": {
      "Type": "String",
      "Description": "The instance network type. Support 'CLASSIC' and 'VPC' only, default is 'CLASSIC'.",
      "AllowedValues": [
        "CLASSIC",
        "VPC"
      ]
    },
    "DBInstanceStorage": {
      "Type": "Number",
      "Description": "Database instance storage size. MongoDB is [1.10], increased every 1 GB, Unit in GB"
    },
    "PeriodPriceType": {
      "Type": "String",
      "Description": "Charge period for created instance.",
      "AllowedValues": [
        "Day",
        "Month"
      ]
    },
    "DBInstanceDescription": {
      "Type": "String",
      "Description": "Description of created database instance."
    },
    "Tags": {
      "Type": "Json",
      "Description": "Tags to attach to instance. Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.",
      "MaxLength": 20
    }
  },
  "Resources": {
    "MongoDbServerlessInstance": {
      "Type": "ALIYUN::MONGODB::ServerlessInstance",
      "Properties": {
        "TDEStatus": {
          "Ref": "TDEStatus"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "AutoRenew": {
          "Ref": "AutoRenew"
        },
        "Period": {
          "Ref": "Period"
        },
        "SecurityIPArray": {
          "Ref": "SecurityIPArray"
        },
        "StorageEngine": {
          "Ref": "StorageEngine"
        },
        "AccountPassword": {
          "Ref": "AccountPassword"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "ChargeType": {
          "Ref": "ChargeType"
        },
        "NetworkType": {
          "Ref": "NetworkType"
        },
        "DBInstanceStorage": {
          "Ref": "DBInstanceStorage"
        },
        "PeriodPriceType": {
          "Ref": "PeriodPriceType"
        },
        "DBInstanceDescription": {
          "Ref": "DBInstanceDescription"
        },
        "Tags": {
          "Ref": "Tags"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceStatus": {
      "Description": "Status of mongodb instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbServerlessInstance",
          "DBInstanceStatus"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "The instance id of created mongodb instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbServerlessInstance",
          "DBInstanceId"
        ]
      }
    },
    "ConnectionURI": {
      "Description": "Connection uri.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbServerlessInstance",
          "ConnectionURI"
        ]
      }
    },
    "OrderId": {
      "Description": "Order Id of created instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbServerlessInstance",
          "OrderId"
        ]
      }
    }
  }
}

YAML biçimi

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AccountPassword:
    Description: Root account password, can contain the letters, numbers or underscores
      the composition, length of 6~32 bit.
    Type: String
  AutoRenew:
    AllowedValues:
    - 'True'
    - 'true'
    - 'False'
    - 'false'
    Description: 'Indicates whether automatic renewal is enabled for the instance.
      Valid values:true: Automatic renewal is enabled.false: Automatic renewal is
      not enabled. You must renew the instance manually.Default value: false.'
    Type: Boolean
  ChargeType:
    AllowedValues:
    - Subscription
    - PrePaid
    - PrePay
    - Prepaid
    - PayAsYouGo
    - PostPaid
    - PayOnDemand
    - Postpaid
    Default: PostPaid
    Description: 'The billing method of the instance.values:PostPaid: Pay-As-You-Go.PrePaid:
      Subscription.Default value: PostPaid'
    Type: String
  DBInstanceDescription:
    Description: Description of created database instance.
    Type: String
  DBInstanceStorage:
    Description: Database instance storage size. MongoDB is [1,10], increased every
      1 GB, Unit in GB
    Type: Number
  EngineVersion:
    Default: '4.2'
    Description: Database instance version.Support 4.2
    Type: String
  NetworkType:
    AllowedValues:
    - CLASSIC
    - VPC
    Description: The instance network type. Support 'CLASSIC' and 'VPC' only, default
      is 'CLASSIC'.
    Type: String
  Period:
    AllowedValues:
    - 1
    - 2
    - 3
    - 4
    - 5
    - 6
    - 7
    - 8
    - 9
    - 12
    - 24
    - 36
    Default: 1
    Description: 'The subscription period of the instance.Default Unit: Month.Valid
      values: [1~9], 12, 24, 36. Default to 1.'
    Type: Number
  PeriodPriceType:
    AllowedValues:
    - Day
    - Month
    Description: Charge period for created instance.
    Type: String
  ResourceGroupId:
    Description: The ID of the resource group.
    Type: String
  SecurityIPArray:
    Description: Security ips to add or remove.
    Type: String
  StorageEngine:
    AllowedValues:
    - WiredTiger
    Default: WiredTiger
    Description: Database storage engine.Support WiredTiger
    Type: String
  TDEStatus:
    AllowedValues:
    - 'True'
    - 'true'
    - 'False'
    - 'false'
    Description: 'Specifies whether to enable Transparent Data Encryption (TDE). Valid
      values:

      true: enable TDE

      false: disable TDE (default)

      Note: You cannot disable TDE after it is enabled. '
    Type: Boolean
  Tags:
    Description: Tags to attach to instance. Max support 20 tags to add during create
      instance. Each tag with two properties Key and Value, and Key is required.
    MaxLength: 20
    Type: Json
  VSwitchId:
    Description: The vSwitch Id to create mongodb instance.
    Type: String
  VpcId:
    Description: The VPC id to create mongodb instance.
    Type: String
  ZoneId:
    Description: On which zone to create the instance. If VpcId and VSwitchId is specified,
      ZoneId is required and VSwitch should be in same zone.
    Type: String
Resources:
  MongoDbServerlessInstance:
    Properties:
      AccountPassword:
        Ref: AccountPassword
      AutoRenew:
        Ref: AutoRenew
      ChargeType:
        Ref: ChargeType
      DBInstanceDescription:
        Ref: DBInstanceDescription
      DBInstanceStorage:
        Ref: DBInstanceStorage
      EngineVersion:
        Ref: EngineVersion
      NetworkType:
        Ref: NetworkType
      Period:
        Ref: Period
      PeriodPriceType:
        Ref: PeriodPriceType
      ResourceGroupId:
        Ref: ResourceGroupId
      SecurityIPArray:
        Ref: SecurityIPArray
      StorageEngine:
        Ref: StorageEngine
      TDEStatus:
        Ref: TDEStatus
      Tags:
        Ref: Tags
      VSwitchId:
        Ref: VSwitchId
      VpcId:
        Ref: VpcId
      ZoneId:
        Ref: ZoneId
    Type: ALIYUN::MONGODB::ServerlessInstance
Outputs:
  ConnectionURI:
    Description: Connection uri.
    Value:
      Fn::GetAtt:
      - MongoDbServerlessInstance
      - ConnectionURI
  DBInstanceId:
    Description: The instance id of created mongodb instance.
    Value:
      Fn::GetAtt:
      - MongoDbServerlessInstance
      - DBInstanceId
  DBInstanceStatus:
    Description: Status of mongodb instance.
    Value:
      Fn::GetAtt:
      - MongoDbServerlessInstance
      - DBInstanceStatus
  OrderId:
    Description: Order Id of created instance.
    Value:
      Fn::GetAtt:
      - MongoDbServerlessInstance
      - OrderId
            

Daha fazla örnek görüntülemek için ServerlessInstance.json ve ServerlessInstance.yml sayfalarına bakın.