Todos os produtos
Search

Este produto

    OpenSearch:GetClusterRunTimeInfo

    Central de documentação

    OpenSearch:GetClusterRunTimeInfo

    Última atualização: Jul 04, 2026

    Consulta as informações de tempo de execução de um cluster especificado.

    Descrição da operação

    Método

    GET

    URI

    /openapi/ha3/instances/{instanceId}/cluster-run-time-info

    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

    searchengine:GetClusterRunTimeInfo

    get

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 Nenhuma Nenhuma

    Sintaxe da solicitação

    GET /openapi/ha3/instances/{instanceId}/cluster-run-time-info HTTP/1.1

    Parâmetros de caminho

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    instanceId

    string

    Sim

    O ID da instância.

    ha-cn-pl32rf0****

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo

    Nenhum parâmetro necessário.

    Exemplos de solicitações

    GET /openapi/ha3/instances/ose-test1/cluster-run-time-info

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os resultados retornados.

    requestId

    string

    O ID da solicitação.

    E45380E8-994A-5402-9806-F114B3295FCF
    result

    array<object>

    O resultado.

    array<object>

    As informações de tempo de execução do cluster.

    clusterName

    string

    O nome do cluster.

    vpc_hz_domain_1
    queryNode

    object

    As informações sobre os workers do Query Result Searcher (QRS).

    serviceStatus

    object

    The service status of the QRS worker.

    name

    string

    The cluster name.

    vpc_hz_domain_1

    totalSize

    integer

    The total number of QRS workers in the cluster.

    100
    doneSize

    integer

    The number of processed QRS workers in the cluster.

    100
    donePercent

    integer

    The process progress of QRS workers in the cluster. Unit: percentage.

    100
    configStatusList

    array<object>

    The configuration status.

    object

    configUpdateTime

    string

    The time when the configuration was last updated.

    2024-05-21 16:05:26
    name

    string

    The cluster name.

    vpc_hz_domain_1

    totalSize

    integer

    The total number of QRS workers in the cluster.

    6
    doneSize

    integer

    The number of processed QRS workers in the cluster.

    100
    donePercent

    integer

    The process progress of QRS workers in the cluster. Unit: percentage.

    100
    dataNodes

    array<object>

    As informações sobre os workers Searcher.

    array<object>

    As informações sobre o nó do cluster.

    dataStatusList

    array<object>

    The data of the Searcher worker.

    array<object>

    docSize

    integer

    The storage capacity. Unit: GB.

    2
    fullVersion

    integer

    The time when the full index version was generated.

    1718846192
    incVersion

    integer

    The time when the incremental index version was generated.

    1718846192
    incUpdateTime

    string

    The time when incremental data in the index was last updated.

    2024-05-21 16:05:26
    fullUpdateTime

    string

    The time when full data in the index was last updated.

    2024-05-21 16:05:26
    indexConfigInfo

    object

    The information about the index configuration.

    configMetaName

    string

    The name of the index configuration.

    index_meta_name
    version

    integer

    The version of the index template.

    1.0.0
    advanceConfigInfo

    object

    The information about the advanced configuration.

    configMetaName

    string

    The name of the index configuration.

    index_meta_name
    version

    integer

    The version number.

    1.0
    lackMemWorker

    array

    The name of the worker that failed due to insufficient memory.

    string

    The name of the failed worker.

    test-fail-worker

    deployFailedWorker

    array

    The name of the worker that failed due to a deployment failure.

    string

    The name of the failed worker.

    test-fail-worker

    lackDiskWorker

    array

    The name of the worker that failed due to insufficient disks.

    string

    The name of the failed worker.

    test-fail-worker
    errorMsg

    string

    The error message.

    0A3B1C48006A6C0905F6375F4821EB50
    indexSize

    integer

    The index size.

    100
    name

    string

    The name of the QRS worker.

    ha-cn-pl32rf0****_qrs
    totalSize

    integer

    The total number of QRS workers in the cluster.

    1
    doneSize

    integer

    The number of processed QRS workers in the cluster.

    100
    donePercent

    integer

    The configuration progress. Unit: percentage.

    100
    serviceStatus

    object

    The service status of the QRS worker.

    name

    string

    The name of the QRS worker.

    ha-cn-pl32rf0****_qrs
    totalSize

    integer

    The total number of QRS workers in the cluster.

    100
    doneSize

    integer

    The number of processed QRS workers in the cluster.

    100
    donePercent

    integer

    The process progress of QRS workers in the cluster. Unit: percentage.

    100
    configStatusList

    array<object>

    The configuration status.

    object

    The response body.

    configUpdateTime

    string

    The time when the configuration was last updated.

    2024-05-21 16:05:26
    name

    string

    The cluster name.

    test_0704
    totalSize

    integer

    The total number of Searcher workers in the cluster.

    0
    doneSize

    integer

    The number of processed Searcher workers in the cluster.

    1
    donePercent

    integer

    The configuration progress. Unit: percentage.

    100

    Exemplo de resposta

    Resposta correta

    {
  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
  "result": [
    {
      "clusterName": "",
      "queryNode": {
        "serviceStatus": {
          "name": "service_name",
          "totalSize": 1,
          "doneSize": 1,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "name": "default",
            "totalSize": 1,
            "doneSize": 1,
            "donePercent": 100,
            "configUpdateTime": ""
          }
        ]
      },
      "dataNodes": [
        {
          "serviceStatus": {
            "name": "service_name",
            "totalSize": 1,
            "doneSize": 1,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "name": "default",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "configUpdateTime": ""
            }
          ],
          "dataStatusList": [
            {
              "name": "index1",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "docSize": 123423,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "",
              "fullUpdateTime": "",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 13241234
              },
              "advanceConfigInfo": {
                "configMetaName": "advance_meta_name",
                "version": 13241234
              },
              "lackMemWorker": [
                "worker1",
                "worker2"
              ],
              "deployFailedWorker": [
                "worker3",
                "worker4"
              ],
              "lackDiskWorker": [
                "worker5",
                "worker6"
              ],
              "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
            },
            {
              "name": "index1",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "docSize": 123423,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "",
              "fullUpdateTime": "",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 13241234
              },
              "advanceConfigInfo": {
                "configMetaName": "advance_meta_name",
                "version": 13241234
              },
              "lackMemWorker": [
                "worker1",
                "worker2"
              ],
              "deployFailedWorker": [
                "worker3",
                "worker4"
              ],
              "lackDiskWorker": [
                "worker5",
                "worker6"
              ],
              "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
            }
          ]
        }
      ]
    }
  ]
}

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": [
    {
      "clusterName": "vpc_hz_domain_1",
      "queryNode": {
        "serviceStatus": {
          "name": "vpc_hz_domain_1\n",
          "totalSize": 100,
          "doneSize": 100,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "configUpdateTime": "2024-05-21 16:05:26",
            "name": "vpc_hz_domain_1\n",
            "totalSize": 6,
            "doneSize": 100,
            "donePercent": 100
          }
        ]
      },
      "dataNodes": [
        {
          "dataStatusList": [
            {
              "docSize": 2,
              "fullVersion": 1718846192,
              "incVersion": 1718846192,
              "incUpdateTime": "2024-05-21 16:05:26",
              "fullUpdateTime": "2024-05-21 16:05:26",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 0
              },
              "advanceConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 1
              },
              "lackMemWorker": [
                "test-fail-worker\n"
              ],
              "deployFailedWorker": [
                "test-fail-worker\n"
              ],
              "lackDiskWorker": [
                "test-fail-worker"
              ],
              "errorMsg": "0A3B1C48006A6C0905F6375F4821EB50",
              "indexSize": 100,
              "name": "ha-cn-pl32rf0****_qrs",
              "totalSize": 1,
              "doneSize": 100,
              "donePercent": 100
            }
          ],
          "serviceStatus": {
            "name": "ha-cn-pl32rf0****_qrs",
            "totalSize": 100,
            "doneSize": 100,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "configUpdateTime": "2024-05-21 16:05:26",
              "name": "test_0704",
              "totalSize": 0,
              "doneSize": 1,
              "donePercent": 100
            }
          ]
        }
      ]
    }
  ]
}

    Códigos de erro

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.