Listagem de objetos monitorados em dimensões principais
Função
Essa API é usada para consultar os objetos monitorados nas dimensões principais dcs_instance_id e dcs_memcached_instance_id.
URI
GET /v2/{project_id}/dims/monitored-objects
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
Identificação do inquilino. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
dim_name |
Sim |
String |
ID da dimensão principal, que pode ser dcs_instance_id ou dcs_memcached_instance_id. |
|
offset |
Não |
Integer |
Deslocamento, que é a posição onde a consulta começa. O valor deve ser superior ou igual a 0. Padrão: 0 |
|
limit |
Não |
Integer |
Número de itens exibidos em cada página. Padrão: 10 |
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. |
|
total |
Integer - key |
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. |
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?dim_name={dim_name}
Exemplo de respostas
Código de estado: 200
Listou com êxito os objetos monitorados na dimensão principal.
{
"router" : [ "dcs_instance_id" ],
"total" : 3,
"children" : [ {
"dim_name" : "dcs_cluster_redis_node",
"dim_route" : "dcs_instance_id,dcs_cluster_redis_node"
}, {
"dim_name" : "dcs_cluster_proxy_node",
"dim_route" : "dcs_instance_id,dcs_cluster_proxy_node"
} ],
"instances" : [ {
"name" : "dcs-redis-single-node",
"status" : "RUNNING",
"dcs_instance_id" : "fe909c47-8990-44a0-9154-d0a1e95e78fe"
}, {
"name" : "dcs-redis-master-standby",
"status" : "RUNNING",
"dcs_instance_id" : "877e5ae3-482e-4c38-88a0-030a0fa6f399"
}, {
"name" : "dcs-proxy-cluster",
"status" : "RUNNING",
"dcs_instance_id" : "448ee851-1366-47f2-913a-e21032e690c4"
} ]
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
Listou com êxito os objetos monitorados na dimensão principal. |
|
500 |
Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.