DescribeVpcs - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeVpcs	A operação a ser executada. Defina o valor como DescribeVpcs.
VpcId	String	Não	vpc-bp1b1xjllp3ve5yze****	O ID da VPC. Especifique até 20 IDs de VPC, separados por vírgula (,).
RegionId	String	Sim	cn-hangzhou	O ID da região da VPC. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
VpcName	String	Não	Vpc-1	O nome da VPC.
IsDefault	Boolean	Não	false	Defina se deve consultar a VPC padrão na região especificada. Valores válidos: true (padrão) false
DryRun	Boolean	Não	false	Indica se deve executar apenas uma simulação, sem realizar a solicitação real. Valores válidos: true: executa apenas a simulação. O sistema verifica problemas potenciais na solicitação, como valores de parâmetros ausentes, sintaxe incorreta e limites de serviço. Se a simulação falhar, o sistema retorna uma mensagem de erro. Caso contrário, retorna o código de erro `DryRunOperation`. false (padrão): executa a simulação e a solicitação real. Se a simulação for bem-sucedida, o sistema retorna um código de status HTTP 2xx e executa a operação.
ResourceGroupId	String	Não	rg-acfmxvfvazb4p****	O ID do grupo de recursos ao qual a VPC consultada pertence.
PageNumber	Integer	Não	1	O número da página a retornar. Valor padrão: 1.
PageSize	Integer	Não	10	O número de entradas a retornar por página. Valor máximo: 50. Valor padrão: 10.
VpcOwnerId	Long	Não	253460731706911258	O ID da conta Alibaba Cloud proprietária da VPC.
DhcpOptionsSetId	String	Não	dopt-o6w0df4epg9zo8isy****	O ID do conjunto de opções DHCP.
Tag.N.Key	String	Não	FinanceDept	A chave da tag N a adicionar ao recurso. Especifique no máximo 20 chaves de tag. A chave não pode ser uma string vazia. A chave da tag aceita até 128 caracteres. Não pode começar com `aliyun` ou `acs:`, nem conter `http://` ou `https://`.
Tag.N.Value	String	Não	FinanceJoshua	O valor da tag N a adicionar ao recurso. Especifique no máximo 20 valores de tag. O valor pode ser uma string vazia. O valor da tag aceita até 128 caracteres e não pode conter `http://` ou `https://`. Também não pode começar com `aliyun` ou `acs:`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	10	O número de entradas por página.
RequestId	String	C6532AA8-D0F7-497F-A8EE-094126D441F5	O ID da solicitação.
PageNumber	Integer	1	O número da página retornada.
TotalCount	Integer	2	O número total de entradas retornadas.
Vpcs	Array of Vpc		Os detalhes das VPCs.
Vpc
CreationTime	String	2021-04-18T15:02:37Z	A hora de criação da VPC.
Status	String	Available	O status da VPC. Valores válidos: Pending Available
VpcId	String	vpc-bp1qpo0kug3a20qqe****	O ID da VPC.
IsDefault	Boolean	false	Indica se a VPC é a padrão na região. Valores válidos: true false
OwnerId	Long	253460731706911258	O ID da conta Alibaba Cloud proprietária da VPC.
RegionId	String	cn-hangzhou	O ID da região da VPC.
VpcName	String	vpc1	O nome da VPC.
VRouterId	String	vrt-bp1jcg5cmxjbl9xgc****	O ID do vRouter.
DhcpOptionsSetStatus	String	Available	O status do conjunto de opções DHCP. Valores válidos: Available InUse Deleted Pending
CidrBlock	String	192.168.0.0/16	O bloco CIDR IPv4 da VPC.
Description	String	This is my VPC.	A descrição da VPC.
ResourceGroupId	String	rg-acfmxazb4ph****	O ID do grupo de recursos ao qual a VPC pertence.
DhcpOptionsSetId	String	dopt-o6w0df4epg9zo8isy****	O ID do conjunto de opções DHCP.
Ipv6CidrBlock	String	2408:XXXX:0:a600::/56	O bloco CIDR IPv6 da VPC.
CenStatus	String	Attached	O status da instância da Cloud Enterprise Network (CEN) à qual a VPC está associada. O valor Attached aparece apenas quando a VPC tem associação com uma instância CEN.
Tags	Array of Tag		As informações de tags da VPC.
Tag
Key	String	env	A chave da tag N.
Value	String	internal	O valor da tag N.
Ipv6CidrBlocks	Array of Ipv6CidrBlock		Os blocos CIDR IPv6 da VPC.
Ipv6CidrBlock
Ipv6Isp	String	BGP	O provedor de serviços de Internet (ISP) dos endereços IPv6 da VPC. Valores válidos: BGP ChinaMobile ChinaUnicom ChinaTelecom Nota Se houver permissão para usar largura de banda de ISP único, os valores válidos são ChinaTelecom, ChinaUnicom e ChinaMobile.
Ipv6CidrBlock	String	2408:XXXX:0:a600::/56	O bloco CIDR IPv6 da VPC.
VSwitchIds	Array of String	vsw-bp1nhbnpv2blyz8dl****	Os vSwitches na VPC. A consulta retorna até 300 vSwitches, priorizando os mais recentes. Para listar todos os vSwitches de uma VPC, chame a operação DescribeVSwitches.
SecondaryCidrBlocks	Array of String	192.168.20.0/24	O bloco CIDR secundário da VPC.
UserCidrs	Array of String	10.0.0.0/8	A lista de blocos CIDR do usuário.
NatGatewayIds	Array of String	nat-245xxxftwt45bg****	O ID do gateway NAT.
RouterTableIds	Array of String	vtb-bp1krxxzp0c29fmon****	O ID da tabela de rotas.

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

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 erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	O número de IDs de VPC excede o limite.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	O ID do grupo de recursos especificado não existe.
400	InvalidTagKey	The tag keys are not valid.	As chaves de tag são inválidas.
400	InvalidTagValue	The tag values are not valid.	Os valores de tag são inválidos.
400	InvalidAccount.NotFound	The account is invalid.	Falha na operação devido ao uso de uma conta inválida.
500	InternalError	The request processing has failed due to some unknown error.	Ocorreu um erro desconhecido durante o processamento da solicitação.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.