Interroger les informations sur les bases de données - - Centre de documentation Alibaba Cloud

Appelez l'opération DescribeDatabases pour interroger les informations relatives aux bases de données d'une instance.

Remarque

Si les paramètres de requête spécifiés ne sont pas valides, aucune information sur la base de données n'est renvoyée.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement un exemple de code pour l'opération adaptée à différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDatabases	L'opération à exécuter. Définissez la valeur sur DescribeDatabases.
DBInstanceId	String	Yes	rm-uf6wjk5xxxxxxx	ID de l'instance.
DBName	String	No	testDB01	Nom de la base de données.
DBStatus	String	No	Creating	État de la base de données. Valeurs possibles : Creating Running Deleting
PageSize	Integer	No	30	Nombre d'entrées à renvoyer par page. Valeurs possibles : 30 50 100 Valeur par défaut : 30.
PageNumber	Integer	No	1	Numéro de la page à renvoyer. Valeurs possibles : tout entier positif non nul. Valeur par défaut : 1.
ResourceGroupId	String	No	rg-acfmy*****	ID du groupe de ressources.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	2603CA96-B17D-4903-BC04-61A2C829CD94	ID de la requête.
Databases	Array of Database		Tableau contenant les informations relatives aux bases de données.
Database
DBDescription	String	Test database	Description de la base de données.
DBStatus	String	Creating	État de la base de données. Valeurs possibles : Creating Running Deleting
DBName	String	testDB01	Nom de la base de données.
DBInstanceId	String	rm-uf6wjk5xxxxxxx	ID de l'instance à laquelle appartient la base de données.
Engine	String	MySQL	Moteur de base de données de l'instance à laquelle appartient la base de données.
CharacterSetName	String	utf8	Nom du jeu de caractères.
Collate	String	C	Règles de classement du jeu de caractères. La valeur d'exemple C représente la localisation. Remarque Ce paramètre est renvoyé uniquement pour les instances exécutant PostgreSQL.
Ctype	String	en_US.utf8	Type de jeu de caractères. Remarque Ce paramètre est renvoyé uniquement pour les instances exécutant PostgreSQL.
ConnLimit	String	-1	Limite du nombre de requêtes simultanées. La valeur -1 indique que le nombre de requêtes simultanées est illimité. Remarque Ce paramètre est renvoyé uniquement pour les instances exécutant PostgreSQL.
Tablespace	String	pg_default	Espace de table de la base de données. Remarque Ce paramètre est renvoyé uniquement pour les instances exécutant PostgreSQL.
ResourceGroupId	String	rg-acfmy*****	ID du groupe de ressources.
Accounts	Array of AccountPrivilegeInfo		Tableau contenant les détails des comptes. Chaque compte dispose d'autorisations spécifiques sur la base de données.
AccountPrivilegeInfo
Account	String	test	Nom d'utilisateur du compte.
AccountPrivilege	String	DMLOnly	Autorisations dont dispose le compte sur la base de données. Valeurs possibles : ReadWrite : autorisations en lecture et en écriture ReadOnly : autorisations en lecture seule DMLOnly : autorisations DML uniquement DDLOnly : autorisations DDL uniquement
AccountPrivilegeDetail	String	SELECT	Détails des autorisations dont dispose le compte sur la base de données.
PageNumber	Integer	1	Paramètre réservé.
PageSize	Integer	30	Paramètre réservé.
TotalCount	Integer	100	Nombre total d'entrées renvoyées.

Exemples

Exemples de requêtes

http(s)://rds.aliyuncs.com/?Action=DescribeDatabases
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeDatabasesResponse>
    <RequestId>2603CA96-B17D-4903-BC04-61A2C829CD94</RequestId>
    <Databases>
        <Database>
            <Engine>MySQL</Engine>
            <CharacterSetName>utf8</CharacterSetName>
            <DBStatus>Creating</DBStatus>
            <DBDescription></DBDescription>
            <DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>
            <Accounts></Accounts>
            <DBName>testdb</DBName>
        </Database>
        <Database>
            <Engine>MySQL</Engine>
            <CharacterSetName>gbk</CharacterSetName>
            <DBStatus>Creating</DBStatus>
            <DBDescription></DBDescription>
            <DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>
            <Accounts></Accounts>
            <DBName>testdb2</DBName>
        </Database>
    </Databases></DescribeDatabasesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2603CA96-B17D-4903-BC04-61A2C829CD94",
  "Databases" : {
    "Database" : [ {
      "Engine" : "MySQL",
      "CharacterSetName" : "utf8",
      "DBStatus" : "Creating",
      "DBDescription" : "",
      "DBInstanceId" : "rdsaiiabnaiiabn",
      "Accounts" : {
        " AccountPrivilegeInfo" : [ ]
      },
      "DBName" : "testdb"
    }, {
      "Engine" : "MySQL",
      "CharacterSetName" : "gbk",
      "DBStatus" : "Creating",
      "DBDescription" : "",
      "DBInstanceId" : "rdsaiiabnaiiabn",
      "Accounts" : {
        " AccountPrivilegeInfo" : [ ]
      },
      "DBName" : "testdb2"
    } ]
  }
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	Database.ConnectError	Database connect error. please check instance status and database processlist	Le message d'erreur renvoyé indique une anomalie de la connexion à la base de données. Vérifiez l'état de l'instance et le pool de connexions de la base de données.
400	Database.QueryError	Query Db failed, please check input value and instance status	Le message d'erreur renvoyé indique un échec de l'interrogation de la base de données. Vérifiez les paramètres d'entrée et l'état de l'instance.

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.