Listagem de objetos monitorados em dimensões secundárias sob uma dimensão primária
Função
Essa API é usada para consultar os objetos monitorados em dimensões secundárias na dimensão principal dcs_instance_id.
URI
GET /v2/{project_id}/dims/monitored-objects/{instance_id}
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
project_id | Sim | String | Identificação do inquilino. |
instance_id | Sim | String | ID do objeto monitorado na dimensão principal, que é o ID da instância. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
dim_name | Sim | String | ID da dimensão principal, que pode ser dcs_instance_id. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
router | Array of strings | Rota da dimensão especificada. Se a dimensão for a dimensão principal, a matriz conterá o ID da dimensão principal. |
children | Array of DimChild objects | Dimensões secundárias sob a dimensão especificada. Esse parâmetro é válido somente quando a dimensão é dcs_instance_id.
|
instances | Array of InstancesMonitoredObject objects | Objetos monitorados da dimensão especificada. |
dcs_cluster_redis_node | Array of ClusterRedisNodeMonitoredObject objects | Objetos monitorados do servidor Redis. Esse parâmetro é válido para instâncias de Cluster de Proxy e Cluster do Redis. O nome do campo é o mesmo que o nome do objeto de dimensão secundária sob children. |
dcs_cluster_proxy_node | Array of ProxyNodeMonitoredObject objects | Objetos monitorados do Proxy. Esse parâmetro é válido somente para instâncias de cluster de proxy do Redis 3.0. O nome do campo é o mesmo que o nome do objeto de dimensão secundária sob children. |
dcs_cluster_proxy2_node | Array of Proxy2NodeMonitoredObject objects | Objetos monitorados do Proxy. Esse parâmetro é válido somente para instâncias de cluster de proxy do Redis 4.0 e 5.0. O nome do campo é o mesmo que o nome do objeto de dimensão secundária sob children. |
total | Integer | Número total de objetos monitorados na dimensão principal. |
Parâmetro | Tipo | Descrição |
|---|---|---|
dim_name | String | Nome da dimensão. Atualmente, as seguintes dimensões são suportadas: dcs_instance_id, dcs_cluster_redis_node, dcs_cluster_proxy_node, dcs_memcached_instance_id. |
dim_route | String | Rota da dimensão. Formato: Nome da dimensão,Nome da subdimensão. Por exemplo, se dim_name for dcs_cluster_redis_node, o valor de dim_route será dcs_instance_id,dcs_cluster_redis_node. |
Parâmetro | Tipo | Descrição |
|---|---|---|
dcs_instance_id | String | ID do objeto monitorado, que é o ID da instância. |
name | String | Nome do objeto monitorado, que é o nome da ocorrência. |
status | String | Status do objeto monitorado, que é o status da instância. |
Parâmetro | Tipo | Descrição |
|---|---|---|
dcs_instance_id | String | ID do objeto monitorado, que é o ID do nó. |
name | String | Nome do objeto monitorado, que é o endereço IP do nó. |
dcs_cluster_redis_node | String | ID do objeto monitorado na dimensão dcs_cluster_redis_node. |
status | String | Status do objeto monitorado, que é o status do nó. |
Parâmetro | Tipo | Descrição |
|---|---|---|
dcs_instance_id | String | ID do objeto monitorado, que é o ID do nó. |
name | String | Nome do objeto monitorado, que é o endereço IP do nó. |
dcs_cluster_proxy_node | String | ID do objeto monitorado na dimensão dcs_cluster_proxy_node. |
status | String | Status do objeto monitorado, que é o status do nó. |
Parâmetro | Tipo | Descrição |
|---|---|---|
dcs_instance_id | String | ID do objeto monitorado, que é o ID do nó. |
name | String | Nome do objeto monitorado, que é o endereço IP do nó. |
dcs_cluster_proxy2_node | String | ID do objeto monitorado na dimensão dcs_cluster_proxy2_node. |
status | String | Status do objeto monitorado, que é o status do nó. |
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 |
Exemplos de solicitações
GET https://{dcs_endpoint}/v2/{project_id}/dims/monitored-objects/{instance_id}?dim_name={dim_name} Exemplo de respostas
Código de estado: 200
Consultou com êxito os objetos monitorados na dimensão principal.
{
"router" : [ "dcs_instance_id" ],
"total" : 1,
"children" : [ {
"dim_name" : "dcs_cluster_redis_node",
"dim_route" : "dcs_instance_id,dcs_cluster_redis_node"
} ],
"instances" : [ {
"name" : "dcs-test001",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19"
} ],
"dcs_cluster_redis_node" : [ {
"name" : "(master)192.168.2.145",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "b1f4aa9e4dae50888e58c9caecdfc108"
}, {
"name" : "(replica)192.168.2.199",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "e0e10e489a73487147928167396474bc"
}, {
"name" : "(master)192.168.2.243",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "e797c3ba8bee782e25cdd4a90eb00517"
}, {
"name" : "(replica)192.168.2.164",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "d810fb44f9f7a359e000cf277a824c43"
}, {
"name" : "(master)192.168.2.95",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "f25c37a4654d50b07e629fc2adfba60f"
}, {
"name" : "(replica)192.168.2.51",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "da5149a20dc7caf35587e4d2433fe452"
} ]
} Códigos de status
Código de status | Descrição |
|---|---|
200 | Consultou com êxito os objetos monitorados na dimensão principal. |
500 | Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.
