DescribeDBInstancePerformance - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Consulta os dados de desempenho de uma instância do MongoDB.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dds:DescribeDBInstancePerformance

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

dds:ResourceTag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Nota NodeId é obrigatório ao especificar o ID de uma instância de cluster fragmentado.	dds-bp2635****
NodeId	string	Não	O ID de um nó mongos ou shard na instância de cluster fragmentado. Este parâmetro permite consultar o desempenho de um único nó. Nota Disponível apenas quando DBInstanceId está definido como o ID de uma instância de cluster fragmentado.	d-bp2287****
Key	string	Sim	As métricas de desempenho. Para mais informações, consulte Métricas. Nota Para especificar várias métricas, separe-as com vírgulas (,).	CpuUsage
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique o horário no formato aaaa-MM-ddTHH:mmZ. O horário deve estar em UTC.	2022-06-13T10:58Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. O horário de término deve ser posterior ao horário de início. Especifique o horário no formato aaaa-MM-ddTHH:mmZ. O horário deve estar em UTC.	2022-06-13T11:58Z
RoleId	string	Não	O ID da função de um nó em uma instância autônoma ou de conjunto de réplicas. Para consultar o ID da função, chame a operação DescribeReplicaSetRole. Nota Disponível apenas quando DBInstanceId está definido como o ID de uma instância autônoma ou de conjunto de réplicas.	6025****
Interval	string	Não	A granularidade dos dados das métricas de desempenho em segundos. Valores válidos: 5, 30, 60, 600, 1800, 3600 e 86400.	60
ReplicaSetRole	string	Não	A função de um nó em uma instância autônoma ou de conjunto de réplicas. Valores válidos: Primary: O nó primário. Secondary: Um nó secundário. Nota Disponível apenas quando DBInstanceId está definido como o ID de uma instância autônoma ou de conjunto de réplicas. Se DBInstanceId estiver definido como o ID de uma instância autônoma, este parâmetro suportará apenas o valor Primary.	Primary
SearchId	string	Não	O ID do nó Search. Nota Disponível apenas após a ativação do recurso Search para a instância.	dds-2zec12675c9e****-search

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PerformanceKeys	object
PerformanceKey	array<object>	A lista de métricas de desempenho.
	array<object>
Key	string	The performance metric.	CpuUsage
Unit	string	The unit of the performance metric.	%
ValueFormat	string	The format of the performance metric values. If a performance metric contains multiple fields, the fields are separated by ampersands (&). For example, if you query the disk space usage, the returned ValueFormat is ins_size&data_size&log_size.	cpu_usage
PerformanceValues	object
PerformanceValue	array<object>	The list of performance metric values.
	object
Value	string	The value of the performance metric.	0.23
Date	string	The time when the performance metric value was generated.	2022-06-13T10:58:00Z
EndTime	string	O fim do intervalo de tempo a ser consultado. O horário está no formato aaaa-MM-ddTHH:mmZ. O horário é exibido em UTC.	2022-06-13T11:58Z
RequestId	string	O ID da solicitação.	4A300BC7-6D8F-527F-A2DB-A7768D26E9AC
StartTime	string	O início do intervalo de tempo a ser consultado. O horário está no formato aaaa-MM-ddTHH:mmZ. O horário é exibido em UTC.	2022-06-13T10:58Z

Exemplos

Resposta de sucesso

JSON formato

{
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "Key": "CpuUsage",
        "Unit": "%",
        "ValueFormat": "cpu_usage",
        "PerformanceValues": {
          "PerformanceValue": [
            {
              "Value": "0.23",
              "Date": "2022-06-13T10:58:00Z"
            }
          ]
        }
      }
    ]
  },
  "EndTime": "2022-06-13T11:58Z",
  "RequestId": "4A300BC7-6D8F-527F-A2DB-A7768D26E9AC",
  "StartTime": "2022-06-13T10:58Z"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidPerformanceKey.Malformed	The specified parameter Key is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time	The end time cannot be earlier than the start time.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.