ListClusterTasks - OpenSearch - Alibaba Cloud Documentation Center

Queries cluster tasks.

Operation description

Method

GET

URI

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:ListClusterTasks	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

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

Request parameters

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

Sample requests

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	id of request	CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511
result	array<object>	The index information.
result	object	The information about the cluster list.
groupType	string	The change group type.	" "
fsmId	string	The ID of the finite state machine (FSM).	tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-zvp2ljiwe01_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-zvp2ljiwe01_api2@1649729867698@028315
name	string	The card name.	ha-cn-pl32rf0js04_qrs
time	string	The timestamp of the card.	1657610520
type	string	The card type.	qrs
user	string	The user who triggered the generation of the FSM process.	" "
status	string	The FSM status.	onlyPublished
extraAttribute	string	The additional attributes of the card.	" "
field3	string	The field3 field that was passed when the FSM was created.	" "
tags	array<object>	The tags of the progress bar.
tags	object	The tag.
tagLevel	string	The tag level.	" "
msg	string	The tag content.	succeed in handling request
taskNodes	array<object>	The task information.
taskNodes	object	The information about the nodes of the task.
name	string	The task name.	general
index	long	The ordinal number of the task.	100
finishDate	string	The time when the task was complete.	" "
status	string	The task status.	2

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

Sample success responses

JSONformat

{
  "requestId": "CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511",
  "result": [
    {
      "groupType": "\" \"",
      "fsmId": "tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-zvp2ljiwe01_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-zvp2ljiwe01_api2@1649729867698@028315",
      "name": "ha-cn-pl32rf0js04_qrs",
      "time": "1657610520",
      "type": "qrs",
      "user": "\" \"",
      "status": "onlyPublished",
      "extraAttribute": "\" \"",
      "field3": "\" \"",
      "tags": [
        {
          "tagLevel": "\" \"",
          "msg": "succeed in handling request"
        }
      ],
      "taskNodes": [
        {
          "name": "general",
          "index": 100,
          "finishDate": "\" \"",
          "status": "2"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details