GetInstance - - Centre de documentation Alibaba Cloud

Obtient les détails d'une instance.

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.

hologram:GetInstance

get

*Instance.

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

Aucune

Syntaxe de la requête

GET /api/v1/instances/{instanceId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Non	L'identifiant de l'instance. Ce paramètre est obligatoire.	hgprecn-cn-i7m2v08uu00a

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
Instance	object	Les informations de l'instance.
InstanceChargeType	string	Le mode de facturation de l'instance. Valeurs valides : PostPaid : Paiement à l'usage. PrePaid : Abonnement.	PrePaid
CommodityCode	string	Le code du produit. Valeurs valides : hologram_maxcomputeAccelerate_public_cn : Site chinois / accélération lakehouse. hologram_combo_public_cn : Site chinois / abonnement. hologram_prepay_public_intl : Site international / abonnement. hologram_storage_dp_cn : Site chinois / plan de déduction de stockage. hologram_postpay_public_cn : Site chinois / paiement à l'usage. hologram_postpay_public_intl : Site international / paiement à l'usage. hologram_maxcomputeAccelerate_public_intl : Site international / accélération lakehouse. hologram_cu_dp_cn : Site chinois / plan de déduction de calcul.	hologram_combo_public_cn
Cpu	integer	Le nombre de cœurs de processeur.	32
CreationTime	string	L'heure de création. L'heure est au format ISO 8601 en temps UTC.	2021-02-03T13:06:06Z
Disk	string	La taille de stockage standard. Unité : Go.	500
Endpoints	array<object>	La liste des points de terminaison.
	object	Les détails du point de terminaison.
Endpoint	string	Le point de terminaison.	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	Le type de réseau. Valeurs valides : VPCSingleTunnel : VPC. Intranet : Réseau interne. VPCAnyTunnel : Non pris en charge pour les nouvelles instances. Internet : Internet.	Internet
Enabled	boolean	Indique si le réseau est activé. Valeurs valides : true : Activé. false : Désactivé.	true
VSwitchId	string	L'identifiant du vSwitch.	vsw-bp1jqwp2ys6kp7tc9t983
VpcId	string	L'identifiant du VPC.	vpc-uf66jjber3hgvwhki3wna
VpcInstanceId	string	L'identifiant de l'instance VPC.	hgprecn-cn-uqm362o1b001-frontend-st
AlternativeEndpoints	string	Certaines instances héritées ont à la fois AnyTunnel et SingleTunnel activés. Lors du passage d'AnyTunnel à SingleTunnel, les deux points de terminaison sont conservés. Ce champ stocke le point de terminaison supplémentaire.	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
ExpirationTime	string	L'heure d'expiration. L'heure est au format ISO 8601 en temps UTC. Les instances en paiement à l'usage n'ont pas d'heure d'expiration.	2021-02-03T13:06:06Z
InstanceId	string	L'identifiant de l'instance.	hgpostcn-cn-tl32s6cgw00b
InstanceName	string	Le nom de l'instance. Le nom doit comporter entre 2 et 64 caractères. Chaque lettre ou caractère chinois est compté comme un caractère.	test
InstanceType	string	Le type d'instance. Valeurs valides : Warehouse : Groupe de calcul. Follower : Instance secondaire en lecture seule. Standard : Standard. Serverless : Serverless. Shared : Partagé.	Standard
Memory	integer	La taille de la mémoire. Unité : Go.	128
InstanceOwner	string	Le propriétaire de l'instance.	12345678900000
InstanceStatus	string	L'état de l'instance. Valeurs valides : Creating : En cours de création. Running : En cours d'exécution. Suspended : Suspendu. Allocating : En cours de traitement.	Running
Version	string	La version de l'instance.	r1.3.37
SuspendReason	string	Le motif de la suspension. Valeurs valides : Indebet : Paiement en retard. Manual : Suspendu manuellement. Overdue : Abonnement expiré.	Manual
Tags	array<object>	Les balises de l'instance.
	object	Les détails de la balise.
Key	string	La clé de la balise.	tag
Value	string	La valeur de la balise.	value
LeaderInstanceId	string	L'identifiant de l'instance principale.	hgpostcn-cn-i7m2ncd6w002
EnableHiveAccess	string	Indique si l'accélération du lac de données est activée.	true
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-aekzuq7hpybze2i
ComputeNodeCount	integer	Le nombre de nœuds de calcul. Une configuration typique pour un nœud unique est de 16 cœurs et 32 Go de mémoire.	2
ZoneId	string	L'identifiant de la zone.	cn-hangzhou-h
ColdStorage	integer	La capacité de stockage à froid.\n\nUnité : Go. Le SSD équivaut au stockage à chaud, qui est également le stockage standard. Le HDD équivaut au stockage à froid.	800
AutoRenewal	string	Indique si le renouvellement automatique est activé. Valeurs valides : true : Le renouvellement automatique est activé. false : Le renouvellement automatique est désactivé.	true
GatewayCount	integer	Le nombre de nœuds de passerelle.	2
GatewayCpu	integer	Les ressources processeur de la passerelle.\n\nUnité : cœur.	4
GatewayMemory	integer	Les ressources mémoire de la passerelle.\n\nUnité : Go.	16
RegionId	string	L'identifiant de la région.	cn-hangzhou
ReplicaRole	string	Le rôle de l'instance de reprise après sinistre. Valeurs valides :\n- Active : l'instance de reprise après sinistre principale.\n- Passive : l'instance de reprise après sinistre de secours.\n- PreActive : l'instance de reprise après sinistre principale qui n'a pas atteint l'état souhaité.	Active
EnableServerless	boolean	Indique si ServerlessComputing est activé. Valeurs valides : true : Activé. false : Désactivé.	true
StorageType	string	Le type de stockage. Valeurs valides :\n* redundant : déploiement sur trois zones.\n* local : déploiement sur une seule zone.	redundant
EnableSSL	boolean	Indique si SSL est activé.	true
Success	boolean	Le résultat de la requête, qui indique si la requête a rencontré une exception. Cela n'est pas lié à la logique métier.	true
ErrorCode	string	Le code d'erreur.	null
ErrorMessage	string	Le message d'erreur.	null
HttpStatusCode	string	Le code d'état HTTP.	200

Exemples

JSON format

{
  "RequestId": "865A02C2-B374-5DD4-9B34-0CA15DA1AEBD",
  "Instance": {
    "InstanceChargeType": "PrePaid",
    "CommodityCode": "hologram_combo_public_cn",
    "Cpu": 32,
    "CreationTime": "2021-02-03T13:06:06Z",
    "Disk": "500",
    "Endpoints": [
      {
        "Endpoint": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80",
        "Type": "Internet",
        "Enabled": true,
        "VSwitchId": "vsw-bp1jqwp2ys6kp7tc9t983",
        "VpcId": "vpc-uf66jjber3hgvwhki3wna",
        "VpcInstanceId": "hgprecn-cn-uqm362o1b001-frontend-st",
        "AlternativeEndpoints": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80"
      }
    ],
    "ExpirationTime": "2021-02-03T13:06:06Z",
    "InstanceId": "hgpostcn-cn-tl32s6cgw00b",
    "InstanceName": "test",
    "InstanceType": "Standard",
    "Memory": 128,
    "InstanceOwner": "12345678900000",
    "InstanceStatus": "Running",
    "Version": "r1.3.37",
    "SuspendReason": "Manual",
    "Tags": [
      {
        "Key": "tag",
        "Value": "value"
      }
    ],
    "LeaderInstanceId": "hgpostcn-cn-i7m2ncd6w002",
    "EnableHiveAccess": "true",
    "ResourceGroupId": "rg-aekzuq7hpybze2i",
    "ComputeNodeCount": 2,
    "ZoneId": "cn-hangzhou-h",
    "ColdStorage": 800,
    "AutoRenewal": "true",
    "GatewayCount": 2,
    "GatewayCpu": 4,
    "GatewayMemory": 16,
    "RegionId": "cn-hangzhou",
    "ReplicaRole": "Active",
    "EnableServerless": true,
    "StorageType": "redundant",
    "EnableSSL": true
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.