GetInstance - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de simplicité, nous vous recommandons d'appeler cette opération via OpenAPI Explorer. Ce dernier 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	GetInstance	Opération à effectuer. Définissez la valeur sur GetInstance.
Tid	Long	Yes	2***	ID du locataire. Appelez l'opération GetUserActiveTenant pour récupérer cet ID.
Host	String	Yes	172.17.XXX.XXX	Endpoint de l'instance de base de données. Appelez l'opération ListInstances pour récupérer l'endpoint.
Port	Integer	Yes	5432	Numéro de port de connexion à l'instance de base de données. Appelez l'opération ListInstances pour récupérer le numéro de port.
Sid	String	No	test	ID système (SID) de l'instance de base de données. Appelez l'opération ListInstances pour récupérer le SID.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	F6C80B69-3203-56AC-8021-18BA72A6F4E1	ID de la requête.
Instance	Object		Détails de l'instance de base de données.
VpcId	String	vpc-o6wrloqsdqc9io3mg****	ID du Virtual Private Cloud (VPC) auquel appartient l'instance de base de données.
DatabaseUser	String	dbuser	Compte de connexion à l'instance de base de données.
DbaId	String	29****	ID de l'administrateur de base de données (DBA) de l'instance.
UseDsql	Integer	0	Indique si la fonctionnalité de requête inter-bases est activée pour l'instance. Valeurs possibles : 0 : désactivée 1 : activée
Port	Integer	5432	Numéro de port de connexion à l'instance de base de données.
EcsInstanceId	String	i-bp124ldpklqz59y3****	ID de l'instance Elastic Compute Service (ECS) sur laquelle est déployée l'instance de base de données.
EnvType	String	test	Type d'environnement de déploiement de l'instance. Valeurs possibles : product : production dev : développement pre : pré-production test : test sit : tests d'intégration système (SIT) uat : recette utilisateur (UAT) pet : tests de charge stag : staging
Sid	String	test	SID de l'instance de base de données.
OwnerIdList	Array of String	10****	ID des propriétaires de l'instance de base de données.
SafeRuleId	String	3****	ID de l'ensemble de règles de sécurité de l'instance.
OwnerNameList	Array of String	yang_test	Pseudonymes des propriétaires de l'instance.
DbaNickName	String	dbaname	Pseudonyme du DBA de l'instance.
QueryTimeout	Integer	7200	Délai d'expiration des requêtes de données dans l'instance.
InstanceSource	String	ECS_OWN	Source de l'instance de base de données.
Host	String	192.168.XXX.XXX	Endpoint de connexion à l'instance de base de données.
State	String	NORMAL	État de l'instance de base de données. Valeurs possibles : NORMAL : normale DISABLE : désactivée
DataLinkName	String	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.
InstanceId	String	188****	ID de l'instance.
InstanceType	String	postgresql	Type de l'instance de base de données.
DatabasePassword	String	******	Mot de passe de connexion à l'instance de base de données.
InstanceAlias	String	Test	Alias de l'instance de base de données.
DdlOnline	Integer	0	Indique si la modification de schéma sans verrouillage est activée pour l'instance.
EcsRegion	String	cn-beijing	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	Flexible Management	Nom de la règle de sécurité correspondant au mode de contrôle.
GroupMode	String	NONE_CONTROL	Type de mode de contrôle. Valeurs possibles : COMMON : Security Collaboration NONE_CONTROL : Flexible Management STABLE : Stable Change
SellSitd	String	false	Indique si la protection des données sensibles est activée. Valeurs possibles : true : activée false : désactivée
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.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true : succès false : échec

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=GetInstance
&Tid=1
&Host=172.17.XXX.XXX
&Port=5432
&Sid=test
&Common request parameters

Exemple de réponse réussie

Format XML

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

<GetInstanceResponse>
    <RequestId>F6C80B69-3203-56AC-8021-18BA72A6F4E1</RequestId>
    <Instance>
        <Port>5432</Port>
        <DatabasePassword>******</DatabasePassword>
        <ExportTimeout>86400</ExportTimeout>
        <EnvType>test</EnvType>
        <DbaId>12****</DbaId>
        <InstanceAlias>Test</InstanceAlias>
        <EcsRegion>cn-beijing</EcsRegion>
        <InstanceType>postgresql</InstanceType>
        <QueryTimeout>7200</QueryTimeout>
        <DataLinkName>dbl_postgresql_2</DataLinkName>
        <SafeRuleId>3****</SafeRuleId>
        <SellSitd>false</SellSitd>
        <InstanceSource>ECS_OWN</InstanceSource>
        <StandardGroup>
            <GroupName>Flexible Management</GroupName>
            <GroupMode>NONE_CONTROL</GroupMode>
        </StandardGroup>
        <InstanceId>188****</InstanceId>
        <Host>172.17.XXX.XXX</Host>
        <DdlOnline>0</DdlOnline>
        <UseDsql>0</UseDsql>
        <EcsInstanceId>i-bp124ldpklqz59y3****</EcsInstanceId>
        <State>NORMAL</State>
        <DatabaseUser>postgres</DatabaseUser>
        <OwnerNameList>
            <OwnerNames>yang_test</OwnerNames>
        </OwnerNameList>
        <DbaNickName>dbaname</DbaNickName>
        <OwnerIdList>
            <OwnerIds>10****</OwnerIds>
        </OwnerIdList>
    </Instance>
    <Success>true</Success>
</GetInstanceResponse>

Format JSON

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

{
  "RequestId" : "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance" : {
    "Port" : 5432,
    "DatabasePassword" : "******",
    "ExportTimeout" : 86400,
    "EnvType" : "test",
    "DbaId" : "12****",
    "InstanceAlias" : "Test",
    "EcsRegion" : "cn-beijing",
    "InstanceType" : "postgresql",
    "QueryTimeout" : 7200,
    "DataLinkName" : "dbl_postgresql_2",
    "SafeRuleId" : "3****",
    "SellSitd" : false,
    "InstanceSource" : "ECS_OWN",
    "StandardGroup" : {
      "GroupName" : "Flexible Management",
      "GroupMode" : "NONE_CONTROL"
    },
    "InstanceId" : "188****",
    "Host" : "172.17.XXX.XXX",
    "DdlOnline" : 0,
    "UseDsql" : "0",
    "EcsInstanceId" : "i-bp124ldpklqz59y3****",
    "State" : "NORMAL",
    "DatabaseUser" : "postgres",
    "OwnerNameList" : {
      "OwnerNames" : [ "yang_test" ]
    },
    "DbaNickName" : "dbaname",
    "OwnerIdList" : {
      "OwnerIds" : [ "10****" ]
    }
  },
  "Success" : true
}

Codes d'erreur

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