Obtenção de endereço de acesso ao cluster
Função
Essa API é usada para obter os endereços de acesso ao cluster por ID do cluster, incluindo o IP privado (VIP retornado por um cluster de HA) e o IP público.
O URL para gerenciamento de cluster está no formato https://Endpoint/uri. No URL, uri indica o caminho do recurso, ou seja, o caminho para o acesso à API.
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/openapi
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto. Para obter detalhes sobre como obter o valor, consulte Como obter parâmetros no URI da API. |
|
cluster_id |
Sim |
String |
ID do cluster. Para obter detalhes sobre como obter o valor, consulte Como obter parâmetros no URI da API. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
Content-Type |
Sim |
String |
Tipo de corpo da mensagem (formato). |
|
X-Auth-Token |
Sim |
String |
As solicitações para chamar uma API podem ser autenticadas usando um token ou AK/SK. Se a autenticação baseada em token for usada, esse parâmetro é obrigatório e deve ser definido como um token de usuário. Para obter detalhes, consulte Obtenção de um token de usuário. |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
metadata |
Metadata object |
Informações básicas sobre o objeto. Metadados são uma coleção de atributos. |
|
spec |
OpenAPISpec object |
Parâmetros para configurar o endereço para acessar o cluster |
|
status |
status object |
Informações de status |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
uid |
String |
ID único. |
|
name |
String |
Nome do recurso |
|
labels |
Map<String,String> |
Rótulos de recursos em pares chave-valor. Este é um campo reservado e não tem efeito. |
|
annotations |
Map<String,String> |
Anotações de recurso, no formato de pares chave-valor. |
|
updateTimestamp |
String |
Hora da atualização. |
|
creationTimestamp |
String |
Hora de criação. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
eip |
EipSpec object |
Detalhes do EIP |
|
IsDynamic |
Boolean |
Provisionamento dinâmico ou não |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
bandwidth |
bandwidth object |
Informações de largura de banda |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 200
O endereço de acesso do cluster foi obtido com êxito.
{
"metadata" : { },
"spec" : {
"spec" : {
"eip" : {
"bandwidth" : { }
},
"IsDynamic" : false
}
},
"status" : {
"privateEndpoint" : "https://192.168.3.238:5443",
"publicEndpoint" : ""
}
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
O endereço de acesso do cluster foi obtido com êxito. |
Códigos de erro
Consulte Códigos de erro.