DescribeVpcs - - Centro de documentación de Alibaba Cloud

Consulta las redes privadas virtuales (VPC) en una región.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeVpcs	La operación que desea ejecutar. Establezca el valor en DescribeVpcs.
VpcId	String	No	vpc-bp1b1xjllp3ve5yze****	El ID de la VPC. Especifique hasta 20 ID de VPC. Separe varios ID con comas (,).
RegionId	String	Sí	cn-hangzhou	El ID de región de la VPC. Llame a la operación DescribeRegions para consultar la lista de regiones más reciente.
VpcName	String	No	Vpc-1	El nombre de la VPC.
IsDefault	Boolean	No	false	Indica si se debe consultar la VPC predeterminada en la región especificada. Valores válidos: true (predeterminado) false
DryRun	Boolean	No	false	Especifica si se realiza solo una prueba en seco, sin ejecutar la solicitud real. Valores válidos: true: realiza solo una prueba en seco. El sistema comprueba la solicitud en busca de problemas potenciales, como valores de parámetros faltantes, sintaxis de solicitud incorrecta y límites de servicio. Si la solicitud no supera la prueba en seco, se devuelve un mensaje de error. Si la solicitud supera la prueba en seco, se devuelve el código de error `DryRunOperation`. false (predeterminado): realiza una prueba en seco y ejecuta la solicitud real. Si la solicitud supera la prueba en seco, se devuelve un código de estado HTTP 2xx y se ejecuta la operación.
ResourceGroupId	String	No	rg-acfmxvfvazb4p****	El ID del resource group al que pertenece la VPC que se va a consultar.
PageNumber	Integer	No	1	El número de página que se va a devolver. Valor predeterminado: 1.
PageSize	Integer	No	10	El número de entradas que se devolverán en cada página. Valor máximo: 50. Valor predeterminado: 10.
VpcOwnerId	Long	No	253460731706911258	El ID de la cuenta de Alibaba Cloud a la que pertenece la VPC.
DhcpOptionsSetId	String	No	dopt-o6w0df4epg9zo8isy****	El ID del conjunto de opciones DHCP.
Tag.N.Key	String	No	FinanceDept	La clave de la etiqueta N que se agregará al recurso. Especifique un máximo de 20 claves de etiqueta. La clave de la etiqueta no puede ser una cadena vacía. La clave de la etiqueta puede tener una longitud máxima de 128 caracteres. No puede comenzar con `aliyun` ni con `acs:`, y no puede contener `http://` o `https://`.
Tag.N.Value	String	No	FinanceJoshua	El valor de la etiqueta N que se agregará al recurso. Especifique un máximo de 20 valores de etiqueta. El valor de la etiqueta puede ser una cadena vacía. El valor de la etiqueta puede tener una longitud máxima de 128 caracteres y no puede contener `http://` o `https://`. El valor de la etiqueta no puede comenzar con `aliyun` ni con `acs:`.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
PageSize	Integer	10	El número de entradas por página.
RequestId	String	C6532AA8-D0F7-497F-A8EE-094126D441F5	El ID de la solicitud.
PageNumber	Integer	1	El número de la página devuelta.
TotalCount	Integer	2	El número total de entradas devueltas.
Vpcs	Array of Vpc		Los detalles de las VPC.
Vpc
CreationTime	String	2021-04-18T15:02:37Z	La hora en que se creó la VPC.
Status	String	Available	El estado de la VPC. Valores válidos: Pending Available
VpcId	String	vpc-bp1qpo0kug3a20qqe****	El ID de la VPC.
IsDefault	Boolean	false	Indica si la VPC es la VPC predeterminada en la región. Valores válidos: true false
OwnerId	Long	253460731706911258	El ID de la cuenta de Alibaba Cloud a la que pertenece la VPC.
RegionId	String	cn-hangzhou	El ID de región de la VPC.
VpcName	String	vpc1	El nombre de la VPC.
VRouterId	String	vrt-bp1jcg5cmxjbl9xgc****	El ID del vRouter.
DhcpOptionsSetStatus	String	Available	El estado del conjunto de opciones DHCP. Valores válidos: Available InUse Deleted Pending
CidrBlock	String	192.168.0.0/16	El bloque CIDR IPv4 de la VPC.
Description	String	This is my VPC.	La descripción de la VPC.
ResourceGroupId	String	rg-acfmxazb4ph****	El ID del resource group al que pertenece la VPC.
DhcpOptionsSetId	String	dopt-o6w0df4epg9zo8isy****	El ID del conjunto de opciones DHCP.
Ipv6CidrBlock	String	2408:XXXX:0:a600::/56	El bloque CIDR IPv6 de la VPC.
CenStatus	String	Attached	El estado de la instancia de Cloud Enterprise Network (CEN) a la que está asociada la VPC. Attached se devuelve solo cuando la VPC está asociada con una instancia de CEN.
Tags	Array of Tag		La información de etiquetas de la VPC.
Tag
Key	String	env	La clave de la etiqueta N.
Value	String	internal	El valor de la etiqueta N.
Ipv6CidrBlocks	Array of Ipv6CidrBlock		Los bloques CIDR IPv6 de la VPC.
Ipv6CidrBlock
Ipv6Isp	String	BGP	El proveedor de servicios de Internet (ISP) para las direcciones IPv6 de la VPC. Valores válidos: BGP ChinaMobile ChinaUnicom ChinaTelecom Nota Si tiene permiso para usar ancho de banda de ISP único, los valores válidos son ChinaTelecom, ChinaUnicom y ChinaMobile.
Ipv6CidrBlock	String	2408:XXXX:0:a600::/56	El bloque CIDR IPv6 de la VPC.
VSwitchIds	Array of String	vsw-bp1nhbnpv2blyz8dl****	Los vSwitches en la VPC. Puede consultar hasta 300 vSwitches en la VPC. Se devuelve la información de los vSwitches más recientes. Para consultar la información de todos los vSwitches en una VPC, llame a la operación DescribeVSwitches.
SecondaryCidrBlocks	Array of String	192.168.20.0/24	El bloque CIDR secundario de la VPC.
UserCidrs	Array of String	10.0.0.0/8	La lista de bloques CIDR de usuario.
NatGatewayIds	Array of String	nat-245xxxftwt45bg****	El ID de la puerta de enlace NAT.
RouterTableIds	Array of String	vtb-bp1krxxzp0c29fmon****	El ID de la tabla de rutas.

Ejemplos

Solicitudes de ejemplo

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

Respuestas correctas de ejemplo

Formato XML

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>

Formato JSON

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****" ]
  } ]
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	El número de ID de VPC supera el límite.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	El ID del resource group no existe.
400	InvalidTagKey	The tag keys are not valid.	El índice de la etiqueta no es válido.
400	InvalidTagValue	The tag values are not valid.	El valor de la etiqueta no es válido.
400	InvalidAccount.NotFound	The account is invalid.	La operación falló porque se utilizó una cuenta no válida.
500	InternalError	The request processing has failed due to some unknown error.	Ocurrieron errores desconocidos.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.