Use ALIYUN::MONGODB::ShardingInstance to create or clone an ApsaraDB for MongoDB sharded cluster instance - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::MONGODB::ShardingInstance",
  "Properties": {
    "EngineVersion": String,
    "ZoneId": String,
    "AutoRenew": Boolean,
    "VSwitchId": String,
    "Period": Integer,
    "SecurityIPArray": String,
    "Mongos": List,
    "StorageEngine": String,
    "RestoreTime": String,
    "AccountPassword": String,
    "VpcId": String,
    "ProtocolType": String,
    "ChargeType": String,
    "ConfigServer": List,
    "SrcDBInstanceId": String,
    "ReplicaSet": List,
    "Tags": List,
    "TDEStatus": Boolean,
    "DBInstanceDescription": String,
    "ResourceGroupId": String,
    "SecondaryZoneId": String,
    "HiddenZoneId": String,
    "StorageType": String
  }
}

Propriedades

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
ConfigServer	List	Yes	No	As configurações do nó Configserver.	Para mais informações, consulte ConfigServer properties.
Mongos	List	Yes	No	Os nós mongos.	O cluster admite de 2 a 32 nós mongos. Para mais informações, consulte Mongos property.
ReplicaSet	List	Yes	No	Os nós de shard.	O cluster admite de 2 a 32 nós de shard. Para mais informações, consulte ReplicaSet properties.
EngineVersion	String	No	No	A versão do mecanismo de banco de dados.	Valores válidos: 3.4 4.0 4.2 Nota Ao clonar uma instância, o valor desta propriedade deve ser igual à versão do mecanismo de banco de dados da instância de origem.
ZoneId	String	No	No	O id da zona de disponibilidade.	Nenhuma.
AutoRenew	Boolean	No	No	Especifica se a renovação automática da instância está ativa.	Valores válidos: true: ativa a renovação automática da instância. false (padrão): desativa a renovação automática. A instância deve ser renovada manualmente. Nota Esta propriedade entra em vigor quando ChargeType está definido como PrePaid.
VSwitchId	String	No	No	O id do vSwitch.	Nenhuma.
Period	Integer	No	Yes	A duração da assinatura da instância.	Valores válidos: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24 e 36. Unidade: mês. Nota Esta propriedade é obrigatória quando ChargeType está definido como PrePaid.
SecurityIPArray	String	No	Yes	As entradas da lista de permissões de endereços IP da instância.	Separe múltiplos endereços IP com vírgulas (,). Cada endereço IP deve ser único na lista, que pode conter até 1.000 endereços. Os formatos aceitos para entradas na lista de permissões são: %. 0.0.0.0/0. Endereços IP, como 10.23.XX.XX. Blocos CIDR, como 10.23.XX.XX/24. O sufixo /24 indica que o prefixo do bloco CIDR tem 24 bits de comprimento. Substitua 24 por um valor entre 1 e 32. Nota Os valores % e 0.0.0.0/0 permitem acesso aos bancos de dados da instância a partir de qualquer endereço IP. Isso pode representar riscos de segurança. Use esses valores com cautela.
StorageEngine	String	No	No	O mecanismo de armazenamento da instância.	Valores válidos: WiredTiger (padrão): indicado para a maioria dos cenários. RocksDB: mais adequado para cenários com grande volume de operações de escrita e poucas operações de leitura. TerarkDB: projetado para cenários em que as operações de leitura superam as de escrita, ou em que múltiplas escritas ocorrem simultaneamente com alto volume de leituras. Nota Ao clonar uma instância, o valor desta propriedade deve ser igual ao mecanismo de armazenamento da instância de origem.
RestoreTime	String	No	No	O ponto no tempo para o qual os dados serão restaurados ao clonar a instância.	Especifique o horário no padrão ISO 8601, no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Esta propriedade só pode ser usada ao clonar uma instância e deve ser especificada em conjunto com a propriedade SrcDBInstanceId. Nota O valor deve corresponder a um ponto no tempo dentro dos últimos sete dias.
AccountPassword	String	No	Yes	A senha da conta root.	A senha deve ter entre 8 e 32 caracteres e conter pelo menos três dos seguintes tipos: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais. Os caracteres especiais aceitos são: `! # $ % ^ & * ( ) _ + - =`.
VpcId	String	No	No	O id da VPC (Virtual Private Cloud).	Nenhuma.
ProtocolType	String	No	No	O tipo de protocolo de acesso.	Valores válidos: mongodb dynamodb
ChargeType	String	No	Yes	O método de faturamento da instância.	Valores válidos: PostPaid (padrão): pagamento conforme o uso. PrePaid: assinatura. Nota Ao defina esta propriedade como PrePaid, especifique também Period.
SrcDBInstanceId	String	No	No	O id da instância de source.	Esta propriedade só pode ser usada ao clonar uma instância e deve ser especificada em conjunto com a propriedade RestoreTime.
Tags	List	No	Yes	As tags.	O limite máximo é de 20 tags. Para mais informações, consulte Tags properties.
TDEStatus	Boolean	No	Yes	Especifica se a criptografia transparente de dados (TDE) está ativa.	Valores válidos: true: ativa o TDE. Nota Após ativar o TDE, não é possível desativá-lo. false (padrão): desativa o TDE.
ResourceGroupId	String	No	Yes	O id do grupo de recursos ao qual a instância pertence.	Nenhuma.
DBInstanceDescription	String	No	No	O nome da instância.	O nome deve ter entre 2 e 256 caracteres e pode conter letras, dígitos, underscores (_) e hifens (-). Deve começar com uma letra.
SecondaryZoneId	String	No	No	O id da zona de disponibilidade do nó secundário.	Valores válidos: cn-hangzhou-g: o id de Hangzhou Zone G. cn-hangzhou-h: o id de Hangzhou Zone H. cn-hangzhou-i: o id de Hangzhou Zone I. cn-hongkong-b: o id de Hong Kong Zone B. cn-hongkong-c: o id de Hong Kong Zone C. cn-hongkong-d: o id de Hong Kong Zone D. cn-wulanchabu-a: o id de Ulanqab Zone A. cn-wulanchabu-b: o id de Ulanqab Zone B. cn-wulanchabu-c: o id de Ulanqab Zone C. ap-southeast-1a: o id de Singapore Zone A. ap-southeast-1b: o id de Singapore Zone B. ap-southeast-1c: o id de Singapore Zone C. ap-southeast-5a: o id de Jakarta Zone A. ap-southeast-5b: o id de Jakarta Zone B. ap-southeast-5c: o id de Jakarta Zone C. eu-central-1a: o id de Frankfurt Zone A. eu-central-1b: o id de Frankfurt Zone B. eu-central-1c: o id de Frankfurt Zone C. Nota Esta propriedade é obrigatória quando EngineVersion está definido como 4.4 ou 5.0. O valor de SecondaryZoneId deve ser diferente dos valores de ZoneId e HiddenZoneId.
HiddenZoneId	String	No	No	O id da zona de disponibilidade do nó oculto.	Valores válidos: cn-hangzhou-g: o id de Hangzhou Zone G. cn-hangzhou-h: o id de Hangzhou Zone H. cn-hangzhou-i: o id de Hangzhou Zone I. cn-hongkong-b: o id de Hong Kong Zone B. cn-hongkong-c: o id de Hong Kong Zone C. cn-hongkong-d: o id de Hong Kong Zone D. cn-wulanchabu-a: o id de Ulanqab Zone A. cn-wulanchabu-b: o id de Ulanqab Zone B. cn-wulanchabu-c: o id de Ulanqab Zone C. ap-southeast-1a: o id de Singapore Zone A. ap-southeast-1b: o id de Singapore Zone B. ap-southeast-1c: o id de Singapore Zone C. ap-southeast-5a: o id de Jakarta Zone A. ap-southeast-5b: o id de Jakarta Zone B. ap-southeast-5c: o id de Jakarta Zone C. eu-central-1a: o id de Frankfurt Zone A. eu-central-1b: o id de Frankfurt Zone B. eu-central-1c: o id de Frankfurt Zone C. Nota Esta propriedade é obrigatória quando EngineVersion está definido como 4.4 ou 5.0. O valor de HiddenZoneId deve ser diferente dos valores de ZoneId e SecondaryZoneId.
StorageType	String	No	No	A categoria de armazenamento.	Valores válidos: cloud_essd1: PL1 Enterprise SSD (ESSD). cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. local_ssd: SSD local.

