DescribeVSwitches - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeVSwitches	L'opération à effectuer. Définissez la valeur sur DescribeVSwitches.
VpcId	String	No	vpc-25cdvfeq58pl****	L'ID du VPC auquel le vSwitch appartient. Remarque Spécifiez au moins l'un des paramètres RegionId et VpcId.
VSwitchId	String	No	vsw-23dscddcffvf3****	L'ID du vSwitch à interroger.
ZoneId	String	No	cn-hangzhou-d	L'ID de la zone à laquelle le vSwitch appartient. Appelez l'opération DescribeZones pour obtenir la liste des zones la plus récente.
RegionId	String	No	cn-hangzhou	L'ID de la région à laquelle le vSwitch appartient. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente. Remarque Spécifiez au moins l'un des paramètres RegionId et VpcId.
VSwitchName	String	No	vSwitch	Le nom du vSwitch. Le nom doit comporter entre 1 et 128 caractères. Il ne peut pas commencer par `http://` ou `https://`.
DryRun	Boolean	No	true	Indique s'il faut effectuer une vérification préliminaire (dry run) sans exécuter la requête réelle. Valeurs possibles : true : effectue uniquement une vérification préliminaire. Le système vérifie la requête pour détecter d'éventuels problèmes, notamment les valeurs de paramètre manquantes, la syntaxe de requête incorrecte et les limites de service. Si la requête échoue à la vérification préliminaire, un message d'erreur est renvoyé. Si la requête réussit la vérification préliminaire, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : effectue une vérification préliminaire puis exécute la requête réelle. Si la requête réussit la vérification préliminaire, un code d'état HTTP 2xx est renvoyé et l'opération est effectuée.
IsDefault	Boolean	No	true	Indique s'il faut interroger le vSwitch par défaut dans la région spécifiée. Valeurs possibles : true false Si vous ne spécifiez pas ce paramètre, le système interroge tous les vSwitch de la région spécifiée par défaut.
RouteTableId	String	No	vtb-bp145q7glnuzdvzu2****	L'ID de la table de routage.
ResourceGroupId	String	No	rg-bp67acfmxazb4ph****	L'ID du groupe de ressources auquel le vSwitch appartient.
PageNumber	Integer	No	1	Le numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	No	10	Le nombre d'entrées par page. Valeur maximale : 50. Valeur par défaut : 10.
VSwitchOwnerId	Long	No	2546073170691****	L'ID du compte Alibaba Cloud auquel le vSwitch appartient.
Tag.N.Key	String	No	FinanceDept	La clé du tag N à ajouter à la ressource. Vous pouvez spécifier au maximum 20 clés de tag. La clé de tag ne peut pas être une chaîne vide. La clé de tag peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.
Tag.N.Value	String	No	FinanceJoshua	La valeur du tag N à ajouter à la ressource. Vous pouvez spécifier au maximum 20 valeurs de tag. La valeur de tag peut être une chaîne vide. La valeur de tag peut comporter jusqu'à 128 caractères et ne peut pas contenir `http://` ou `https://`. La valeur de tag ne peut pas commencer par `aliyun` ou `acs:`.

Paramètres de réponse

