ListInstances - - 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, qui génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListInstances	Opération à effectuer. Définissez la valeur sur ListInstances.
Tid	Long	Non	3***	ID du locataire. Appelez l'opération GetUserActiveTenant pour obtenir cet ID.
SearchKey	String	Non	test	Mot-clé de recherche des instances de base de données.
DbType	String	Non	MySQL	Type de base de données. Pour connaître les valeurs valides, consultez le paramètre DbType.
EnvType	String	Non	product	Type d'environnement de l'instance de 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 de test d'intégration système (SIT) uat : environnement de recette utilisateur (UAT) pet : environnement de test de charge stag : environnement de staging
InstanceSource	String	Non	RDS	Source de l'instance de base de données. Valeurs valides : PUBLIC_OWN : instance de base de données autonome déployée sur Internet RDS : instance ApsaraDB RDS ECS_OWN : base de données autonome déployée sur une instance Elastic Compute Service (ECS) VPC_IDC : instance de base de données autonome déployée dans un centre de données connecté via un VPC
NetType	String	Non	VPC	Type de réseau de l'instance de base de données. Valeurs valides : CLASSIC : réseau classique VPC : VPC
InstanceState	String	Non	NORMAL	État de l'instance de base de données. Valeurs valides : NORMAL : normal DISABLE : désactivé
PageNumber	Integer	Non	1	Numéro de la page à renvoyer.
PageSize	Integer	Non	50	Nombre d'entrées par page. La valeur ne peut pas dépasser 100.

Paramètres de réponse

Paramètre	Type	Exemple	Description
TotalCount	Long	1	Nombre total d'instances de base de données renvoyées.
RequestId	String	B4B07137-F6AE-4756-8474-7F92BB6C4E04	ID de la requête.
ErrorCode	String	UnknownError	Code d'erreur renvoyé en cas d'échec de la requête.
ErrorMessage	String	UnknownError	Message d'erreur renvoyé en cas d'échec de la requête.
InstanceList	Array of Instance		Informations relatives aux instances de base de données renvoyées.
Instance
VpcId	String	vpc-o6wrloqsdqc9io3mg****	ID du VPC auquel appartient l'instance de base de données.
DatabaseUser	String	dbUser	Compte utilisé pour se connecter à la base de données.
DbaId	String	31****	ID de l'administrateur de base de données (DBA) de l'instance.
UseDsql	Integer	1	Indique si la fonctionnalité de requête inter-bases est activée pour l'instance. Valeurs valides : 0 : désactivé 1 : activé
Port	Integer	3306	Numéro de port utilisé pour se connecter à l'instance de base de données.
EcsInstanceId	String	150****	ID de l'instance ECS hébergeant l'instance de base de données.
EnvType	String	product	Type d'environnement de l'instance de 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 UAT pet : environnement de test de charge stag : environnement de staging
Sid	String	test	ID système (SID) de l'instance de base de données.
OwnerIdList	Array of String	123453	ID des propriétaires de l'instance de base de données.
SafeRuleId	String	1	ID de l'ensemble de règles de sécurité de l'instance de base de données.
OwnerNameList	Array of String	yuyang_test	Pseudonymes des propriétaires de l'instance de base de données.
DbaNickName	String	dbaName	Pseudonyme du DBA de l'instance de base de données.
QueryTimeout	Integer	60	Délai d'expiration des requêtes de données dans l'instance de base de données.
InstanceSource	String	RDS	Source de l'instance de base de données.
Host	String	****.mysql.rds.aliyuncs.com	Adresse hôte utilisée pour se connecter à l'instance de base de données.
State	String	NORMAL	État de l'instance de base de données.
DataLinkName	String	dblink_test	Nom du lien de base de données de l'instance.
ExportTimeout	Integer	86400	Délai d'expiration des exportations de données depuis l'instance de base de données.
InstanceId	String	150***	ID de l'instance de base de données.
InstanceType	String	mysql	Type de l'instance de base de données.
DatabasePassword	String	******	Mot de passe utilisé pour se connecter à la base de données.
InstanceAlias	String	test	Alias de l'instance de base de données.
DdlOnline	Integer	1	Indique si la modification de schéma sans verrouillage est activée pour l'instance de base de données.
EcsRegion	String	cn-hangzhou	ID de la région où réside l'instance de base de données.
StandardGroup	Object		Mode de contrôle de l'instance de base de données.
GroupName	String	test	Nom de l'ensemble de règles de sécurité correspondant au mode de contrôle.
GroupMode	String	COMMON	Type de mode de contrôle. Valeurs valides : COMMON : Collaboration sécurisée NONE_CONTROL : Gestion flexible STABLE : Modification stable
SellSitd	Boolean	true	Indique si la protection des données sensibles est activée pour l'instance de base de données. Valeurs valides : true : activé false : désactivé
Success	Boolean	true	Indique si la requête a abouti. Valeurs valides : true : La requête a abouti. false : La requête a échoué.