Sintaxe de Mongos

"Mongos": [
  {
    "Class": String
  }
]

Propriedade de Mongos

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
Class	String	Yes	No	O tipo de instância do nó mongos.	Para mais informações, consulte Instance specifications overview.

Sintaxe de ConfigServer

"ConfigServer": [
  {
    "Storage": Integer,
    "Class": String
  }
]

Propriedades de ConfigServer

Propriedade

Tipo

Obrigatório

Editável

Descrição

Restrição

Class

String

Yes

No

O tipo de instância do nó Configserver.

Defina o valor como dds.cs.mid.

Nota

Este tipo de instância possui 1 vCPU e 2 GB de memória. O número de nós Configserver é fixo em 1.

Storage

Integer

Yes

No

A capacidade de armazenamento do nó Configserver.

Defina o valor como 20.

Unidade: GB.

Nota

A capacidade de armazenamento é fixa em 20 GB.

Sintaxe de ReplicaSet

"ReplicaSet": [
  {
    "Storage": Integer,
    "Class": String,
    "ReadonlyReplicas": Integer
  }
]

Propriedades de ReplicaSet

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
Class	String	Yes	No	O tipo de instância do nó de shard.	Para mais informações, consulte Instance specifications overview.
Storage	Integer	Yes	No	A capacidade de armazenamento do nó de shard.	Valores válidos: 10 a 2000. Unidade: GB. O valor deve ser incrementado em múltiplos de 10 GB.
ReadonlyReplicas	Integer	No	No	O número de nós somente leitura a serem criados.	Valores válidos: 1 a 5.

