DiagnoseInstance - Elasticsearch: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação utiliza apenas cabeçalhos de requisição comuns. Para mais informações, consulte Cabeçalhos de requisição comuns.

Sintaxe da requisição

POST /openapi/diagnosis/instances/{InstanceId}/actions/diagnose HTTP/1.1

Parâmetros da requisição

Elemento	Tipo	Localização	Obrigatório	Exemplo	Descrição
InstanceId	String	Path	Sim	es-cn-n6w1o1x0w001c****	ID da instância.
lang	String	Query	Não	en	Idioma do relatório. O padrão corresponde ao idioma do navegador. Valores suportados: en: Inglês zh: Chinês Simplificado zt: Chinês Tradicional es: Espanhol FR: Francês
ClientToken	String	Query	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Token de cliente para garantir a idempotência da requisição. Gere o valor no cliente e assegure sua unicidade entre requisições distintas. O token aceita apenas caracteres ASCII e tem limite de 64 caracteres.
	Object	Body	Não		Informações da tarefa de diagnóstico.
indices	Array of String	Body	Não	["library"]	Lista de índices para diagnóstico. Caso o parâmetro type seja ALL, defina indices como null.
diagnoseItems	Array of String	Body	Não	["ClusterBulkRejectDiagnostic",...]	Itens de diagnóstico. Para mais detalhes, consulte os resultados retornados por ListDiagnosisItems.
type	String	Body	Não	ALL	Tipo da tarefa de diagnóstico. Valores válidos: ALL: Diagnostica todos os índices. SELECT: Diagnostica o índice selecionado.

Parâmetros de resposta

Elemento	Tipo	Exemplo	Descrição
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***	ID da requisição.
Result	Object		Dados retornados.
createTime	Long	1535745731000	Timestamp de geração do relatório de diagnóstico.
reportId	String	trigger__2020-08-17T17:09:02	ID do relatório.
state	String	RUNNING	Status do diagnóstico. Valores válidos: SUCCESS, FAILED e RUNNING.
instanceId	String	es-cn-n6w1o1x0w001c****	ID da instância diagnosticada.

Exemplos

Exemplos de requisição

POST /openapi/diagnosis/instances/es-cn-n6w1o1x0w001c****/actions/diagnose?lang=en&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

 {
    "indices":[],
    "type":"ALL",
    "diagnoseItems":[
        "ClusterBulkRejectDiagnostic",
        "IndexAliasUseDiagnostic",
        "ClusterColorStatusDiagnostic",
        "ClusterDiskResourceDiagnostic",
        "IndexRecoverySlowDiagnostic",
        "IndexReplicaDiagnostic",
        "KibanaIndexToMuchDiagnostic",
        "MasterNodeHighLoadDiagnostic",
        "NodeLeftDiagnostic",
        "NodeLoadDeviationDiagnostic",
        "ClusterComputingResourceDiagnostic",
        "NodeShardsToMuchDiagnostic",
        "IndexRegexpDeleteDiagnostic",
        "IndexSegmentsDiagnostic",
        "IndexShardsDiagnostic",
        "ClusterMinMasterDiagnostic",
        "ClusterStateVersionDiagnostic",
        "ErrorLogDiagnostic",
        "FullGcLogDiagnostic",
        "AutoSnapshotOpenDiagnostic"
    ]
}

Exemplos de resposta de sucesso

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : {
    "reportId" : "trigger__2020-10-19T16:49:56",
    "instanceId" : "es-cn-n6w1o1x0w001c****",
    "state" : "RUNNING",
    "createTime" : 0,
    "diagnoseItems" : [ ]
  },
  "RequestId" : "1EE5BB1E-7ECE-4CFE-A05A-7F1EE2C4****"
}

Código de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.