Exemples

Exemples de requêtes

http(s)://dms-enterprise.aliyuncs.com/?Action=ListInstances
&Tid=3***
&SearchKey=test
&DbType=MySQL
&EnvType=product
&InstanceSource=RDS
&NetType=VPC
&InstanceState=NORMAL
&PageNumber=1
&PageSize=50
&Common request parameters

Exemples de réponses réussies

XML format

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

<ListInstancesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>B4B07137-F6AE-4756-8474-7F92BB6C4E04</RequestId>
    <InstanceList>
        <VpcId>vpc-o6wrloqsdqc9io3mg****</VpcId>
        <DatabaseUser>dbUser</DatabaseUser>
        <DbaId>31****</DbaId>
        <UseDsql>1</UseDsql>
        <Port>3306</Port>
        <EcsInstanceId>150****</EcsInstanceId>
        <EnvType>product</EnvType>
        <Sid>test</Sid>
        <OwnerIdList>123453</OwnerIdList>
        <SafeRuleId>1</SafeRuleId>
        <OwnerNameList>yuyang_test</OwnerNameList>
        <DbaNickName>dbaName</DbaNickName>
        <QueryTimeout>60</QueryTimeout>
        <InstanceSource>RDS</InstanceSource>
        <Host>****.mysql.rds.aliyuncs.com</Host>
        <State>NORMAL</State>
        <DataLinkName>dblink_test</DataLinkName>
        <ExportTimeout>86400</ExportTimeout>
        <InstanceId>150***</InstanceId>
        <InstanceType>mysql</InstanceType>
        <DatabasePassword>******</DatabasePassword>
        <InstanceAlias>test</InstanceAlias>
        <DdlOnline>1</DdlOnline>
        <EcsRegion>cn-hangzhou</EcsRegion>
        <StandardGroup>
            <GroupName>test</GroupName>
            <GroupMode>COMMON</GroupMode>
        </StandardGroup>
        <SellSitd>true</SellSitd>
    </InstanceList>
    <Success>true</Success>
</ListInstancesResponse>

JSON format

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

{
  "TotalCount" : 1,
  "RequestId" : "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
  "InstanceList" : [ {
    "VpcId" : "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser" : "dbUser",
    "DbaId" : "31****",
    "UseDsql" : 1,
    "Port" : 3306,
    "EcsInstanceId" : "150****",
    "EnvType" : "product",
    "Sid" : "test",
    "OwnerIdList" : [ "123453" ],
    "SafeRuleId" : "1",
    "OwnerNameList" : [ "yuyang_test" ],
    "DbaNickName" : "dbaName",
    "QueryTimeout" : 60,
    "InstanceSource" : "RDS",
    "Host" : "****.mysql.rds.aliyuncs.com",
    "State" : "NORMAL",
    "DataLinkName" : "dblink_test",
    "ExportTimeout" : 86400,
    "InstanceId" : "150***",
    "InstanceType" : "mysql",
    "DatabasePassword" : "******",
    "InstanceAlias" : "test",
    "DdlOnline" : 1,
    "EcsRegion" : "cn-hangzhou",
    "StandardGroup" : {
      "GroupName" : "test",
      "GroupMode" : "COMMON"
    },
    "SellSitd" : true
  } ],
  "Success" : true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la section Codes d'erreur de service.