使用ListClusterTasks展示叢集任務-智能OpenSearch OpenSearch-阿里雲

展示叢集任務。

介面說明

方法

GET

URI

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

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListClusterTasks

list

*Instance

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

無

請求文法

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

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID	ha-cn-pl32rf0****

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

請求樣本

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

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
requestId	string	請求 ID。	CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511
result	array<object>	返回結果。
	array<object>	叢集列表資訊。
groupType	string	變更分組類型	Table_Update
fsmId	string	fsmId	tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0**_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0**_api2@1649729867698@028315
name	string	卡片的名字	ha-cn-pl32rf0****_qrs
time	string	卡片的時間戳記	1657610520
type	string	卡片的類型	mra_table_config_trace_fsm
user	string	觸發產生 fsm 流程的使用者	admin
status	string	FSM 整體狀態	onlyPublished
extraAttribute	string	卡片的額外屬性	{ "consoleVersion": "", "domain": "hz_pre_vpc_domain_1", "configType": "offline" }
field3	string	建立狀態機器時透傳的 field3 欄位	{ "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>	進度條的狀態標籤
	object	標籤。
tagLevel	string	展示 tag 的等級	1
msg	string	展示 tag 內容	test-tag
taskNodes	array<object>	任務資訊
	object	任務節點資訊
name	string	任務名稱	publish config version
index	integer	此任務的序號	4
finishDate	string	完成日期	2024-06-17 18:40:48
status	string	任務狀態	SUCCESS

返回樣本

正確返回

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

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。