GetInstance - - Centre de documentation Alibaba Cloud

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

Description de l'opération

Méthode

GET

URI

/openapi/ha3/instances/{instanceId}

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.

searchengine:GetInstance

get

*Instance.

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

Aucune

Syntaxe de la requête

GET /openapi/ha3/instances/{instanceId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	ha-cn-pl32rf0****

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Exemple de requête

GET /openapi/ha3/instances/ha3-cn-xxxxxx

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
result	object	Le résultat.
description	string	La description de l'instance.	test
resourceGroupId	string	L'identifiant du groupe de ressources.	rg-aekzjvw24****
expiredTime	string	L'heure d'expiration. Le format est AAAA-MM-JJ HH:mm:ss.S.	024-05-21 16:49:31.0
commodityCode	string	Le code de l'article.	opensearch_ha3post_public_cn
instanceId	string	L'identifiant de la ressource principale.	ha-cn-pl32rf0****
createTime	string	L'heure de création.	2022-06-17T02:01:26Z
lockMode	string	L'état de verrouillage.	Unlock
chargeType	string	La méthode de facturation.	POSYPAY
updateTime	string	L'heure de mise à jour. Le format est AAAA-MM-JJ HH:mm:ss.S.	024-05-21 16:49:31.0
inDebt	boolean	Indique si l'instance présente un retard de paiement.	false
status	string	La phase de l'état de l'instance. Valeurs valides : INIT : Initialisation. WAIT_CONFIG : Configuration en attente. CONFIG_UPDATING : Configuration en cours de prise en compte. READY : Normal.	INIT
tags	array<object>	Les balises.
	object	Les balises.
key	string	La clé de la balise.	opensearch
value	string	La valeur de la balise.	opensearch
edition	string	L'édition de l'instance. Valeurs valides : vector : Édition Vector Search. engine : Édition Recall Engine.	vector
userName	string	Le nom d'utilisateur.	admin
version	string	Le numéro de version du moteur.	ha3_3.10.0
bsVersion	string	La version BS.	bs_3.13.2
noQrs	boolean	Indique si l'instance est une instance à nœud unique.	false
newMode	boolean	Indique si la nouvelle version de la console est utilisée.	true
network	object	Les informations réseau de l'instance du moteur de recherche.
vSwitchId	string	L'identifiant du vSwitch.	vsw-bp11ldcf59q2n****
vpcId	string	L'identifiant du VPC.	vpc-wz9axk41d9vff****
endpoint	string	Le point de terminaison de la passerelle.	ha-cn-35t3r****.ha.aliyuncs.com
publicEndpoint	string	Le nom de domaine public.	ha-cn-35t3ni****.public.ha.aliyuncs.com
allow	string	La liste blanche pour le nom de domaine public.	127.0.0.1
spec	object	Les spécifications des nœuds.
qrsResource	object	Les spécifications du nœud de requête.
category	string	La famille d'instances. Valeurs valides : local_ssd : SSD local. cloud : Disque cloud.	local_ssd
cpu	integer	Le nombre de cœurs de processeur.	2
mem	integer	La taille de la mémoire. Unité : Go.	10
disk	integer	L'espace de stockage du nœud. Unité : Go.	100
nodeCount	integer	Le nombre de nœuds.	1
searchResource	object	Les spécifications du nœud de données.
category	string	La famille d'instances. Valeurs valides : local_ssd : SSD local. cloud : Disque cloud.	local_ssd
cpu	integer	Le nombre de cœurs de processeur.	2
mem	integer	La taille de la mémoire. Unité : Go.	10
disk	integer	L'espace de stockage du nœud. Unité : Go.	100
nodeCount	integer	Le nombre de nœuds.	1
zoneCount	integer	Le nombre de zones.	1
requestId	string	L'identifiant de la requête.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886

Exemples de réponse

Exemple de réponse réussie

{
    "result":
    {
        "inDebt": false,
        "lockMode": "Unlock",
        "trFreeUrl": "",
        "chargeType": "POSTPAY",
        "edition": "vector",
        "description": "ha-cn-vkl3rgrfc01",
        "updateTime": "2024-05-30 10:52:00.0",
        "userName": "admin",
        "version": "vector_service_1.2.2",
        "spec":
        {
            "qrsResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 8,
                "disk": 100,
                "nodeCount": 0
            },
            "searchResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 16,
                "disk": 100,
                "nodeCount": 1
            }
        },
        "network":
        {
            "vSwitchId": "vsw-bp16qw5mbrzx66lv4n0m2",
            "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
            "endpoint": "ha-cn-vkl3rgrfc01.ha.aliyuncs.com"
        },
        "tags":
        [
            {
                "value": "rg-acfmv2hk2jpsxia",
                "key": "acs:rm:rgId"
            }
        ],
        "noQrs": true,
        "instanceId": "ha-cn-vkl3rgrfc01",
        "createTime": "2024-05-30 10:50:33.0",
        "commodityCode": "opensearch_ha3post_public_cn",
        "resourceGroupId": "rg-acfmv2hk2jpsxia",
        "newMode": true,
        "status": "READY"
    },
    "requestId": "B916FBC8-DF19-1D12-A72F-61AFFDD871AD"
}

Exemple de réponse d'erreur

{
  "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
  "httpCode": 404,
  "code": "App.NotFound",
  "message": "App not found"
}

Exemples

JSON format

{
  "result": {
    "description": "test",
    "resourceGroupId": "rg-aekzjvw24****",
    "expiredTime": "024-05-21 16:49:31.0",
    "commodityCode": "opensearch_ha3post_public_cn",
    "instanceId": "ha-cn-pl32rf0****",
    "createTime": "2022-06-17T02:01:26Z",
    "lockMode": "Unlock",
    "chargeType": "POSYPAY",
    "updateTime": "024-05-21 16:49:31.0",
    "inDebt": false,
    "status": "INIT",
    "tags": [
      {
        "key": "opensearch",
        "value": "opensearch"
      }
    ],
    "edition": "vector",
    "userName": "admin",
    "version": "ha3_3.10.0",
    "bsVersion": "bs_3.13.2",
    "noQrs": false,
    "newMode": true,
    "network": {
      "vSwitchId": "vsw-bp11ldcf59q2n****\n",
      "vpcId": "vpc-wz9axk41d9vff****\n",
      "endpoint": "ha-cn-35t3r****.ha.aliyuncs.com\n",
      "publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com\n",
      "allow": "127.0.0.1\n"
    },
    "spec": {
      "qrsResource": {
        "category": "local_ssd",
        "cpu": 2,
        "mem": 10,
        "disk": 100,
        "nodeCount": 1
      },
      "searchResource": {
        "category": "local_ssd",
        "cpu": 2,
        "mem": 10,
        "disk": 100,
        "nodeCount": 1
      }
    },
    "zoneCount": 1
  },
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.