SearchDatabase - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d’appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer 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	SearchDatabase	Opération à effectuer. Définissez la valeur sur SearchDatabase.
Tid	Long	Yes	3***	ID du locataire. Appelez l’opération GetUserActiveTenant pour obtenir l’ID du locataire.
SearchKey	String	Yes	testdb	Mot-clé utilisé pour rechercher des bases de données.
PageNumber	Integer	Yes	1	Numéro de la page à renvoyer.
PageSize	Integer	No	10	Nombre d’entrées à renvoyer par page.
EnvType	String	No	test	Type d’environnement auquel la base de données appartient. Pour plus d’informations, consultez Change the environment type of an instance.
SearchRange	String	No	HAS_PERMSSION	Plage de recherche basée sur les autorisations. Valeurs possibles : HAS_PERMSSION : recherche les bases de données pour lesquelles l’utilisateur actuel dispose d’autorisations. OWNER : recherche les bases de données appartenant à l’utilisateur actuel. MY_FOCUS : recherche les bases de données suivies par l’utilisateur actuel. UNKNOWN : recherche toutes les bases de données.
SearchTarget	String	No	SINGLE_DB	Catégorie de la base de données. Valeurs possibles : DB : base de données unique ou logique. SINGLE_DB : base de données unique. LOGIC_DB : base de données logique.
DbType	String	No	MYSQL	Type de base de données. Pour connaître les valeurs valides de ce paramètre, consultez DbType parameter.
RegionId	String	No	cn-hangzhou	ID de la région dans laquelle Data Management (DMS) est activé. Pour connaître les valeurs valides de ce paramètre, consultez RegionID parameter.

Paramètres de réponse

Parameter	Type	Example	Description
TotalCount	Long	1	Nombre total d’entrées renvoyées.
RequestId	String	E0D21075-CD3E-4D98-8264-FD8AD04A63B6	ID de la requête.
SearchDatabaseList	Array of SearchDatabase		Informations sur les bases de données.
SearchDatabase
DatabaseId	String	2528****	ID de la base de données.
Host	String	rm-xxxx.mysql.rds.aliyuncs.com	Endpoint de l’instance hébergeant la base de données.
DbaId	String	10****	ID de l’utilisateur assumant le rôle d’administrateur de base de données (DBA).
SchemaName	String	test	Nom de la base de données.
Logic	Boolean	false	Indique si la base de données est logique. Valeurs possibles : true : base de données logique. false : base de données non logique.
DatalinkName	String	datalink_name	Nom du lien de données pour les requêtes inter-bases.
Port	Integer	3306	Numéro de port de l’instance hébergeant la base de données.
EnvType	String	test	Type d’environnement auquel la base de données appartient. Pour plus d’informations, consultez Change the environment type of an instance.
Sid	String	testSid	ID système (Sid) de l’instance hébergeant la base de données.
OwnerIdList	Array of String	1	ID des propriétaires de la base de données.
Encoding	String	utf8	Encodage de la base de données.
DbType	String	mysql	Type de base de données.
OwnerNameList	Array of String	user1	Pseudonymes des propriétaires de la base de données.
SearchName	String	test@xxx.xxx.xxx.xxx:3306	Nom utilisé pour rechercher la base de données.
Alias	String	test_rds	Alias de la base de données.
ErrorCode	String	UnknownError	Code d’erreur renvoyé.
ErrorMessage	String	UnknownError	Message d’erreur renvoyé.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true : la requête a abouti. false : la requête a échoué.

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=SearchDatabase
&Tid=3***
&SearchKey=testdb
&PageNumber=1
&PageSize=10
&EnvType=test
&SearchRange=HAS_PERMSSION
&SearchTarget=SINGLE_DB
&DbType=MYSQL
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<SearchDatabaseResponse>
    <TotalCount>1</TotalCount>
    <RequestId>E0D21075-CD3E-4D98-8264-FD8AD04A63B6</RequestId>
    <SearchDatabaseList>
        <DatabaseId>2528****</DatabaseId>
        <Host>rm-xxxx.mysql.rds.aliyuncs.com</Host>
        <DbaId>10****</DbaId>
        <SchemaName>test</SchemaName>
        <Logic>false</Logic>
        <DatalinkName>datalink_name</DatalinkName>
        <Port>3306</Port>
        <EnvType>test</EnvType>
        <Sid>testSid</Sid>
        <OwnerIdList>1</OwnerIdList>
        <Encoding>utf8</Encoding>
        <DbType>mysql</DbType>
        <OwnerNameList>user1</OwnerNameList>
        <SearchName>test@xxx.xxx.xxx.xxx:3306</SearchName>
        <Alias>test_rds</Alias>
    </SearchDatabaseList>
    <Success>true</Success>
</SearchDatabaseResponse>

Format JSON

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

{
  "TotalCount" : 1,
  "RequestId" : "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList" : [ {
    "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" : [ "1" ],
    "Encoding" : "utf8",
    "DbType" : "mysql",
    "OwnerNameList" : [ "user1" ],
    "SearchName" : "test@xxx.xxx.xxx.xxx:3306",
    "Alias" : "test_rds"
  } ],
  "Success" : true
}

Codes d’erreur

Pour obtenir la liste des codes d’erreur, consultez le Centre d’erreurs API.