DescribeVpcs - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeVpcs	Opération à effectuer. Définissez la valeur sur DescribeVpcs.
VpcId	String	Non	vpc-bp1b1xjllp3ve5yze****	ID du VPC. Vous pouvez spécifier jusqu'à 20 ID de VPC. Séparez les ID par des virgules (,).
RegionId	String	Oui	cn-hangzhou	ID de région du VPC. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
VpcName	String	Non	Vpc-1	Nom du VPC.
IsDefault	Boolean	Non	false	Indique s'il faut interroger le VPC par défaut dans la région spécifiée. Valeurs possibles : true (par défaut) false
DryRun	Boolean	Non	false	Indique s'il faut effectuer uniquement un test à blanc, sans exécuter la requête réelle. Valeurs possibles : true : effectue uniquement un test à blanc. Le système vérifie la requête pour détecter d'éventuels problèmes, notamment les valeurs de paramètre manquantes, la syntaxe incorrecte et les limites de service. Si la requête échoue au test à blanc, un message d'erreur est renvoyé. Si elle réussit, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : effectue un test à blanc puis exécute la requête réelle. Si le test à blanc réussit, un code d'état HTTP 2xx est renvoyé et l'opération est effectuée.
ResourceGroupId	String	Non	rg-acfmxvfvazb4p****	ID du groupe de ressources auquel appartient le VPC à interroger.
PageNumber	Integer	Non	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	Non	10	Nombre d'entrées par page. Valeur maximale : 50. Valeur par défaut : 10.
VpcOwnerId	Long	Non	253460731706911258	ID du compte Alibaba Cloud auquel appartient le VPC.
DhcpOptionsSetId	String	Non	dopt-o6w0df4epg9zo8isy****	ID de l'ensemble d'options DHCP.
Tag.N.Key	String	Non	FinanceDept	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	Non	FinanceJoshua	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://`. Elle ne peut pas commencer par `aliyun` ou `acs:`.

Paramètres de réponse

Paramètre	Type	Exemple	Description
PageSize	Integer	10	Nombre d'entrées par page.
RequestId	String	C6532AA8-D0F7-497F-A8EE-094126D441F5	ID de la requête.
PageNumber	Integer	1	Numéro de la page renvoyée.
TotalCount	Integer	2	Nombre total d'entrées renvoyées.
Vpcs	Array of Vpc		Détails des VPC.
Vpc
CreationTime	String	2021-04-18T15:02:37Z	Heure de création du VPC.
Status	String	Available	État du VPC. Valeurs possibles : Pending Available
VpcId	String	vpc-bp1qpo0kug3a20qqe****	ID du VPC.
IsDefault	Boolean	false	Indique si le VPC est le VPC par défaut dans la région. Valeurs possibles : true false
OwnerId	Long	253460731706911258	ID du compte Alibaba Cloud auquel appartient le VPC.
RegionId	String	cn-hangzhou	ID de région du VPC.
VpcName	String	vpc1	Nom du VPC.
VRouterId	String	vrt-bp1jcg5cmxjbl9xgc****	ID du vRouter.
DhcpOptionsSetStatus	String	Available	État de l'ensemble d'options DHCP. Valeurs possibles : Available InUse Deleted Pending
CidrBlock	String	192.168.0.0/16	Bloc CIDR IPv4 du VPC.
Description	String	This is my VPC.	Description du VPC.
ResourceGroupId	String	rg-acfmxazb4ph****	ID du groupe de ressources auquel appartient le VPC.
DhcpOptionsSetId	String	dopt-o6w0df4epg9zo8isy****	ID de l'ensemble d'options DHCP.
Ipv6CidrBlock	String	2408:XXXX:0:a600::/56	Bloc CIDR IPv6 du VPC.
CenStatus	String	Attached	État de l'instance Cloud Enterprise Network (CEN) à laquelle le VPC est associé. La valeur Attached est renvoyée uniquement lorsque le VPC est associé à une instance CEN.
Tags	Array of Tag		Informations de tag du VPC.
Tag
Key	String	env	Clé du tag N.
Value	String	internal	Valeur du tag N.
Ipv6CidrBlocks	Array of Ipv6CidrBlock		Blocs CIDR IPv6 du VPC.
Ipv6CidrBlock
Ipv6Isp	String	BGP	Fournisseur de services Internet (ISP) pour les adresses IPv6 du VPC. Valeurs possibles : BGP ChinaMobile ChinaUnicom ChinaTelecom Remarque Si vous êtes autorisé à utiliser la bande passante mono-ISP, les valeurs valides sont ChinaTelecom, ChinaUnicom et ChinaMobile.
Ipv6CidrBlock	String	2408:XXXX:0:a600::/56	Bloc CIDR IPv6 du VPC.
VSwitchIds	Array of String	vsw-bp1nhbnpv2blyz8dl****	vSwitches du VPC. Vous pouvez interroger jusqu'à 300 vSwitches dans le VPC. Les informations sur les vSwitches les plus récents sont renvoyées. Pour interroger tous les vSwitches d'un VPC, appelez l'opération DescribeVSwitches.
SecondaryCidrBlocks	Array of String	192.168.20.0/24	Bloc CIDR secondaire du VPC.
UserCidrs	Array of String	10.0.0.0/8	Liste des blocs CIDR utilisateur.
NatGatewayIds	Array of String	nat-245xxxftwt45bg****	ID de la passerelle NAT.
RouterTableIds	Array of String	vtb-bp1krxxzp0c29fmon****	ID de la table de routage.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeVpcs
&VpcId=vpc-bp1b1xjllp3ve5yze****
&RegionId=cn-hangzhou
&VpcName=Vpc-1
&IsDefault=false
&DryRun=false
&ResourceGroupId=rg-acfmxvfvazb4p****
&PageNumber=1
&PageSize=10
&VpcOwnerId=253460731706911258
&DhcpOptionsSetId=dopt-o6w0df4epg9zo8isy****
&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

