GetInstance - - Centre de documentation Alibaba Cloud

Obtient les détails d'une instance spécifiée.

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:GetInstance

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Appelez l'opération GetUserActiveTenant pour obtenir cette valeur.	2***
Host	string	Oui	Le point de terminaison de l'instance. Appelez l'opération ListInstances pour obtenir cette valeur.	172.17.XXX.XXX
Port	integer	Oui	Le port de l'instance. Appelez l'opération ListInstances pour obtenir cette valeur.	5432
Sid	string	Non	Le SID de l'instance. Appelez l'opération ListInstances pour obtenir cette valeur.	test
RealLoginUserUid	string	Non	Ce paramètre est réservé.

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	F6C80B69-3203-56AC-8021-18BA72A6F4E1
Instance	object	Les détails de l'instance.
VpcId	string	L'identifiant du VPC auquel l'instance appartient.	vpc-o6wrloqsdqc9io3mg****
DatabaseUser	string	Le nom d'utilisateur utilisé pour se connecter à l'instance.	dbuser
DbaId	string	L'identifiant de l'administrateur de base de données (DBA) de l'instance.	29****
UseDsql	integer	Indique si la requête inter-bases de données est activée pour l'instance. Valeurs valides : 0 : désactivée 1 : activée	0
Port	integer	Le port utilisé pour se connecter à l'instance.	5432
EcsInstanceId	string	L'identifiant de l'instance ECS sur laquelle l'instance de base de données est déployée.	i-bp124ldpklqz59y3****
EnvType	string	Le type d'environnement auquel l'instance appartient. 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 test d'acceptation utilisateur (UAT) pet : environnement de test de performance stag : environnement de staging	test
Sid	string	L'identifiant système (SID) de l'instance.	test
OwnerIdList	object	Les identifiants des propriétaires de l'instance.
OwnerIds	array	The user IDs of the instance owners.
	string	The user ID of an instance owner.	10****
SafeRuleId	string	L'identifiant du jeu de règles de sécurité pour l'instance.	3****
OwnerNameList	object	Les pseudonymes des propriétaires de l'instance.
OwnerNames	array	The nicknames of the instance owners.
	string	The nickname of an instance owner.	yang_test
DbaNickName	string	Le pseudonyme du DBA de l'instance.	dbaname
QueryTimeout	integer	Le délai d'expiration pour l'interrogation des données dans l'instance. Unité : secondes.	7200
InstanceSource	string	La source de l'instance.	ECS_OWN
Host	string	Le point de terminaison utilisé pour se connecter à l'instance.	192.168.XXX.XXX
State	string	L'état de l'instance. Valeurs valides : NORMAL : L'instance fonctionne normalement. DISABLE : L'instance est désactivée.	NORMAL
DataLinkName	string	Le nom de la liaison de données pour l'instance.	test
ExportTimeout	integer	Le délai d'expiration pour l'exportation des données depuis l'instance. Unité : secondes.	86400
InstanceId	string	L'identifiant de l'instance.	188****
InstanceType	string	Le type de la base de données.	postgresql
DatabasePassword	string	Le mot de passe correspondant au nom d'utilisateur.	******
InstanceAlias	string	L'alias de l'instance.	测试
DdlOnline	integer	Indique si la modification de schéma sans verrouillage est activée pour l'instance.	0
EcsRegion	string	La région où réside l'instance.	cn-beijing
StandardGroup	object	Le mode de contrôle de l'instance.
GroupName	string	The name of the security rule set that corresponds to the control mode.	Free operation
GroupMode	string	The control mode. Valid values: COMMON: Security Collaboration NONE_CONTROL: Flexible Management STABLE: Stable Change	NONE_CONTROL
SellSitd	string	Indique si la protection des données sensibles est activée. Valeurs valides : true : activée false : désactivée	false
SellTrust	string	Ce paramètre est réservé.
ErrorCode	string	Le code d'erreur renvoyé.	UnknownError
ErrorMessage	string	Le message d'erreur renvoyé.	UnknownError
Success	boolean	Indique si la requête a réussi. Valeurs valides : true false	true

Exemples

JSON format

{
  "RequestId": "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance": {
    "VpcId": "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser": "dbuser",
    "DbaId": "29****",
    "UseDsql": 0,
    "Port": 5432,
    "EcsInstanceId": "i-bp124ldpklqz59y3****",
    "EnvType": "test",
    "Sid": "test",
    "OwnerIdList": {
      "OwnerIds": [
        "10****"
      ]
    },
    "SafeRuleId": "3****",
    "OwnerNameList": {
      "OwnerNames": [
        "yang_test"
      ]
    },
    "DbaNickName": "dbaname",
    "QueryTimeout": 7200,
    "InstanceSource": "ECS_OWN",
    "Host": "192.168.XXX.XXX",
    "State": "NORMAL",
    "DataLinkName": "test",
    "ExportTimeout": 86400,
    "InstanceId": "188****",
    "InstanceType": "postgresql",
    "DatabasePassword": "******",
    "InstanceAlias": "Test",
    "DdlOnline": 0,
    "EcsRegion": "cn-beijing",
    "StandardGroup": {
      "GroupName": "Free operation",
      "GroupMode": "NONE_CONTROL"
    },
    "SellSitd": "false",
    "SellTrust": ""
  },
  "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.