GetDatabase - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	GetDatabase	Opération à effectuer. Définissez la valeur sur GetDatabase.
Host	String	Yes	192.168.XX.XX	Endpoint de connexion à la base de données.
Port	Integer	Yes	3306	Port de connexion à la base de données.
SchemaName	String	Yes	mysql	Nom de la base de données.
Tid	Long	Yes	-1	ID du locataire (tenant). Appelez l'opération GetUserActiveTenant pour récupérer cet ID.
Sid	String	No	test_sid	Identificateur système (SID) de la base de données. Remarque Le SID identifie de manière unique une base de données Oracle. Il est généré lors de la création de la base.

Paramètres de réponse

Parameter	Type	Example	Description
Database	Struct		Détails de la base de données.
CatalogName	String	def	Nom du catalogue auquel appartient la base de données.
DatabaseId	String	984****	ID de la base de données.
DbType	String	mysql	Type de la base de données. Pour connaître les valeurs valides, consultez la section Paramètre DbType.
DbaId	String	27****	ID de l'administrateur de base de données (DBA).
DbaName	String	dba_name	Surnom du DBA.
Encoding	String	utf8mb4	Format d'encodage de la base de données.
EnvType	String	product	Type d'environnement de la base de données. Valeurs valides : product : environnement de production dev : environnement de développement pre : environnement de préproduction test : environnement de test sit : environnement SIT uat : environnement de recette utilisateur (UAT) pet : environnement de test de charge stag : environnement STAG
Host	String	192.168.XX.XX	Endpoint de connexion à la base de données.
InstanceId	String	149****	ID de l'instance.
OwnerIdList	List	27****	ID des propriétaires de la base de données.
OwnerNameList	List	test	Noms des propriétaires de la base de données.
Port	Integer	3306	Port de connexion à la base de données.
SchemaName	String	mysql	Nom de la base de données.
SearchName	String	mysql@192.168.XX.XX:3306	Mot-clé utilisé pour rechercher la base de données.
Sid	String	test_sid	SID de la base de données. Remarque Ce paramètre n'est renvoyé que pour les bases de données Oracle.
State	String	NORMAL	État de la base de données. Valeurs valides : NORMAL : La base de données fonctionne correctement. DISABLE : La base de données est désactivée. OFFLINE : La base de données est dépubliée. NOT_EXIST : La base de données n'existe pas.
ErrorCode	String	UnknownError	Code d'erreur.
ErrorMessage	String	An unknown error occurred.	Message d'erreur.
RequestId	String	3CDB8601-AD74-4A47-8114-08E08CD6****	ID de la requête.
Success	Boolean	true	Indique si la requête a réussi. Valeurs valides : true : La requête a réussi. false : Échec de la requête.

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=GetDatabase
&Host=192.168.XX.XX
&Port=3306
&SchemaName=mysql
&Tid=-1
&<Common request parameters>

Exemple de réponse réussie

Format XML

<GetDatabaseResponse>
  <RequestId>2EF65A2C-FCDC-5E14-A8B5-8D28F33A****</RequestId>
  <Database>
        <SearchName>mysql@192.168.XX.XX:3306[bw-mysql-el8]</SearchName>
        <InstanceId>149****</InstanceId>
        <Port>3306</Port>
        <Encoding>utf8mb4</Encoding>
        <Host>192.168.XX.XX</Host>
        <DatabaseId>984****</DatabaseId>
        <DbType>mysql</DbType>
        <EnvType>product</EnvType>
        <DbaName>dba_name</DbaName>
        <DbaId>27****</DbaId>
        <State>NORMAL</State>
        <CatalogName>def</CatalogName>
        <OwnerNameList>
              <OwnerNames>test</OwnerNames>
        </OwnerNameList>
        <SchemaName>mysql</SchemaName>
        <OwnerIdList>
              <OwnerIds>27****</OwnerIds>
        </OwnerIdList>
  </Database>
  <Success>true</Success>
</GetDatabaseResponse>

Format JSON

{
    "RequestId": "2EF65A2C-FCDC-5E14-A8B5-8D28F33A****",
    "Database": {
        "SearchName": "mysql@192.168.XX.XX:3306[bw-mysql-el8]",
        "InstanceId": "149****",
        "Port": "3306",
        "Encoding": "utf8mb4",
        "Host": "192.168.XX.XX",
        "DatabaseId": "984****",
        "DbType": "mysql",
        "EnvType": "product",
        "DbaName": "dba_name",
        "DbaId": "27****",
        "State": "NORMAL",
        "CatalogName": "def",
        "OwnerNameList": {
            "OwnerNames": [
                "test"
            ]
        },
        "SchemaName": "mysql",
        "OwnerIdList": {
            "OwnerIds": [
                "27****"
            ]
        }
    },
    "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.