Consulta de subredes
Función
Esta API se utiliza para consultar todas las subredes accesibles para el tenant que envía la solicitud. Se puede devolver un máximo de 2000 registros para cada operación de consulta. Si el número de registros es superior a 2000, se devolverá el marcador de paginación. Para obtener más información, consulte la sección Paginación.
URI
GET /v2.0/subnets
Por ejemplo:
GET https://{Endpoint}/v2.0/subnets?name={subnet_name}&ip_version={ip_version}&network_id={network_id}&cidr={subnet_cidr_address}&gateway_ip={subnet_gateway}&tenant_id={tenant_id}&enable_dhcp={is_enable_dhcp}
Ejemplo de consulta de redes por página
GET https://{Endpoint}/v2.0/subnets?limit=2&marker=011fc878-5521-4654-a1ad-f5b0b5820302&page_reverse=False
Tabla 1 describe los parámetros.
Nombre |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
No |
String |
Especifica que el ID se utiliza como condición de filtrado. |
name |
No |
String |
Especifica que el nombre de subred se utiliza como condición de filtrado. |
enable_dhcp |
No |
Boolean |
Especifica si DHCP está habilitado para la subred se utiliza como condición de filtrado. El valor puede ser true o false. |
cidr |
No |
String |
Especifica que el bloque CIDR se utiliza como la condición de filtrado. |
network_id |
No |
String |
Especifica que el ID de red se utiliza como la condición de filtrado. |
ip_version |
No |
String |
Especifica que se utiliza la versión de la dirección IP como la condición de filtrado. |
gateway_ip |
No |
String |
Especifica que la dirección IP del gateway se utiliza como la condición de filtrado. |
tenant_id |
No |
String |
Especifica que el ID del proyecto se utiliza como la condición de filtrado. |
marker |
No |
String |
Especifica un ID de recurso para la consulta de paginación, que indica que la consulta comienza en el siguiente registro del ID de recurso especificado. Este parámetro puede funcionar junto con el parámetro limit.
|
limit |
No |
Integer |
Especifica el número de registros que se devolverán en cada página. El valor es de 0 a intmax (2^31-1). limit se puede utilizar junto con marker. Para obtener más información, consulte la descripción de parámetros de marker. |
Mensaje de solicitud
No hay
Ejemplo de la solicitud
[Ejemplo 1]
GET https://{Endpoint}/v2.0/subnets?limit=1
[Ejemplo 2]
GET https://{Endpoint}/v2.0/subnets?id=011fc878-5521-4654-a1ad-f5b0b5820322
Mensaje de la respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
subnets |
Array of subnet objects |
Especifica la lista de subred. Para más detalles, consulte Tabla 3. |
subnets_links |
Array of subnets_link objects |
Especifica la información de paginación. Para más detalles, consulte Tabla 6. Solo cuando se utiliza limit para filtrar y el número de recursos excede el valor de limit o 2000 (valor predeterminado de limit), se devolverá el valor next para rel y un enlace para href. |
Atributo |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de subred. Este parámetro no es obligatorio cuando consulta las subredes. |
name |
String |
Especifica el nombre de la subred. |
ip_version |
Integer |
Especifica la versión de la dirección IP. Versiones compatibles: IPv4 |
ipv6_address_mode |
String |
Especifica el modo de direccionamiento IPv6. Solo se admite dhcpv6-stateful. |
ipv6_ra_mode |
String |
Especifica el modo de difusión de ruta IPv6. Solo se admite dhcpv6-stateful. |
network_id |
String |
Especifica el ID de la red a la que pertenece la subred. |
cidr |
String |
Especifica el formato de CIDR. Sólo se admiten las direcciones IPv4 de los rangos 10.0.0.0/8, 172.16.0.0/12 y 192.168.0.0/16. La máscara de subred no puede ser mayor que 28. Este parámetro no se puede establecer si el valor de ip_version es 6. |
gateway_ip |
String |
La dirección IP del gateway no puede entrar en conflicto con las direcciones IP configuradas para allocation_pools. Este atributo no se puede modificar. |
allocation_pools |
Array of allocation_pool objects |
Especifica los grupos de direcciones IP disponibles. Para más detalles, consulte Tabla 4. Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] Las tres últimas y las primeras direcciones IP en cada subred son las reservadas por el sistema. Por ejemplo, en la subred IPv4 192.168.1.0/24, el sistema reserva las direcciones IP 192.168.1.0, 192.168.1.253, 192.168.1.254, y 192.168.1.255. [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] En la subred IPv6 2001:db8:a583:9::/64, direcciones IP 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, y 2001:db8:a583:9:ffff:ffff:ffff:ffff están reservados por el sistema. De forma predeterminada, las direcciones IP reservadas por el sistema no están en el grupo de direcciones IP especificado por allocation_pool. Al actualizar un grupo de direcciones IP, el valor allocation_pool no puede contener ni gateway ni direcciones IP de difusión. |
dns_nameservers |
Array of strings |
Especifica la dirección del servidor DNS. Ejemplo: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] |
host_routes |
Array of host_route objects |
Especifica las rutas de VM estáticas. Para obtener más información, véase Tabla 5. No se admiten las rutas estáticas y la información introducida se ignorará. |
tenant_id |
String |
Especifica el ID del proyecto. |
enable_dhcp |
Boolean |
Especifica si se va a habilitar la función de DHCP. El valor false indica que la función DHCP no está habilitada. El valor solo puede ser true. |
project_id |
String |
Especifica el ID del proyecto. Para obtener más información sobre cómo obtener un ID de proyecto, consulte Obtención de un ID de proyecto. |
created_at |
String |
Especifica la hora (UTC) en la que se crea la subred. Formato: aaaa-MM-ddTHH:mm:ss |
updated_at |
String |
Especifica la hora (UTC) cuando se actualiza la subred. Formato: aaaa-MM-ddTHH:mm:ss |
Parámetro |
Tipo |
Descripción |
---|---|---|
start |
String |
Especifica la dirección IP inicial de un grupo de red. |
end |
String |
Especifica la dirección IP final de un grupo de red. |
Ejemplo de la respuesta
[Ejemplo 1]
{ "subnets": [ { "name": "kesmdemeet", "cidr": "172.16.236.0/24", "id": "011fc878-5521-4654-a1ad-f5b0b5820302", "enable_dhcp": true, "network_id": "48efad0c-079d-4cc8-ace0-dce35d584124", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "dns_nameservers": [], "allocation_pools": [ { "start": "172.16.236.2", "end": "172.16.236.251" } ], "host_routes": [], "ip_version": 4, "gateway_ip": "172.16.236.1", "created_at": "2018-03-26T08:23:43", "updated_at": "2018-03-26T08:23:44" } ], "subnets_links": [ { "rel": "next", "href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=011fc878-5521-4654-a1ad-f5b0b5820302" }, { "rel": "previous", "href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=011fc878-5521-4654-a1ad-f5b0b5820302&page_reverse=True" } ] }
{ "subnets": [ { "id": "011fc878-5521-4654-a1ad-f5b0b5820322", "name": "elb_alpha_vpc0_subnet0_172_16_0_0_24", "tenant_id": "0c55e5b2b100d5202ff6c01a2fac4580", "network_id": "3053b502-11b2-4599-bcf4-d9d06b6118b2", "ip_version": 6, "cidr": "2001:db8:a583:a0::/64", "subnetpool_id": "cb03d100-8687-4c0a-9441-ea568dcae47d", "allocation_pools": [{ "start": "2001:db8:a583:a0::2", "end": "2001:db8:a583:a0:ffff:ffff:ffff:fffc" }], "gateway_ip": "2001:db8:a583:a0::1", "enable_dhcp": true, "ipv6_ra_mode": "dhcpv6-stateful", "ipv6_address_mode": "dhcpv6-stateful", "description": "", "dns_nameservers": [], "host_routes": [], "project_id": "0c55e5b2b100d5202ff6c01a2fac4580", "created_at": "2021-07-01T07:59:28", "updated_at": "2021-07-01T07:59:28" } ], "subnets_links": [ { "rel": "previous", "href": "https://{Endpoint}/v2.0/subnets?limit=1&id=011fc878-5521-4654-a1ad-f5b0b5820322&marker=011fc878-5521-4654-a1ad-f5b0b5820302&page_reverse=True" } ] }
Código de estado
Consulte Códigos de estado.
Código de error
Consulte Códigos de error.