DescribeNetworks - ENS - Centro de documentación de Alibaba Cloud

Llama a DescribeNetworks para obtener una lista de redes.

Descripción de la operación

Frecuencia de llamadas a la API: 100 llamadas por segundo.
Frecuencia de llamadas por usuario: 10 llamadas por segundo.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ens:DescribeNetworks

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
NetworkId	string	No	El ID de la red.	n-5***
EnsRegionId	string	No	El ID del nodo ENS.	cn-beijing-telecom
NetworkName	string	No	El nombre de la red.	example
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página en una consulta paginada. Valor máximo: 50. Valor predeterminado: 10.	10
EnsRegionIds	array	No	La matriz de ID de zonas perimetrales de ENS. Longitud de la matriz: 1–100.
	string	No	El ID del nodo ENS.	cn-chengdu-telecom-4
NetworkIds	array	No	La matriz de ID de redes. Longitud de la matriz: 1–100.
	string	No	El ID de la red.	n-5***9iu

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	El número total de entradas.	3
PageSize	integer	El número de entradas por página en la consulta actual.	2
PageNumber	integer	El número de página actual.	1
Networks	object
Network	array<object>	La lista de redes.
	array<object>	La lista de redes.
EnsRegionId	string	El ID de la zona perimetral de ENS.	cn-beijing
NetworkId	string	El ID de la red.	n-5***
NetworkName	string	El nombre de la red.	example
CidrBlock	string	El bloque CIDR IPv4 de la red.	10.0.xx.xx/24
Status	string	El estado de la red. Valores válidos: Pending: en configuración. Available: activa.	Available
Description	string	La descripción de la red.	exampleDescription
CreatedTime	string	La hora de creación como marca de tiempo UNIX en milisegundos.	1653620630000
VSwitchIds	object
VSwitchId	array	La lista de vSwitches en la red.
	string	La lista de vSwitches en la red.	vsw-bp1nhbnpv2blyz8dl****
RouterTableId	string	El ID de la tabla de rutas.	rtb-5**
NetworkAclId	string	El ID de la ACL de red.	nacl-a2do9e413e0spxscd****
RouteTableIds	object
RouteTableId	array	La lista de ID de tablas de rutas.
	string	El ID de la tabla de rutas.	rt-5*****pks
RouteTableId	string	El ID de la tabla de rutas.	rt-5*****pks
GatewayRouteTableId	string	El ID de la tabla de rutas de la puerta de enlace.	rt-5*****tbs
Tags	object
Tag	array<object>	La colección de etiquetas.
	object	La colección de etiquetas.
Value	string	El valor de la etiqueta.	TestValue
Key	string	La clave de la etiqueta.	TestKey
TagValue `deprecated`	string	El valor de la etiqueta.	TestValue
TagKey `deprecated`	string	La clave de la etiqueta.	TestKey
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	La información sobre los bloques CIDR secundarios.
	string	El bloque CIDR secundario.	172.XX.XX.0/12
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>
	object
Ipv6Isp	string		telecom
Ipv6CidrBlock	string		2408:XXXX:0:a600::/110
Type	string		system

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.