DATASOURCE::MONGODB::Instances - query ApsaraDB for MongoDB instances in ROS - Resource Orchestration Service

Syntaxe

{
  "Type": "DATASOURCE::MONGODB::Instances",
  "Properties": {
    "EngineVersion": String,
    "ReplicationFactor": String,
    "DBInstanceStatus": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "DBInstanceClass": String,
    "VSwitchId": String,
    "DBInstanceType": String,
    "Expired": Boolean,
    "ConnectionDomain": String,
    "VpcId": String,
    "DBInstanceId": String,
    "ChargeType": String,
    "NetworkType": String,
    "DBInstanceDescription": String,
    "Tags": List,
    "RefreshOptions": String
  }
}

Propriétés

Propriété	Type	Obligatoire	Modifiable	Description	Contrainte
EngineVersion	String	Non	Oui	Version du moteur de base de données.	Valeurs valides : 5.0 4.4 4.2 4.0 3.4
ReplicationFactor	String	Non	Oui	Nombre de nœuds dans une instance de jeu de réplicas.	Valeurs valides : 3 5 7
DBInstanceStatus	String	Non	Oui	État de l'instance.	Valeurs valides : États des instances.
ZoneId	String	Non	Oui	ID de la zone.	Appelez l'opération DescribeRegions pour interroger les zones prises en charge.
ResourceGroupId	String	Non	Oui	ID du groupe de ressources.	Aucune.
DBInstanceClass	String	Non	Oui	Type d'instance.	Valeurs valides : Types d'instances.
VSwitchId	String	Non	Oui	ID du vSwitch.	Aucune.
DBInstanceType	String	Non	Oui	Architecture de l'instance.	Valeurs valides : sharding : instance de cluster fragmenté replicate (par défaut) : instance de jeu de réplicas ou instance autonome serverless : instance serverless
Expired	Boolean	Non	Oui	Indique si l'instance a expiré.	Valeurs valides : true false
ConnectionDomain	String	Non	Oui	Endpoint du nœud.	Appelez l'opération DescribeDBInstanceAttribute pour interroger les endpoints des nœuds.
VpcId	String	Non	Oui	ID du VPC.	Aucune.
DBInstanceId	String	Non	Oui	ID de l'instance.	Aucune.
ChargeType	String	Non	Oui	Mode de facturation.	Valeurs valides : PrePaid : abonnement PostPaid : paiement à l'utilisation
NetworkType	String	Non	Oui	Type de réseau.	Valeurs valides : Classic VPC
DBInstanceDescription	String	Non	Oui	Description de l'instance.	Aucune.
Tags	List	Non	Oui	Tags de l'instance.	Maximum : 20 tags. Propriétés des tags.
RefreshOptions	String	Non	Oui	Politique d'actualisation des ressources de source de données lors de la mise à jour de la pile.	Valeurs valides : Never (par défaut) : n'actualise pas les ressources de source de données lors de la mise à jour de la pile. Always : actualise les ressources de source de données lors de la mise à jour de la pile.

Syntaxe des tags

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

Propriétés des tags

Propriété	Type	Obligatoire	Modifiable	Description	Contrainte
Valeur	String	Non	Non	Valeur du tag.	1 à 128 caractères. Ne peut pas commencer par `aliyun`, `acs:`, `http://`, ni `https://`.
Clé	String	Oui	Non	Clé du tag.	1 à 128 caractères. Ne peut pas commencer par `aliyun`, `acs:`, `http://`, ni `https://`.

Valeurs de retour (Fn::GetAtt)

InstanceIds : ID des instances.
Instances : détails des instances.

Propriété	Type	Description	Contrainte
InstanceIds	List	ID des instances.	Aucune.
Instances	List	Détails des instances.	Aucune.
ChargeType	String	Mode de facturation.	Valeurs valides : PrePaid : abonnement PostPaid : paiement à l'utilisation
Tags	List	Tags de l'instance.	Aucune.
VpcAuthMode	String	Indique si l'accès sans mot de passe via VPC est activé.	Valeurs valides : Open Close
NetworkType	String	Type de réseau.	Valeurs valides : Classic VPC
LockMode	String	Mode de verrouillage de l'instance.	Valeurs valides : Unlock : non verrouillée. ManualLock : verrouillée manuellement. LockByExpiration : verrouillée automatiquement à l'expiration. LockByRestoration : verrouillée automatiquement avant la restauration. LockByDiskQuota : verrouillée automatiquement lorsque la capacité du disque est épuisée. Released : l'instance est libérée et ne peut pas être déverrouillée. Vous ne pouvez restaurer que depuis une sauvegarde.
EngineVersion	String	Version du moteur de base de données.	Aucune.
MongosList	List	Détails des nœuds mongos.	Renvoyé uniquement lorsque DBInstanceType est sharding.
DBInstanceDescription	String	Description de l'instance.	Aucune.
DBInstanceType	String	Architecture de l'instance.	Valeurs valides : sharding : instance de cluster fragmenté replicate : instance de jeu de réplicas ou instance autonome serverless : instance serverless
ShardList	List	Détails des nœuds shard.	Renvoyé uniquement lorsque DBInstanceType est sharding.
DBInstanceStatus	String	État de l'instance.	Valeurs valides : États des instances.
DBInstanceStorage	Number	Capacité de stockage de l'instance.	Aucune.
ResourceGroupId	String	ID du groupe de ressources.	Aucune.
ZoneId	String	ID de la zone.	Aucune.
DBInstanceId	String	ID de l'instance.	Aucune.
DBInstanceClass	String	Type d'instance.	Valeurs valides : Spécifications d'instance.
Engine	String	Moteur de base de données.	Aucune.
ReplicationFactor	String	Nombre de nœuds dans l'instance.	Renvoyé uniquement lorsque DBInstanceType est replicate.
KindCode	String	Code de type de l'instance.	Valeurs valides : 0 : machine physique 1 : instance Elastic Compute Service (ECS) 2 : cluster docker 18 : cluster Kubernetes
CapacityUnit	String	Débit de lecture et d'écriture consommé par l'instance.	Renvoyé uniquement lorsque DBInstanceType est serverless.

Exemples

Format JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "Type": "String",
      "Description": "The zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list. ",
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId"
    },
    "DbType": {
      "Type": "String",
      "Description": "The database engine type of the instance.\nnormal: replica set instance\nsharding: sharded cluster instance",
      "Default": "normal"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::MONGODB::InstanceClasses",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DbType": {
          "Ref": "DbType"
        }
      }
    }
  },
  "Outputs": {
    "InstanceClasses": {
      "Description": "The list of The instance classes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClasses"
        ]
      }
    },
    "InstanceClassIds": {
      "Description": "The list of The instance class Ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClassIds"
        ]
      }
    }
  }
}