> ## Documentation Index
> Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt
> Use this file to discover all available pages before exploring further.
# Listar sub-redes
> Lista sub-redes pertencentes à conta do chamador. Filtre por vpc para restringir a uma VPC.
Requer a ação do IAM **`network:ListSubnets`**. Consulte [permissões de redes](/pt/networking/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
## OpenAPI
````yaml /pt/api-reference/specs/network.yaml get /v1/subnets
openapi: 3.0.3
info:
title: API da Basaltic Network
version: 1.0.0
description: >
A superfície da VPC — redes e sub-redes, interfaces, tabelas de rotas,
grupos de segurança, internet, NAT e gateways somente de saída e IPs
flutuantes.
As entradas de relacionamento usam um campo de referência: UUID, CRN ou um
nome exato quando a solicitação fornece seu escopo pai necessário.Sub-redes
e tabelas de rotas são escopo de VPC; interfaces são escopo de
sub-rede./subnet/, vpc//route-table/, e
vpc//subnet//interface/. Os nomes são imutáveis.
Campos de solicitação desconhecidos e parâmetros de lista são rejeitados.
Referências vazias fornecidas são inválidas e as pesquisas com falha nunca
retornam a outro tipo de referência.
contact:
name: Basaltic Support
email: ping@basaltic.sh
license:
name: Proprietary
url: https://basaltic.sh/terms
servers:
- url: https://network.{region}.basaltic.sh
description: Endpoint de API regional
variables:
region:
default: sa-saopaulo-1
description: Código de região
security:
- BearerAuth: []
paths:
/v1/subnets:
get:
tags:
- Networking
summary: Listar sub-redes
description: >-
Lista sub-redes pertencentes à conta do chamador. Filtre por vpc para
restringir a uma VPC.
operationId: listSubnets
parameters:
- name: name
in: query
description: Nome exato do recurso. Requer o filtro vpc.
schema:
type: string
- name: crn
in: query
description: >-
CRN exato, validado com o tipo de endpoint, região e conta do
chamador. CRNs estrangeiros ou incompatíveis válidos retornam um
resultado vazio; CRNs filhos malformados ou planos retornam 400. Os
filtros são conjuntivos.
schema:
type: string
- name: vpc
in: query
description: UUID, CRN ou nome exato da VPC na conta do chamador.
schema:
type: string
example: 5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 500
default: 50
example: 50
- name: marker
in: query
schema:
type: string
format: uuid
example: 7a1c9d3e-2f5b-4c8a-9e6d-3b2a1c4f5e8d
description: Token de continuação — o último id da página anterior.
responses:
'200':
description: Lista de sub-redes
content:
application/json:
schema:
$ref: '#/components/schemas/SubnetListResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- BearerAuth: []
components:
schemas:
SubnetListResponse:
type: object
required:
- subnets
- meta
properties:
subnets:
type: array
items:
$ref: '#/components/schemas/Subnet'
meta:
$ref: '#/components/schemas/PaginationMeta'
Subnet:
type: object
required:
- id
- crn
- vpc
- route_table
- name
- cidr_ipv4
- gateway_ipv4
- tags
- created_at
- updated_at
properties:
id:
type: string
format: uuid
readOnly: true
crn:
type: string
readOnly: true
example: crn:network:sa-saopaulo-1:my-account:vpc/prod/subnet/prod-web
vpc:
$ref: '#/components/schemas/Vpc'
route_table:
$ref: '#/components/schemas/RouteTableSummary'
name:
description: >-
Os nomes de recursos não devem começar com o prefixo literal crn: ou
ser UUIDs (formas canônicas, compactas, entre colchetes ou
urn:uuid:, em qualquer caso).
type: string
example: prod-web
description:
type: string
example: Public web-tier subnet
cidr_ipv4:
type: string
example: 10.0.1.0/24
gateway_ipv4:
type: string
example: 10.0.1.1
cidr_ipv6:
type: string
nullable: true
readOnly: true
description: >-
O IPv6 /64 de pilha dupla, se a sub-rede estiver habilitada para v6.
Sua presença (vs o v4 cidr_ipv4) é como um cliente diz as famílias
da sub-rede separadas.
example: 2a13:9500:1a6:100::/64
gateway_ipv6:
type: string
nullable: true
readOnly: true
example: 2a13:9500:1a6:100::1
tags:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
PaginationMeta:
type: object
properties:
total:
type: integer
description: Número total de itens
example: 150
limit:
type: integer
description: Número de itens por página
example: 20
marker:
type: string
description: >-
Cursor opaco para a próxima página. Passe-o de volta como o
parâmetro de consulta `marker`; trate-o como um token, não um valor
para analisar.
example: 550e8400-e29b-41d4-a716-446655440000
has_more:
type: boolean
description: Se há mais itens
example: true
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- request_id
properties:
code:
type: string
description: Código de erro identificando o tipo de erro
example: INVALID_INPUT
message:
type: string
description: Mensagem de erro legível pelo ser humano
example: Invalid request parameters
params:
type: object
additionalProperties: true
description: >-
Valores não sensíveis opcionais para interpolação de erros
localizados, codificados por código de erro. Nunca presente para
erros de servidor.
example:
instances: 2
pools: 0
request_id:
type: string
format: uuid
description: Solicitar ID para depuração
example: 550e8400-e29b-41d4-a716-446655440000
Vpc:
type: object
required:
- id
- crn
- name
- cidr_ipv4
- tags
- created_at
- updated_at
properties:
id:
type: string
format: uuid
readOnly: true
crn:
type: string
readOnly: true
description: Nome do recurso da nuvem (baseado em nome, região+escopo de conta).
example: crn:network:sa-saopaulo-1:my-account:vpc/prod
name:
type: string
description: >-
1-63 caracteres, minúsculo alfanumérico + hífen Os nomes de recursos
não devem começar com o prefixo literal crn: ou ser UUIDs (formas
canônicas, compactas, entre colchetes ou urn:uuid:, em qualquer
caso).
example: prod
description:
type: string
example: Production VPC for web and app tiers
cidr_ipv4:
type: string
description: >-
Bloco IPv4 CIDR dividido por sub-redes. Deve ser privado (RFC 1918):
dentro de 10.0.0.0/8, 172.16.0.0/12 ou 192.168.0.0/16. Imutável após
criar.
example: 10.0.0.0/16
cidr_ipv6:
type: string
nullable: true
readOnly: true
description: GUA regional associado ou prefixo ULA privado.
example: 2a13:9500:1a6:100::/60
tags:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
RouteTableSummary:
type: object
nullable: true
additionalProperties: false
description: >
Tabela de rotas usada por uma sub-rede, sem repetir sua VPC. Nulo quando
a pesquisa não proprietária não é mais resolvida, por exemplo, durante a
reassociação e exclusão simultâneas da tabela anterior. A exclusão de
uma tabela ainda associada a sub-redes é recusada.
required:
- id
- crn
- name
properties:
id:
type: string
format: uuid
readOnly: true
crn:
type: string
readOnly: true
example: >-
crn:network:sa-saopaulo-1:my-account:vpc/prod/route-table/prod-private-rt
name:
type: string
example: prod-private-rt
responses:
BadRequest:
description: Parâmetros de solicitação inválidos
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INVALID_INPUT
message: Invalid request parameters
request_id: 550e8400-e29b-41d4-a716-446655440000
Unauthorized:
description: Autenticação necessária ou token inválido
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UNAUTHORIZED
message: Authentication required
request_id: 550e8400-e29b-41d4-a716-446655440000
Forbidden:
description: Permissões insuficientes
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: ACCESS_DENIED
message: You don't have permission to perform this action
request_id: 550e8400-e29b-41d4-a716-446655440000
InternalServerError:
description: Erro interno do servidor
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INTERNAL_ERROR
message: An internal error occurred
request_id: 550e8400-e29b-41d4-a716-446655440000
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >+
Um token bearer OAuth 2.0, enviado como `Authorization: Bearer `.
Esta é a forma recomendada de autenticação.
Obtenha o token trocando o par de chaves de acesso de uma conta de
serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
com OAuth podem obter e renovar o token para você.
```
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
```
Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
também serve como credencial AWS SigV4 para o endpoint de objetos
compatível com S3, que aceita somente esse método de autenticação.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.