Use DATASOURCE::RDS::DBInstances to query ApsaraDB RDS instances - Resource Orchestration Service

La ressource DATASOURCE::RDS::DBInstances permet d'interroger les instances ApsaraDB RDS.

Syntaxe

{
  "Type": "DATASOURCE::RDS::DBInstances",
  "Properties": {
    "DedicatedHostId": String,
    "EngineVersion": String,
    "DBInstanceStatus": String,
    "ResourceGroupId": String,
    "ZoneId": String,
    "DBInstanceClass": String,
    "DedicatedHostGroupId": String,
    "VSwitchId": String,
    "DBInstanceType": String,
    "InstanceLevel": Number,
    "Expired": String,
    "PayType": String,
    "InstanceNetworkType": String,
    "VpcId": String,
    "DBInstanceId": String,
    "SearchKey": String,
    "ConnectionMode": String,
    "ConnectionString": String,
    "Engine": String,
    "proxyId": String,
    "RefreshOptions": String
  }
}

Propriétés

Propriété	Type	Obligatoire	Modifiable	Description	Contrainte
DedicatedHostId	String	Non	Oui	ID de l'hôte dans le cluster dédié.	Aucune.
EngineVersion	String	Non	Oui	Version du moteur de base de données.	Aucune.
DBInstanceStatus	String	Non	Oui	État de l'instance.	Pour plus d'informations, consultez la page Tableau des états des instances.
ResourceGroupId	String	Non	Oui	ID du groupe de ressources.	Aucune.
ZoneId	String	Non	Oui	ID de la zone.	Aucune.
DBInstanceClass	String	Non	Oui	Type d'instance.	Pour plus d'informations, consultez la page Types d'instances principales ApsaraDB RDS.
DedicatedHostGroupId	String	Non	Oui	ID du cluster dédié.	Aucune.
VSwitchId	String	Non	Oui	ID du vSwitch.	Aucune.
DBInstanceType	String	Non	Oui	Catégorie de l'instance.	Valeurs valides : Primary : instance principale Readonly : instance en lecture seule Guard : instance de reprise après sinistre Temp : instance temporaire
InstanceLevel	Number	Non	Oui	Indique s'il faut renvoyer l'édition de l'instance.	Valeurs valides : 0 : ne renvoie pas l'édition de l'instance. 1 : renvoie l'édition de l'instance.
Expired	String	Non	Oui	Indique si l'instance a expiré.	Valeurs valides : true false
PayType	String	Non	Oui	Méthode de facturation.	Valeurs valides : Postpaid : paiement à l'utilisation Prepaid : abonnement
InstanceNetworkType	String	Non	Oui	Type de réseau de l'instance.	Valeurs valides : VPC Classic
VpcId	String	Non	Oui	ID du VPC (Virtual Private Cloud).	Aucune.
DBInstanceId	String	Non	Oui	ID de l'instance.	Aucune.
SearchKey	String	Non	Oui	Mot-clé utilisé pour effectuer des recherches approximatives sur les ID ou les descriptions des instances.	Aucune.
ConnectionMode	String	Non	Oui	Mode de connexion de l'instance.	Valeurs valides : Standard : mode standard Safe : mode proxy de base de données
ConnectionString	String	Non	Oui	Endpoint de l'instance.	Aucune.
Engine	String	Non	Oui	Type de moteur de base de données.	Valeurs valides : MySQL SQLServer PostgreSQL MariaDB
proxyId	String	Non	Oui	ID du mode proxy.	Aucune.
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.

Valeurs de retour (Fn::GetAtt)

DBInstanceIds : ID des instances.
DBInstances : détails des instances.

Propriété	Type	Description	Contrainte
DBInstanceIds	List	ID des instances.	Aucune.
DBInstances	List	Détails des instances.	Aucune.
VpcId	String	ID du VPC.	Aucune.
CreateTime	String	Heure de création.	L'heure respecte la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ et est affichée en UTC.
PayType	String	Méthode de facturation de l'instance.	Valeurs valides : Postpaid : paiement à l'utilisation Prepaid : abonnement
EngineVersion	String	Version du moteur de base de données.	Aucune.
VpcName	String	Nom du VPC.	Aucune.
ConnectionString	String	Endpoint de l'instance.	Aucune.
InstanceNetworkType	String	Type de réseau de l'instance.	Valeurs valides : Classic VPC
MasterInstanceId	String	ID de l'instance principale.	Une valeur null indique que l'instance est une instance principale.
ExpireTime	String	Heure d'expiration.	L'heure respecte la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ et est affichée en UTC. Remarque Cette propriété n'est pas renvoyée pour les instances en paiement à l'utilisation.
GuardDBInstanceId	String	ID de l'instance de reprise après sinistre.	Aucune.
ZoneId	String	ID de la zone.	Aucune.
DBInstanceId	String	ID de l'instance.	Aucune.
TempDBInstanceId	String	ID de l'instance temporaire.	Aucune.
DBInstanceStorageType	String	Type de stockage de l'instance.	Aucune.
ConnectionMode	String	Mode de connexion de l'instance.	Valeurs valides : Standard : mode standard Safe : mode proxy de base de données
DBInstanceDescription	String	Description de l'instance.	Aucune.
DBInstanceNetType	String	Type de connexion réseau de l'instance.	Valeurs valides : Internet Intranet
DBInstanceType	String	Catégorie de l'instance.	Valeurs valides : Primary : instance principale Readonly : instance en lecture seule Guard : instance de reprise après sinistre Temp : instance temporaire
DBInstanceStatus	String	État de l'instance.	Pour plus d'informations, consultez la page Tableau des états des instances.
VSwitchId	String	ID du vSwitch.	Aucune.
ResourceGroupId	String	ID du groupe de ressources.	Aucune.
Category	String	Édition de l'instance.	Valeurs valides : Basic : édition Basic RDS HighAvailability : édition Haute disponibilité RDS Finance : édition Enterprise RDS Remarque Cette propriété est renvoyée si InstanceLevel est défini sur 1.
Engine	String	Type de moteur de base de données.	Valeurs valides : MySQL SQLServer PostgreSQL MariaDB
DBInstanceClass	String	Type d'instance.	Pour plus d'informations, consultez la page Types d'instances principales ApsaraDB RDS.
ReadOnlyDBInstanceIds	List	ID des instances en lecture seule.	Aucune.
DeletionProtection	Boolean	Indique si la fonction de protection contre la suppression est activée.	Valeurs valides : true false

Exemples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "The ID of the instance."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::RDS::DBInstances",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DBInstances": {
      "Description": "The list of The RDS Database instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstances"
        ]
      }
    },
    "DBInstanceIds": {
      "Description": "The list of The RDS Database instance Ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: The ID of the instance.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::RDS::DBInstances
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
Outputs:
  DBInstances:
    Description: The list of The RDS Database instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstances
  DBInstanceIds:
    Description: The list of The RDS Database instance Ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceIds