全部产品
Search
文档中心

智能开放搜索 OpenSearch:ListClusterTasks - 展示集群任务

更新时间:Oct 16, 2024

展示集群任务。

接口说明

方法

GET

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:ListClusterTaskslist
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

ha-cn-pl32rf0****

请求示例

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

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID。

CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511
resultarray<object>

返回结果。

resultobject

集群列表信息。

groupTypestring

变更分组类型

Table_Update
fsmIdstring

fsmId

tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0****_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0****_api2@1649729867698@028315
namestring

卡片的名字

ha-cn-pl32rf0****_qrs
timestring

卡片的时间戳

1657610520
typestring

卡片的类型

mra_table_config_trace_fsm
userstring

触发生成 fsm 流程的用户

admin
statusstring

FSM 整体状态

onlyPublished
extraAttributestring

卡片的额外属性

{ "consoleVersion": "", "domain": "hz_pre_vpc_domain_1", "configType": "offline" }
field3string

创建状态机时透传的 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 }
tagsarray<object>

进度条的状态标签

tagsobject

标签。

tagLevelstring

展示 tag 的等级

1
msgstring

展示 tag 内容

test-tag
taskNodesarray<object>

任务信息

taskNodesobject

任务节点信息

namestring

任务名称

publish config version
indexlong

此任务的序号

4
finishDatestring

完成日期

2024-06-17 18:40:48
statusstring

任务状态

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI查看变更详情