Consulta de nós de instância em lotes
Função
Essa API é usada para consultar as informações do nó, o número de instâncias válidas e o número de nós de todas as instâncias em um projeto especificado. Nenhuma informação de nó será retornada quando as instâncias estiverem sendo criadas. Somente as instâncias do DCS Redis 4.0 e 5.0 podem ser consultadas.
Restrições
Somente as instâncias do DCS Redis 4.0 e 5.0 podem ser consultadas.
URI
GET /v2/{project_id}/instances-logical-nodes
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
offset |
Não |
Integer |
Deslocamento, que é a posição onde a consulta começa. O valor deve ser superior ou igual a 0. |
|
limit |
Não |
Integer |
Número de itens exibidos em cada página. O valor máximo é 1000*. Se esse parâmetro não for especificado, 10 itens serão exibidos em cada página por padrão. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
count |
Integer |
Número total de instâncias no resultado da consulta. |
|
instances |
Array of InstanceNodesInfoResp objects |
Lista de instância. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
instance_id |
String |
ID da instância. |
|
node_count |
Integer |
Número total de nós da instância atual. |
|
nodes |
Array of NodesInfoResp objects |
Detalhes do nó. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
logical_node_id |
String |
ID do nó lógico. |
|
name |
String |
Nome do nó. |
|
status |
String |
Status do nó. O valor pode ser:
Valores de enumeração:
|
|
az_code |
String |
Código AZ. |
|
node_role |
String |
Tipo de nó. O valor pode ser:
Valores de enumeração:
|
|
node_type |
String |
Função do nó. O valor pode ser:
Valores de enumeração:
|
|
node_ip |
String |
Endereço IP do nó. |
|
node_port |
String |
Porta de nó. |
|
node_id |
String |
ID do nó. |
|
priority_weight |
Integer |
Peso do nó. |
|
is_access |
Boolean |
Se o endereço IP do nó pode ser acessado diretamente. |
|
group_id |
String |
ID do partição. |
|
group_name |
String |
Nome do partição. |
|
is_remove_ip |
Boolean |
Se o endereço IP é removido do nome de domínio somente leitura. |
|
replication_id |
String |
ID da réplica. |
|
dimensions |
Array of InstanceReplicationDimensionsInfo objects |
Dimensão de métrica de monitoramento da réplica usada para chamar a API Cloud Eye para consultar métricas de monitoramento.
|
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
name |
String |
Monitorando o nome da dimensão. |
|
value |
String |
Valor da dimensão. |
Código de estado: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
|
error_code |
String |
Código de erro. Máximo: 9 |
|
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
|
error_code |
String |
Código de erro. Máximo: 9 |
|
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Exemplos de solicitações
GET https://{dcs_endpoint}/v2/{project_id}/instances-logical-nodes?offset={offset}&limit={limit}
Exemplo de respostas
Código de estado: 200
Informações do nó consultadas com sucesso.
{
"count" : 1,
"instances" : [ {
"instance_id" : "b4468cb1-4f75-4866-a49d-86959acc0c9c",
"node_count" : 2,
"nodes" : [ {
"logical_node_id" : "8f997eb512a92834bf5914be52ca8919",
"name" : "(replica)192.168.0.178",
"status" : "Active",
"az_code" : "xxxxxx",
"node_role" : "redis-server",
"node_type" : "slave",
"node_ip" : "192.168.0.178",
"node_port" : "6379",
"node_id" : "8a2c26c17f4d6516017f4d7b77940030",
"is_access" : true,
"group_id" : "ace962d1-7841-4e50-9313-c239fd75dee3",
"group_name" : "group-0",
"priority_weight" : 100,
"is_remove_ip" : false,
"replication_id" : "e40aa09e-03c2-4319-86eb-5ef4ca637544",
"dimensions" : [ {
"name" : "dcs_instance_id",
"value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
}, {
"name" : "dcs_cluster_redis_node",
"value" : "8263dc69629c5b2d840e9816fa9c6200"
} ]
} ]
} ]
}
Código de estado: 500
Erro de serviço interno.
{
"error_code" : "DCS.5000",
"error_msg" : "Internal service error."
}
Código de estado: 400
Pedido inválido.
{
"error_code" : "DCS.4800",
"error_msg" : "Invalid offset in the request."
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
Informações do nó consultadas com sucesso. |
|
500 |
Erro de serviço interno. |
|
400 |
Pedido inválido. |
Códigos de erro
Consulte Códigos de erro.