Sintaxe de Tags

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

Propriedades de Tags

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
Key	String	Yes	No	A chave da tag.	A chave deve ter entre 1 e 128 caracteres e não pode conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`.
Value	String	No	No	O valor da tag.	O valor pode ter até 128 caracteres e não pode conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`.

Valores de retorno

Fn::GetAtt

DBInstanceStatus: o status da instância.
DBInstanceId: o id da instância.
OrderId: o id do pedido.
Arn: o Alibaba Cloud Resource Name (ARN).

Exemplos

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
Resources:
  MongoDbShardingInstance:
    Type: ALIYUN::MONGODB::ShardingInstance
    Properties:
      ZoneId:
        Ref: ZoneId
      EngineVersion: '4.0'
      Mongos:
        - Class: dds.mongos.mid
        - Class: dds.mongos.mid
      ReplicaSet:
        - Class: dds.shard.mid
          Storage: 10
        - Class: dds.shard.mid
          Storage: 20
      ConfigServer:
        - Class: dds.cs.mid
          Storage: 20
      TDEStatus: false
Outputs:
  DBInstanceStatus:
    Description: Status of mongodb instance.
    Value:
      Fn::GetAtt:
        - MongoDbShardingInstance
        - DBInstanceStatus
  DBInstanceId:
    Description: The instance id of created mongodb instance.
    Value:
      Fn::GetAtt:
        - MongoDbShardingInstance
        - DBInstanceId
  OrderId:
    Description: Order Id of created instance.
    Value:
      Fn::GetAtt:
        - MongoDbShardingInstance
        - OrderId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    }
  },
  "Resources": {
    "MongoDbShardingInstance": {
      "Type": "ALIYUN::MONGODB::ShardingInstance",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "EngineVersion": "4.0",
        "Mongos": [
          {
            "Class": "dds.mongos.mid"
          },
          {
            "Class": "dds.mongos.mid"
          }
        ],
        "ReplicaSet": [
          {
            "Class": "dds.shard.mid",
            "Storage": 10
          },
          {
            "Class": "dds.shard.mid",
            "Storage": 20
          }
        ],
        "ConfigServer": [
          {
            "Class": "dds.cs.mid",
            "Storage": 20
          }
        ],
        "TDEStatus": false
      }
    }
  },
  "Outputs": {
    "DBInstanceStatus": {
      "Description": "Status of mongodb instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbShardingInstance",
          "DBInstanceStatus"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "The instance id of created mongodb instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbShardingInstance",
          "DBInstanceId"
        ]
      }
    },
    "OrderId": {
      "Description": "Order Id of created instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbShardingInstance",
          "OrderId"
        ]
      }
    }
  }
}

Para mais exemplos, consulte sharding-instance.yml.