SearchDatabase - - Centre de documentation Alibaba Cloud

Consulte les détails de l'index.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

dms:SearchDatabase

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Vous pouvez appeler l'opération GetUserActiveTenant pour obtenir l'identifiant du locataire.	3***
SearchKey	string	Non	Le mot-clé pour rechercher des bases de données.	testdb
PageNumber	integer	Non	Le numéro de page.	1
PageSize	integer	Non	Le nombre d'entrées par page.	10
EnvType	string	Non	Le type d'environnement de la base de données. Pour plus d'informations, consultez Description de l'environnement de l'instance.	test
SearchRange	string	Non	La portée des autorisations. Valeurs valides : HAS_PERMSSION : bases de données sur lesquelles vous disposez d'autorisations. OWNER : bases de données que vous possédez. MY_FOCUS : bases de données que vous suivez. UNKNOWN : toutes les bases de données.	HAS_PERMSSION
SearchTarget	string	Non	La cible de recherche. Valeurs valides : DB : toutes les bases de données, y compris les bases de données physiques et logiques. SINGLE_DB : bases de données physiques. LOGIC_DB : bases de données logiques.	SINGLE_DB
DbType	string	Non	Le type de moteur de base de données. Pour plus d'informations sur les valeurs valides, consultez Paramètre DbType.	MYSQL
RealLoginUserUid	string	Non	La méthode de tri des résultats de la requête. Valeurs valides : LAST_ACTIVE_TIME : trie les résultats par dernière heure d'activité. DB_NAME : trie les résultats par nom de base de données.

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalCount	integer	Le nombre total d'entrées qui répondent aux critères de filtrage.	1
RequestId	string	L'identifiant de la requête.	E0D21075-CD3E-4D98-8264-FD8AD04A63B6
SearchDatabaseList	object
SearchDatabase	array<object>	La liste des bases de données.
	array<object>	Les détails des bases de données.
DatabaseId	string	The ID of the database.	2528****
Host	string	The endpoint that is used to connect to the database.	rm-xxxx.mysql.rds.aliyuncs.com
DbaId	string	The ID of the database administrator (DBA) of the instance.	10****
SchemaName	string	The name of the database.	test
Logic	boolean	Indicates whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is not a logical database.	false
DatalinkName	string	The name of the database link for cross-database queries.	datalink_name
Port	integer	The port that is used to connect to the database.	3306
EnvType	string	The environment type of the instance. For more information, see Instance environments.	test
Sid	string	The system ID (SID) of the instance.	testSid
OwnerIdList	object
OwnerIds	array	The IDs of the database owners.
	string	The ID of a database owner.	1
Encoding	string	The character set that is used in the database.	utf8
DbType	string	The type of the database.	mysql
OwnerNameList	object
OwnerNames	array	The nicknames of the database owners.
	string	The nickname of a database owner.	user1
SearchName	string	The name that is used to search for the database.	test@xxx.xxx.xxx.xxx:3306
Alias	string	The alias of the database.	test_rds
CatalogName	string	The name of the database catalog. Remarque For PostgreSQL databases, the database name is returned.	dmstest
ErrorCode	string	Le code d'erreur renvoyé en cas d'échec de la requête.	UnknownError
ErrorMessage	string	Le message d'erreur renvoyé en cas d'échec de la requête.	UnknownError
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true

Exemples

JSON format

{
  "TotalCount": 1,
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList": {
    "SearchDatabase": [
      {
        "DatabaseId": "2528****",
        "Host": "rm-xxxx.mysql.rds.aliyuncs.com",
        "DbaId": "10****",
        "SchemaName": "test",
        "Logic": false,
        "DatalinkName": "datalink_name",
        "Port": 3306,
        "EnvType": "test",
        "Sid": "testSid",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "user1"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306",
        "Alias": "test_rds",
        "CatalogName": "dmstest"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.