Skip to main content
GET
Obter uma região
Requer nenhuma ação do IAM. O acesso é decidido pelas próprias regras do endpoint, e não por uma política — consulte a descrição acima.

Parâmetros de caminho

code
string
obrigatório

Código de região imutável.

Pattern: ^[a-z][a-z0-9-]{0,31}$
Exemplo:

"sa-saopaulo-1"

Resposta

Região publicada

state
enum<string>
obrigatório

Ciclo de vida do catálogo, independente da integridade e da capacidade. Os códigos desativados nunca são reutilizados.

Opções disponíveis:
planned,
active,
restricted,
retiring,
retired
Exemplo:

"active"

accepting_new_resources
boolean
obrigatório

Verdadeiro apenas para regiões ativas. Os serviços de produto ainda aplicam elegibilidade, cotas, posicionamento e capacidade.

Exemplo:

true

crn
string
obrigatório

Identidade de região global de propriedade da plataforma, usando o código de região imutável.

Exemplo:

"crn:catalog::platform:region/sa-saopaulo-1"

code
string
obrigatório

Código de região exclusivo usado em chamadas de API e CRNs

Exemplo:

"sa-saopaulo-1"

name
string
obrigatório

Nome de região legível por humanos

Exemplo:

"São Paulo 1"

location
string
obrigatório

Localização geográfica da região

Exemplo:

"São Paulo, Brazil"

country_code
string
obrigatório

Código de país ISO 3166-1 alfa-2 (usado para exibir a bandeira na interface do usuário)

Required string length: 2
Exemplo:

"BR"

available
boolean
obrigatório

Alias de compatibilidade para accepting_new_resources; não um sinal de saúde ao vivo

Exemplo:

true

coming_soon
boolean
obrigatório

Sinal de compatibilidade que é verdadeiro somente quando o estado é planejado

Exemplo:

false