DescribeRdsVpcs - PolarDB: Central de Documentação do Alibaba Cloud

Consulta uma lista de VPCs.

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

polardb:DescribeRdsVpcs

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. > Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis.	cn-hangzhou
ZoneId	string	Não	O ID da zona.	cn-hangzhou-k
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Vpcs	object	Uma lista de VPCs.
Vpc	array<object>	Os detalhes da VPC.
	array<object>	Os detalhes da VPC.
Status	string	The status of the VPC. Valid values: Pending: The VPC is being configured. Available: The VPC is available.	Available
VpcName	string	The name of the VPC.	fc-webide
VpcId	string	The ID of the VPC.	vpc-*************
IsDefault	boolean	Indicates whether the VPC is the default VPC.	true
CidrBlock	string	The CIDR block of the VPC.	10.21.0.0/16
RegionNo	string	The region ID.	cn-hangzhou
GmtCreate	string	The time when the VPC was created.	2025-08-28T02:25:41Z
AliUid	string	The ID of the Alibaba Cloud account.	1485293698******
VSwitchs	array<object>	The details of the vSwitches in the VPC.
	object	The vSwitch details.
Status	string	The status of the vSwitch. Available indicates that the vSwitch is available.	Available
VSwitchId	string	The ID of the vSwitch.	vsw-**********
IsDefault	boolean	Indicates whether the vSwitch is the default vSwitch. Valid values: true: The vSwitch is the default vSwitch. false: The vSwitch is not the default vSwitch.	true
CidrBlock	string	The vSwitch CIDR block.	192.168.7.0/24
GmtCreate	string	The time when the vSwitch was created.	2025-05-12 18:17:25
GmtModified	string	The time when the vSwitch was last modified.	2025-01-07T15:10:32+08:00
IzNo	string	The ID of the zone.	cn-hangzhou-k
VSwitchName	string	The name of the vSwitch.	test
GmtModified	string	The time when the VPC was last modified.	2025-04-30T09:41:14+08:00
Bid	string	The business type of the account. This parameter indicates whether the account is an Alibaba Finance Cloud account, an Alibaba Gov Cloud account, or a public cloud account.	26842
RequestId	string	O ID da solicitação.	B45E8D29-EA17-5141-AE09-F7A399760C9E

Exemplos

Resposta de sucesso

JSON formato

{
  "Vpcs": {
    "Vpc": [
      {
        "Status": "Available",
        "VpcName": "fc-webide",
        "VpcId": "vpc-*************",
        "IsDefault": true,
        "CidrBlock": "10.21.0.0/16",
        "RegionNo": "cn-hangzhou",
        "GmtCreate": "2025-08-28T02:25:41Z",
        "AliUid": "1485293698******",
        "VSwitchs": [
          {
            "Status": "Available",
            "VSwitchId": "vsw-**********",
            "IsDefault": true,
            "CidrBlock": "192.168.7.0/24",
            "GmtCreate": "2025-05-12 18:17:25",
            "GmtModified": "2025-01-07T15:10:32+08:00",
            "IzNo": "cn-hangzhou-k",
            "VSwitchName": "test"
          }
        ],
        "GmtModified": "2025-04-30T09:41:14+08:00",
        "Bid": "26842"
      }
    ]
  },
  "RequestId": "B45E8D29-EA17-5141-AE09-F7A399760C9E"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.