DescribeNetworks - ENS: Central de Documentação do Alibaba Cloud

Chama DescribeNetworks para obter uma lista de redes.

Descrição da operação

Frequência de chamadas da API: 100 chamadas por segundo.
Frequência de chamadas por usuário: 10 chamadas por segundo.

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

ens:DescribeNetworks

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NetworkId	string	Não	O ID da rede.	n-5***
EnsRegionId	string	Não	O ID do nó ENS.	cn-beijing-telecom
NetworkName	string	Não	O nome da rede.	example
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
EnsRegionIds	array	Não	A matriz de IDs de zonas de borda ENS. Comprimento da matriz: 1–100.
	string	Não	O ID do nó ENS.	cn-chengdu-telecom-4
NetworkIds	array	Não	A matriz de IDs de rede. Comprimento da matriz: 1–100.
	string	Não	O ID da rede.	n-5***9iu

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de entradas.	3
PageSize	integer	O número de entradas por página na consulta atual.	2
PageNumber	integer	O número da página atual.	1
Networks	object
Network	array<object>	A lista de redes.
	array<object>	A lista de redes.
EnsRegionId	string	ENS edge zone ID.	cn-beijing
NetworkId	string	Network ID.	n-5***
NetworkName	string	Network name.	example
CidrBlock	string	IPv4 CIDR block of the network.	10.0.xx.xx/24
Status	string	Network status. Valid values: Pending: being configured. Available: active.	Available
Description	string	Description of the network.	exampleDescription
CreatedTime	string	Creation time as a UNIX timestamp in milliseconds.	1653620630000
VSwitchIds	object
VSwitchId	array	List of vSwitches in the network.
	string	List of vSwitches in the network.	vsw-bp1nhbnpv2blyz8dl****
RouterTableId	string	Route table ID.	rtb-5**
NetworkAclId	string	Network ACL ID.	nacl-a2do9e413e0spxscd****
RouteTableIds	object
RouteTableId	array	List of route table IDs.
	string	Route table ID.	rt-5*****pks
RouteTableId	string	Route table ID.	rt-5*****pks
GatewayRouteTableId	string	Gateway route table ID.	rt-5*****tbs
Tags	object
Tag	array<object>	Collection of tags.
	object	Collection of tags.
Value	string	Tag value.	TestValue
Key	string	Tag key.	TestKey
TagValue `deprecated`	string	Tag value.	TestValue
TagKey `deprecated`	string	Tag key.	TestKey
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	Information about secondary CIDR blocks.
	string	Secondary CIDR block.	172.XX.XX.0/12
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>
	object
Ipv6Isp	string		telecom
Ipv6CidrBlock	string		2408:XXXX:0:a600::/110
Type	string		system

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 3,
  "PageSize": 2,
  "PageNumber": 1,
  "Networks": {
    "Network": [
      {
        "EnsRegionId": "cn-beijing",
        "NetworkId": "n-5***",
        "NetworkName": "example",
        "CidrBlock": "10.0.xx.xx/24",
        "Status": "Available",
        "Description": "exampleDescription",
        "CreatedTime": "1653620630000",
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp1nhbnpv2blyz8dl****"
          ]
        },
        "RouterTableId": "rtb-5**",
        "NetworkAclId": "nacl-a2do9e413e0spxscd****",
        "RouteTableIds": {
          "RouteTableId": [
            "rt-5*****pks"
          ]
        },
        "RouteTableId": "rt-5*****pks",
        "GatewayRouteTableId": "rt-5*****tbs",
        "Tags": {
          "Tag": [
            {
              "Value": "TestValue",
              "Key": "TestKey",
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "SecondaryCidrBlocks": {
          "SecondaryCidrBlock": [
            "172.XX.XX.0/12"
          ]
        },
        "Ipv6CidrBlocks": {
          "Ipv6CidrBlock": [
            {
              "Ipv6Isp": "telecom",
              "Ipv6CidrBlock": "2408:XXXX:0:a600::/110",
              "Type": "system"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.