ListClusterTasks - OpenSearch: Central de Documentação do Alibaba Cloud

Consulta tarefas do cluster.

Descrição da operação

Método

GET

URI

/openapi/ha3/instances/{instanceId}/cluster-tasks

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:ListClusterTasks

list

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/cluster-tasks 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/{instanceId}/cluster-tasks

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
requestId	string	O ID da solicitação.	CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511
result	array<object>	As informações do índice.
	array<object>	As informações sobre a lista de clusters.
groupType	string	O tipo de grupo de alteração.	Table_Update
fsmId	string	O ID da máquina de estados finitos (FSM).	tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0**_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0**_api2@1649729867698@028315
name	string	O nome do cartão.	ha-cn-pl32rf0****_qrs
time	string	O timestamp do cartão.	1657610520
type	string	O tipo do cartão.	mra_table_config_trace_fsm
user	string	O usuário que acionou a geração do processo FSM.	admin
status	string	O status da FSM.	onlyPublished
extraAttribute	string	Os atributos adicionais do cartão.	{ "consoleVersion": "", "domain": "hz_pre_vpc_domain_1", "configType": "offline" }
field3	string	O campo field3 que foi passado quando a FSM foi criada.	{ "ha-cn-pl32rf0**_offline_adv": 1, "ha-cn-pl32rf0_offline_plugin": 1, "ha-cn-pl32rf0_table_ha-cn-35t3r02iq03_test_api": 1, "ha-cn-pl32rf0@ha-cn-pl32rf0_test_api@hz_pre_vpc_domain_1@test_api@index_config": 1, "ha-cn-pl32rf0**_offline_dict": 1 }
tags	array<object>	As tags da barra de progresso.
	object	A tag.
tagLevel	string	The tag level.	1
msg	string	The tag content.	test-tag
taskNodes	array<object>	As informações da tarefa.
	object	As informações sobre os nós da tarefa.
name	string	The task name.	publish config version
index	integer	The ordinal number of the task.	4
finishDate	string	The time when the task was complete.	2024-06-17 18:40:48
status	string	The task status.	SUCCESS

Exemplos de respostas

Respostas de sucesso

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "groupType": "table",
      "fsmId": "tisplus_opensearch@create_online_deploy_fsm@opensearch_pre_standard_private_20211110_2@pre_domain_1@null@null@1637215469093@127746",
      "name": "",
      "taskNodes": [
        {
          "nodeInfo": {
            "msg": "stopped clean fsm: []",
            "name": "stop clean",
            "index": 0,
            "finishDate": "2021-11-18 14:04:49",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "name": "prepare",
            "index": 1,
            "finishDate": "2021-11-18 14:05:09",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "name": "merger port",
            "index": 2,
            "finishDate": "2021-11-18 14:05:19",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "name": "moss create",
            "index": 3,
            "finishDate": "2021-11-18 14:05:39",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "name": "submit hippo",
            "index": 4,
            "finishDate": "2021-11-18 14:05:59",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "name": "admin started",
            "index": 5,
            "finishDate": "2021-11-18 14:16:05",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "name": "zone create",
            "index": 6,
            "finishDate": "2021-11-18 14:16:45",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "name": "switch index",
            "index": 13,
            "finishDate": "2021-11-18 14:16:55",
            "status": "SUCCESS"
          }
        }
      ],
      "time": "2021-11-18 14:04:29",
      "type": "onlineGroup",
      "user": "74087",
      "status": "success"
    },
    {
      "groupType": "table",
      "fsmId": "tisplus_opensearch@delete_biz_fsm@multi_biz_opensearch-default@null@null@default@1631777272819@926304",
      "name": "delete_biz_fsm",
      "taskNodes": [
        {
          "nodeInfo": {
            "msg": "stop biz create fsm success",
            "name": "stop fsm",
            "index": 0,
            "finishDate": "2021-09-16 15:27:53",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "msg": "Ha3BizConfigResource [default] not exist",
            "name": "delete moss",
            "index": 1,
            "finishDate": "2021-09-16 15:28:04",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "msg": "skip delete cause resource[name=default] not exist",
            "name": "delete biz resource",
            "index": 2,
            "finishDate": "2021-09-16 15:28:14",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "msg": "skip check cause no InnerData.BizConfigResource is null",
            "name": "check suez",
            "index": 3,
            "finishDate": "2021-09-16 15:28:24",
            "status": "SUCCESS"
          }
        },
        {
          "nodeInfo": {
            "name": "finished",
            "index": 4,
            "finishDate": "2021-09-16 15:28:24",
            "status": "SUCCESS"
          }
        }
      ],
      "time": "2021-09-16 15:27:53",
      "type": "delete_biz_fsm",
      "user": "",
      "status": "success"
    }
  ]

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511",
  "result": [
    {
      "groupType": "Table_Update",
      "fsmId": "tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0****_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0****_api2@1649729867698@028315",
      "name": "ha-cn-pl32rf0****_qrs",
      "time": "1657610520",
      "type": "mra_table_config_trace_fsm",
      "user": "admin",
      "status": "onlyPublished",
      "extraAttribute": "{\n\t\"consoleVersion\": \"\",\n\t\"domain\": \"hz_pre_vpc_domain_1\",\n\t\"configType\": \"offline\"\n}",
      "field3": "{\n\t\"ha-cn-pl32rf0****_offline_adv\": 1,\n\t\"ha-cn-pl32rf0****_offline_plugin\": 1,\n\t\"ha-cn-pl32rf0****_table_ha-cn-35t3r02iq03_test_api\": 1,\n\t\"ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@hz_pre_vpc_domain_1@test_api@index_config\": 1,\n\t\"ha-cn-pl32rf0****_offline_dict\": 1\n}",
      "tags": [
        {
          "tagLevel": "1",
          "msg": "test-tag"
        }
      ],
      "taskNodes": [
        {
          "name": "publish config version",
          "index": 4,
          "finishDate": "2024-06-17 18:40:48",
          "status": "SUCCESS"
        }
      ]
    }
  ]
}

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.