DescribeVpcAttribute - Virtual Private Cloud: Central de Documentação do Alibaba Cloud

Consulta a configuração de uma VPC especificada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

vpc:DescribeVpcAttribute

get

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

vpc:tag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VpcId	string	Sim	O ID da VPC.	vpc-bp18sth14qii3pnv****
RegionId	string	Sim	O ID da região da VPC. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run para esta solicitação. Valores válidos: true: envia uma solicitação de dry run sem consultar o status do recurso. O sistema verifica se o par de AccessKey é válido, se o usuário do Resource Access Management (RAM) tem a autorização necessária e se os parâmetros obrigatórios foram especificados. Se o dry run falhar, o erro correspondente será retornado. Se o dry run for bem-sucedido, o código de erro DryRunOperation será retornado. false (padrão): envia uma solicitação normal. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado e o status do recurso será consultado.	false
IsDefault	boolean	Não	Especifica se a VPC é a VPC padrão. Valores válidos: false (padrão): A VPC não é a VPC padrão. true: A VPC é a VPC padrão.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A hora de criação da VPC.
CreationTime	string	A hora em que a VPC foi criada. A hora é exibida em UTC e segue o padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ.	2021-10-16T07:31:09Z
Status	string	O status da VPC. Valores válidos: Available: A VPC está disponível. Pending: A VPC está sendo configurada.	Available
VpcId	string	O ID da VPC.	vpc-bp18sth14qii3pnvo****
IsDefault	boolean	Indica se a VPC é a VPC padrão. Valores válidos: true: A VPC é a VPC padrão. false (padrão): A VPC não é a VPC padrão.	false
ClassicLinkEnabled `deprecated`	boolean	Indica se o recurso ClassicLink está ativado. Valores válidos: true: O recurso ClassicLink está ativado. false (padrão): O recurso ClassicLink está desativado.	false
OwnerId	integer	O ID da conta à qual a VPC pertence.	28311773240248****
RegionId	string	O ID da região da VPC.	cn-hangzhou
VpcName	string	O nome da VPC.	doctest2
VRouterId	string	O ID do vRouter da VPC.	vrt-bp1jso6ng1at0ajsc****
DhcpOptionsSetStatus	string	O status do conjunto de opções DHCP. Valores válidos: Available: O conjunto de opções DHCP está disponível. InUse: O conjunto de opções DHCP está em uso. Deleted: O conjunto de opções DHCP foi excluído. Pending: O conjunto de opções DHCP está sendo configurado.	Available
CidrBlock	string	O bloco CIDR IPv4 da VPC.	192.168.0.0/16
RequestId	string	O ID da solicitação.	7486AE4A-129D-43DB-A714-2432C074BA04
Description	string	A descrição da VPC.	VPC
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxazbvgb4ph****
DhcpOptionsSetId	string	O ID do conjunto de opções DHCP.	dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlock	string	O bloco CIDR IPv6 da VPC.	2408:XXXX:0:a600::/56
VSwitchIds	object
VSwitchId	array	A lista de vSwitches na VPC.
	string	A lista de vSwitches na VPC.	{"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}
UserCidrs	object
UserCidr	array	Os blocos CIDR da rede do lado do usuário. Se vários blocos CIDR forem definidos, eles serão separados por vírgulas (,) na resposta. Há suporte para no máximo três blocos CIDR.
	string	Os blocos CIDR da rede do lado do usuário. Se vários blocos CIDR forem definidos, eles serão separados por vírgulas (,) na resposta. Há suporte para no máximo três blocos CIDR.	172.16.0.1/24
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	Os blocos CIDR IPv4 secundários da VPC.
	string	Os blocos CIDR IPv4 secundários da VPC.	192.168.0.0/16
AssociatedCens	object
AssociatedCen	array<object>	A lista de instâncias associadas da Cloud Enterprise Network (CEN). Se a VPC não estiver associada a uma instância CEN, este parâmetro não será retornado.
	object	O ID da conta à qual a instância CEN pertence.
CenOwnerId	integer	O ID da conta à qual a instância CEN pertence.	28311773240248****
CenId	string	O ID da instância CEN anexada à VPC.	cen-7qthudw0ll6jmc****
CenStatus	string	O status da VPC associada à instância CEN. Este parâmetro retorna Attached apenas quando a VPC está associada a uma instância CEN.	Attached
CloudResources	object
CloudResourceSetType	array<object>	A lista de recursos na VPC.
	object	A contagem de recursos na VPC.
ResourceCount	integer	A contagem de recursos na VPC.	1
ResourceType	string	O tipo de recurso na VPC. Valores válidos: VSwitch: vSwitch. VRouter: vRouter. RouteTable: Tabela de rotas.	VSwitch
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>	As informações do bloco CIDR IPv6 da VPC.
	object	As informações do bloco CIDR IPv6 da VPC.
Ipv6Isp	string	O tipo de ISP do bloco CIDR IPv6 da VPC. Valores válidos: BGP (padrão): Alibaba Cloud BGP IPv6. ChinaMobile: China Mobile (linha única). ChinaUnicom: China Unicom (linha única). ChinaTelecom: China Telecom (linha única). Nota Se você for adicionado à lista de permissões para largura de banda de linha única, poderá definir este parâmetro como ChinaTelecom, ChinaUnicom ou ChinaMobile.	BGP
Ipv6CidrBlock	string	O bloco CIDR IPv6 da VPC.	2408:XXXX:0:6a::/56
SupportIpv4Gateway	boolean	Indica se a VPC opera no modo de controle centralizado com o gateway IPv4. Valores válidos: true: A VPC opera no modo de controle centralizado com o gateway IPv4. O tráfego de Internet é gerenciado centralmente pelo gateway IPv4 (o gateway IPv4 é ativado após ser criado e as rotas são configuradas), ou a VPC é uma VPC apenas de rede privada (o gateway IPv4 é excluído no modo privado). false: Modo de acesso direto à Internet. Nota Para mais informações, consulte gateway IPv4.	true
Ipv4GatewayId	string	O ID da instância do gateway IPv4.	ipv4gw-5tsnc6s4ogsedtp3k****
Tags	object
Tag	array<object>	A lista de tags.
	object	A lista de tags.
Key	string	A chave da tag.	FinanceDept
Value	string	O valor da tag.	FinanceJoshua
AssociatedPropagationSources	object
AssociatedPropagationSources	array<object>	As fontes de propagação de rotas associadas à VPC.
	object
SourceType	string	O tipo da fonte de propagação. Valores válidos: CEN: Cloud Enterprise Network (CEN). VPN: Gateway VPN. TR: Transit router (TR). ECR: Express Connect Router (ECR).	CEN
SourceOwnerId	integer	O ID da conta à qual a fonte de propagação pertence.	153980532164****
SourceInstanceId	string	O ID da instância da fonte de propagação.	cen-dc4vwznpwbobrl****
Status	string	O status da associação. Valores válidos: Attaching: O recurso está sendo associado. Attached: O recurso está associado. Detaching: O recurso está sendo desassociado.	Attaching
RoutePropagated	boolean	Indica se as rotas são propagadas para a VPC.	true
EnabledIpv6	boolean	Indica se o IPv6 está ativado. Valores válidos: false : false. true : true.	false
DnsHostnameStatus	string	Indica se o recurso de nome de host DNS está ativado.	DISABLED

Exemplos

Resposta de sucesso

JSON formato

{
  "CreationTime": "2021-10-16T07:31:09Z",
  "Status": "Available",
  "VpcId": "vpc-bp18sth14qii3pnvo****",
  "IsDefault": false,
  "ClassicLinkEnabled": false,
  "OwnerId": 0,
  "RegionId": "cn-hangzhou",
  "VpcName": "doctest2",
  "VRouterId": "vrt-bp1jso6ng1at0ajsc****",
  "DhcpOptionsSetStatus": "Available",
  "CidrBlock": "192.168.0.0/16",
  "RequestId": "7486AE4A-129D-43DB-A714-2432C074BA04",
  "Description": "VPC",
  "ResourceGroupId": "rg-acfmxazbvgb4ph****",
  "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
  "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
  "VSwitchIds": {
    "VSwitchId": [
      "{\"VSwitchId\": [ \"vsw-bp14cagpfysr29feg****\" ]}"
    ]
  },
  "UserCidrs": {
    "UserCidr": [
      "172.16.0.1/24"
    ]
  },
  "SecondaryCidrBlocks": {
    "SecondaryCidrBlock": [
      "192.168.0.0/16"
    ]
  },
  "AssociatedCens": {
    "AssociatedCen": [
      {
        "CenOwnerId": 0,
        "CenId": "cen-7qthudw0ll6jmc****",
        "CenStatus": "Attached"
      }
    ]
  },
  "CloudResources": {
    "CloudResourceSetType": [
      {
        "ResourceCount": 1,
        "ResourceType": "VSwitch"
      }
    ]
  },
  "Ipv6CidrBlocks": {
    "Ipv6CidrBlock": [
      {
        "Ipv6Isp": "BGP",
        "Ipv6CidrBlock": "2408:XXXX:0:6a::/56"
      }
    ]
  },
  "SupportIpv4Gateway": true,
  "Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
  "Tags": {
    "Tag": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  },
  "AssociatedPropagationSources": {
    "AssociatedPropagationSources": [
      {
        "SourceType": "CEN",
        "SourceOwnerId": 0,
        "SourceInstanceId": "cen-dc4vwznpwbobrl****",
        "Status": "Attaching",
        "RoutePropagated": true
      }
    ]
  },
  "EnabledIpv6": false,
  "DnsHostnameStatus": "DISABLED"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	IncorrectVpcStatus	Current VPC status does not support this operation.
400	Forbidden.VpcNotFound	Specified VPC does not exist.
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidVpcId.NotFound	Specified VPC does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.