DescribeIpv6Gateways - Virtual Private Cloud - Centre de documentation Alibaba Cloud

Appelle l'API DescribeIpv6Gateways pour interroger les passerelles IPv6 créées dans une région spécifique.

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

get

Ipv6Gateway.

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

Ipv6Gateway.

acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région dans laquelle la passerelle IPv6 est déployée. Vous pouvez appeler l'opération DescribeRegions pour interroger l'identifiant de la région.	cn-huhehaote
Ipv6GatewayId	string	Non	L'identifiant de la passerelle IPv6.	ipv6gw-hp3rwmtmfhgis****
VpcId	string	Non	L'identifiant du cloud privé virtuel (VPC) auquel la passerelle IPv6 appartient.	vpc-123sedrfswd23****
Name	string	Non	Le nom de la passerelle IPv6. Le nom doit comporter de 2 à 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-). Il doit commencer par une lettre et ne peut pas commencer par `http://` ou `https://`.	ipv6GW
PageNumber	integer	Non	Le numéro de page.	1
PageSize	integer	Non	Le nombre d'entrées par page.	10
RegionId	string	Oui	L'identifiant de la région dans laquelle la passerelle IPv6 est déployée. Vous pouvez appeler l'opération DescribeRegions pour interroger l'identifiant de la région.	cn-huhehaote
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel la passerelle IPv6 appartient.	rg-bp67acfmxazb4ph****
Tags	array<object>	Non	Les informations sur les balises.
	object	Non	La liste des balises.
Key	string	Non	Les clés de balise des ressources. 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	Les valeurs de balise des ressources. Vous pouvez spécifier jusqu'à 20 valeurs de balise. La valeur de balise peut être une chaîne vide. La valeur de balise peut comporter jusqu'à 128 caractères et ne peut pas contenir `http://` ou `https://`. La valeur de balise ne peut pas commencer par `aliyun` ou `acs:`.	FinanceJoshua

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le message retourné.
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD
PageNumber	integer	Le numéro de page.	1
TotalCount	integer	Le nombre total d'entrées retournées.	2
Ipv6Gateways	object
Ipv6Gateway	array<object>	Les informations sur la passerelle IPv6.
	array<object>	Les informations détaillées sur une passerelle IPv6.
CreationTime	string	L'heure à laquelle la passerelle IPv6 a été créée.	2020-12-20T14:51:23Z
Status	string	L'état de la passerelle IPv6. Valeurs valides : Pending : en cours de configuration. Available : active.	Available
VpcId	string	L'identifiant du VPC associé à la passerelle IPv6.	vpc-123sedrfswd23****
Description	string	La description de la passerelle IPv6.	descriptionforIPv6GW
Ipv6GatewayId	string	L'identifiant de la passerelle IPv6.	ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****
ExpiredTime	string	L'heure d'expiration de la passerelle IPv6.	2021-12-20T14:51:23Z
BusinessStatus	string	L'état commercial de la passerelle IPv6. Valeurs valides : Normal : Normal. FinancialLocked : verrouillée en raison d'un retard de paiement. SecurityLocked : verrouillée pour des raisons de sécurité.	Normal
Name	string	Le nom de la passerelle IPv6.	ipv6GW
InstanceChargeType	string	Le mode de facturation de la passerelle IPv6. La valeur est PostPaid, ce qui indique un paiement à l'usage.	PostPaid
RegionId	string	L'identifiant de la région de la passerelle IPv6.	cn-huhehaote
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	La liste des balises.
	object	La liste des balises.
Key	string	La clé de balise.	FinanceDept
Value	string	La valeur de balise.	FinanceJoshua
OwnerId	integer	L'identifiant du compte Alibaba Cloud auquel appartient la passerelle IPv6. Important Cette valeur est de type Long. Une perte de précision peut se produire dans certains langages de programmation. Utilisez cette valeur avec précaution.	2546073170691****

Exemples

JSON format

{
  "PageSize": 10,
  "RequestId": "E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD",
  "PageNumber": 1,
  "TotalCount": 2,
  "Ipv6Gateways": {
    "Ipv6Gateway": [
      {
        "CreationTime": "2020-12-20T14:51:23Z",
        "Status": "Available",
        "VpcId": "vpc-123sedrfswd23****",
        "Description": "descriptionforIPv6GW",
        "Ipv6GatewayId": "ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****",
        "ExpiredTime": "2021-12-20T14:51:23Z",
        "BusinessStatus": "Normal",
        "Name": "ipv6GW",
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-huhehaote",
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "OwnerId": 0
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	Forbidden	User not authorized to operate on the specified resource.

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

Notes de version

Consultez Notes de version pour la liste complète.