Query cluster tasks by using ListClusterTasks - OpenSearch - Alibaba Cloud - OpenSearch

Operation description

Method

GET

URI

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:ListClusterTasks

list

*Instance

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

None

Request syntax

GET /openapi/ha3/instances/{instanceId}/cluster-tasks HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Sample requests

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511
result	array<object>	The index information.
	array<object>	The cluster list information.
groupType	string	The change group type.	Table_Update
fsmId	string	The ID of the finite state machine (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	The card name.	ha-cn-pl32rf0****_qrs
time	string	The timestamp of the card.	1657610520
type	string	The card type.	mra_table_config_trace_fsm
user	string	The user who triggered the FSM process.	admin
status	string	The FSM status.	onlyPublished
extraAttribute	string	The additional attributes of the card.	{ "consoleVersion": "", "domain": "hz_pre_vpc_domain_1", "configType": "offline" }
field3	string	The field3 value passed when the FSM was created.	{ "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>	The tags of the progress bar.
	object	The tag.
tagLevel	string	The tag level.	1
msg	string	The tag content.	test-tag
taskNodes	array<object>	The task information.
	object	The task node details.
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 completed.	2024-06-17 18:40:48
status	string	The task status.	SUCCESS

Sample responses

Success responses

{
  "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"
    }
  ]

Examples

Success response

JSON format

{
  "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"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.