DescribeHaVips - Virtual Private Cloud - Centre de documentation Alibaba Cloud

Consulte les HaVip d'une région.

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.

vpc:DescribeHaVips

get

*HaVip

acs:vpc:{#regionId}:{#accountId}:havip/*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du HaVip. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
PageNumber	integer	Non	Le numéro de la page renvoyée. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur maximale : 50. Valeur par défaut : 10.	10
Filter	array<object>	Non	Les détails de la condition de filtrage.
	object	Non
Key	string	Non	Les clés de filtre. Vous pouvez spécifier jusqu'à cinq clés de filtre. Valeurs valides de N : 1 à 5. Les clés de filtre suivantes sont prises en charge : VpcId : identifiant du VPC VSwitchId : identifiant du vSwitch Status : état du HaVip HaVipId : identifiant du HaVip HaVipAddress : adresse IP du HaVip Vous pouvez spécifier plusieurs valeurs pour chaque clé de filtre. L'opérateur logique entre plusieurs valeurs est OU. Si une valeur correspond, la clé de filtre correspond. L'opérateur logique entre plusieurs clés de filtre est ET. Les HaVip ne peuvent être interrogés que si toutes les clés de filtre correspondent.	HaVipId
Value	array	Non	La valeur de la clé de filtre. Valeurs valides de N : 1 à 5.	havip-bp19o63nequs01i8d****
	string	Non	Les valeurs de filtre pour les clés de filtre. Vous pouvez spécifier plusieurs valeurs de filtre pour une seule clé. L'opérateur logique entre les valeurs de filtre est OU. Si une valeur de filtre correspond, la clé de filtre correspond.	Active
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel le HaVip appartient.	rg-bp67acfmxazb4ph****
Tags	array<object>	Non	La liste des balises.
	object	Non
Key	string	Non	La clé de la balise N à ajouter à la ressource. Vous pouvez spécifier jusqu'à 20 clés de balise. La clé de balise ne peut pas être une chaîne vide. La clé de balise peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	FinanceDept
Value	string	Non	La valeur de la balise N à ajouter à la ressource. Vous pouvez spécifier jusqu'à 20 valeurs de balise. La valeur de la balise peut être une chaîne vide. La valeur de la balise peut comporter jusqu'à 128 caractères et ne peut pas contenir `http://` ou `https://`. La valeur de la balise ne peut pas commencer par `aliyun` ou `acs:`.	FinanceJoshua

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le nombre d'entrées par page.
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	33E480C5-B46F-4CA5-B6FD-D77C746E86AB
PageNumber	integer	Le numéro de la page.	1
TotalCount	integer	Le nombre d'entrées renvoyées.	1
HaVips	object
HaVip	array<object>	Les détails du HaVip.
	array<object>
VpcId	string	The ID of the VPC to which the HaVip belongs.	vpc-bp1kcm36tevkpms97****
Status	string	The status of the HaVip. Valid values: Creating: being created. Available: available. Deleting: being deleted.	Available
HaVipId	string	The ID of the HaVip.	havip-bp149uyvut73dpld****
AssociatedInstanceType	string	The type of the instance associated with the HaVip. Valid values: EcsInstance: ECS instance. NetworkInterface: elastic network interface (ENI).	EcsInstance
CreateTime	string	The time when the HaVip was created.	2021-07-03T14:25:26Z
ChargeType	string	This parameter is invalid. The return value is empty.	none
RegionId	string	The region ID of the HaVip.	cn-hangzhou
VSwitchId	string	The ID of the vSwitch to which the HaVip belongs.	vsw-bp1pkt1fba8e824ez****
IpAddress	string	The private IP address of the HaVip.	192.168.24.5
Description	string	The description of the HaVip.	My HaVip
MasterInstanceId	string	The instance ID of the primary instance attached to the HaVip.	i-bp145q7glnuzdvz****
Name	string	The name of the HaVip.	test
AssociatedEipAddresses	object
associatedEipAddresse	array	The list of elastic IP addresses (EIPs) associated with the HaVip.
	string	The EIP associated with the HaVip.	121.12.XX.XX
AssociatedInstances	object
associatedInstance	array	The information about instances associated with the HaVip.
	string	The instance ID of the instance attached to the HaVip.	i-bp145q7glnuzdvzu21****
ResourceGroupId	string	The ID of the resource group to which the HaVip belongs.	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	The tags.
	object	The tags.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua

Exemples

JSON format

{
  "PageSize": 10,
  "RequestId": "33E480C5-B46F-4CA5-B6FD-D77C746E86AB",
  "PageNumber": 1,
  "TotalCount": 1,
  "HaVips": {
    "HaVip": [
      {
        "VpcId": "vpc-bp1kcm36tevkpms97****",
        "Status": "Available",
        "HaVipId": "havip-bp149uyvut73dpld****",
        "AssociatedInstanceType": "EcsInstance",
        "CreateTime": "2021-07-03T14:25:26Z",
        "ChargeType": "none",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-bp1pkt1fba8e824ez****",
        "IpAddress": "192.168.24.5",
        "Description": "My HaVip",
        "MasterInstanceId": "i-bp145q7glnuzdvz****",
        "Name": "test",
        "AssociatedEipAddresses": {
          "associatedEipAddresse": [
            "121.12.XX.XX"
          ]
        },
        "AssociatedInstances": {
          "associatedInstance": [
            "i-bp145q7glnuzdvzu21****"
          ]
        },
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	The error message returned because you do not have the permissions to manage the HAVIP. Go to the Quota Center page to acquire the permissions.
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
400	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

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

Notes de version

Consultez Notes de version pour la liste complète.