<DescribeVpcsResponse>
    <PageSize>10</PageSize>
    <RequestId>C6532AA8-D0F7-497F-A8EE-094126D441F5</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <Vpcs>
        <CreationTime>2021-04-18T15:02:37Z</CreationTime>
        <Status>Available</Status>
        <VpcId>vpc-bp1qpo0kug3a20qqe****</VpcId>
        <IsDefault>false</IsDefault>
        <OwnerId>253460731706911260</OwnerId>
        <RegionId>cn-hangzhou</RegionId>
        <VpcName>vpc1</VpcName>
        <VRouterId>vrt-bp1jcg5cmxjbl9xgc****</VRouterId>
        <DhcpOptionsSetStatus>Available</DhcpOptionsSetStatus>
        <CidrBlock>192.168.0.0/16</CidrBlock>
        <Description>This is my VPC.</Description>
        <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
        <DhcpOptionsSetId>dopt-o6w0df4epg9zo8isy****</DhcpOptionsSetId>
        <Ipv6CidrBlock>2408:XXXX:0:a600::/56</Ipv6CidrBlock>
        <CenStatus>Attached</CenStatus>
        <Tags>
            <Key>env</Key>
            <Value>internal</Value>
        </Tags>
        <Ipv6CidrBlocks>
            <Ipv6Isp>BGP</Ipv6Isp>
            <Ipv6CidrBlock>2408:XXXX:0:a600::/56</Ipv6CidrBlock>
        </Ipv6CidrBlocks>
        <VSwitchIds>vsw-bp1nhbnpv2blyz8dl****</VSwitchIds>
        <SecondaryCidrBlocks>192.168.20.0/24</SecondaryCidrBlocks>
        <UserCidrs>10.0.0.0/8</UserCidrs>
        <NatGatewayIds>nat-245xxxftwt45bg****</NatGatewayIds>
        <RouterTableIds>vtb-bp1krxxzp0c29fmon****</RouterTableIds>
    </Vpcs>
</DescribeVpcsResponse>

JSON format

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

{
  "PageSize" : 10,
  "RequestId" : "C6532AA8-D0F7-497F-A8EE-094126D441F5",
  "PageNumber" : 1,
  "TotalCount" : 2,
  "Vpcs" : [ {
    "CreationTime" : "2021-04-18T15:02:37Z",
    "Status" : "Available",
    "VpcId" : "vpc-bp1qpo0kug3a20qqe****",
    "IsDefault" : false,
    "OwnerId" : 253460731706911260,
    "RegionId" : "cn-hangzhou",
    "VpcName" : "vpc1",
    "VRouterId" : "vrt-bp1jcg5cmxjbl9xgc****",
    "DhcpOptionsSetStatus" : "Available",
    "CidrBlock" : "192.168.0.0/16",
    "Description" : "This is my VPC.",
    "ResourceGroupId" : "rg-acfmxazb4ph****",
    "DhcpOptionsSetId" : "dopt-o6w0df4epg9zo8isy****",
    "Ipv6CidrBlock" : "2408:XXXX:0:a600::/56",
    "CenStatus" : "Attached",
    "Tags" : [ {
      "Key" : "env",
      "Value" : "internal"
    } ],
    "Ipv6CidrBlocks" : [ {
      "Ipv6Isp" : "BGP",
      "Ipv6CidrBlock" : "2408:XXXX:0:a600::/56"
    } ],
    "VSwitchIds" : [ "vsw-bp1nhbnpv2blyz8dl****" ],
    "SecondaryCidrBlocks" : [ "192.168.20.0/24" ],
    "UserCidrs" : [ "10.0.0.0/8" ],
    "NatGatewayIds" : [ "nat-245xxxftwt45bg****" ],
    "RouterTableIds" : [ "vtb-bp1krxxzp0c29fmon****" ]
  } ]
}

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	Description
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	Le nombre d'ID de VPC dépasse la limite.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	L'ID du groupe de ressources 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.
400	InvalidAccount.NotFound	The account is invalid.	L'opération a échoué car un compte non valide est utilisé.
500	InternalError	The request processing has failed due to some unknown error.	Des erreurs inconnues se sont produites.

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