Parameter	Type	Example	Description
PageSize	Integer	10	Le nombre d'entrées par page.
RequestId	String	9A572171-4E27-40D1-BD36-D26C9E71E29E	L'ID de la requête.
PageNumber	Integer	1	Le numéro de la page renvoyée.
TotalCount	Integer	1	Le nombre total d'entrées.
VSwitches	Array of VSwitch		Les détails concernant le vSwitch.
VSwitch
VpcId	String	vpc-257gcdcdq64****	L'ID du VPC auquel le vSwitch appartient.
Status	String	Available	L'état du vSwitch. Valeurs possibles : Pending Available
CreationTime	String	2022-01-18T12:43:57Z	L'heure de création du vSwitch.
IsDefault	Boolean	true	Indique si le vSwitch par défaut de la région où la pile est déployée est interrogé. Valeurs possibles : true false
AvailableIpAddressCount	Long	1	Le nombre d'adresses IP disponibles dans le vSwitch.
NetworkAclId	String	nacl-a2do9e413e0spzasx****	L'ID de la liste de contrôle d'accès réseau (ACL).
OwnerId	Long	253460731706911258	L'ID du compte Alibaba Cloud auquel le vSwitch appartient.
VSwitchId	String	vsw-25bcdxs7pv1****	L'ID du vSwitch.
CidrBlock	String	172.16.0.0/24	Le bloc CIDR IPv4 du vSwitch.
Description	String	VSwitchDescription	La description du vSwitch.
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	L'ID du groupe de ressources auquel le vSwitch appartient.
ZoneId	String	cn-hangzhou-d	L'ID de la zone à laquelle le vSwitch appartient.
Ipv6CidrBlock	String	2408:4002:10c4:4e03::/64	Le bloc CIDR IPv6 du vSwitch.
VSwitchName	String	vSwitch	Le nom du vSwitch.
ShareType	String	Shared	Indique si le vSwitch est partagé. Si aucune valeur n'est renvoyée, le vSwitch est un vSwitch standard. Si Shared est renvoyé, le vSwitch est un vSwitch partagé. Si Sharing est renvoyé, le vSwitch est en cours de partage.
EnabledIpv6	Boolean	true	Indique si IPv6 est activé pour le vSwitch. Si vous activez IPv6, vous devez configurer le bloc CIDR IPv6 du vSwitch. Valeurs possibles : true false
Tags	Array of Tag		Les informations de tag du vSwitch.
Tag
Key	String	department	La clé du tag N.
Value	String	dev	La valeur du tag N.
RouteTable	Object		Les informations concernant la table de routage.
RouteTableId	String	vrt-bp145q7glnuzdv****	L'ID de la table de routage associée au vSwitch.
RouteTableType	String	System	Le type de la table de routage associée au vSwitch. Valeurs possibles : System Custom

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeVSwitches
&VpcId=vpc-25cdvfeq58pl****
&VSwitchId=vsw-23dscddcffvf3****
&ZoneId=cn-hangzhou-d
&RegionId=cn-hangzhou
&VSwitchName=vSwitch
&DryRun=true
&IsDefault=true
&RouteTableId=vtb-bp145q7glnuzdvzu2****
&ResourceGroupId=rg-bp67acfmxazb4ph****
&PageNumber=1
&PageSize=10
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVSwitchesResponse>
    <PageSize>10</PageSize>
    <RequestId>9A572171-4E27-40D1-BD36-D26C9E71E29E</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VSwitches>
        <VpcId>vpc-257gcdcdq64****</VpcId>
        <Status>Available</Status>
        <CreationTime>2022-01-18T12:43:57Z</CreationTime>
        <IsDefault>true</IsDefault>
        <AvailableIpAddressCount>1</AvailableIpAddressCount>
        <NetworkAclId>nacl-a2do9e413e0spzasx****</NetworkAclId>
        <OwnerId>253460731706911260</OwnerId>
        <VSwitchId>vsw-25bcdxs7pv1****</VSwitchId>
        <CidrBlock>172.16.0.0/24</CidrBlock>
        <Description>VSwitchDescription</Description>
        <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
        <ZoneId>cn-hangzhou-d</ZoneId>
        <Ipv6CidrBlock>2408:4002:10c4:4e03::/64</Ipv6CidrBlock>
        <VSwitchName>vSwitch</VSwitchName>
        <ShareType>Shared</ShareType>
        <EnabledIpv6>true</EnabledIpv6>
        <Tags>
            <Key>department</Key>
            <Value>dev</Value>
        </Tags>
        <RouteTable>
            <RouteTableId>vrt-bp145q7glnuzdv****</RouteTableId>
            <RouteTableType>System</RouteTableType>
        </RouteTable>
    </VSwitches>
</DescribeVSwitchesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VSwitches" : [ {
    "VpcId" : "vpc-257gcdcdq64****",
    "Status" : "Available",
    "CreationTime" : "2022-01-18T12:43:57Z",
    "IsDefault" : true,
    "AvailableIpAddressCount" : 1,
    "NetworkAclId" : "nacl-a2do9e413e0spzasx****",
    "OwnerId" : 253460731706911260,
    "VSwitchId" : "vsw-25bcdxs7pv1****",
    "CidrBlock" : "172.16.0.0/24",
    "Description" : "VSwitchDescription",
    "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
    "ZoneId" : "cn-hangzhou-d",
    "Ipv6CidrBlock" : "2408:4002:10c4:4e03::/64",
    "VSwitchName" : "vSwitch",
    "ShareType" : "Shared",
    "EnabledIpv6" : true,
    "Tags" : [ {
      "Key" : "department",
      "Value" : "dev"
    } ],
    "RouteTable" : {
      "RouteTableId" : "vrt-bp145q7glnuzdv****",
      "RouteTableType" : "System"
    }
  } ]
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	Forbidden.VpcNotFound	Specified VPC can not found.	Le VPC spécifié n'existe pas.
400	InvalidTagKey	The tag keys are not valid.	L'index de tag n'est pas valide.
400	InvalidTagValue	The tag values are not valid.	La valeur de tag n'est pas valide.
404	InvalidVSwitchId.NotFound	VSwitch not exist.	Le vSwitch spécifié n'existe pas. Vérifiez si l'ID du vSwitch spécifié est valide.
404	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	Le nombre d'ID de VPC dépasse la limite.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.