Elasticsearch：CreateDataTasks

Before you call this operation, take note of the following points:

• Currently, the one-click index migration feature is available only in the China (Beijing) region.
• The source and destination Elasticsearch clusters must be self-built or Alibaba Cloud Elasticsearch Elasticsearch clusters of source V6.7.0 and Alibaba Cloud Elasticsearch Elasticsearch clusters of V6.3.2 or V6.7.0.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

POST /openapi/instances/{InstanceId}/data-task HTTP/1.1

Request parameters

• If the cluster is enabled over the Internet, enter the endpoint parameter to connect to the cluster.
• If the public network of the cluster is disabled (or the cluster is connected by using VPC information), enter the vpcInstancePort, vpcId, vpcInstanceId, or vpcInstancePort, vpcId, and vpcIp parameters to connect to the cluster.

Example:

• Access the cluster over the Internet

  
      {
          "sourceCluster":{
              "dataSourceType":"elasticsearch",
              "endpoint" : "http://es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com:9200",
              "username" : "elastic",
              "password" : "xxxxxx",
              "index" : "default",
              "type" : "default"
           },
          "sinkCluster":{
              "dataSourceType":"elasticsearch",
              "username" : "elastic",
              "password" : "xxxxxx",
              "index" : "default",
              "type" : "default",
              "settings" : "#settings configuration#",
              "mapping" : "#mapping configuration#",
              "routing" : "_id"
          },
          "migrateConfig": {
              "sourceFilterParams": ""
          }
     }
       

• Alibaba Cloud Elasticsearch Cluster

  
      {
          "sourceCluster":{
              "dataSourceType" : "elasticsearch",
              "vpcInstancePort":9200,
              "vpcId":"vpc-2ze55voww95g82gak****",
              "vpcInstanceId":"es-cn-oew1oxiro000f****-worker",
              "username" : "elastic",
              "password" : "xxxxxx",
              "index" : "default",
              "type" : "default"
          },
          "sinkCluster":{
              "dataSourceType":"elasticsearch",
              "username" : "elastic",
              "password" : "xxxxxx",
              "index" : "default",
              "type" : "default",
              "settings" : "#settings configuration#",
              "mapping" : "#mapping configuration#",
              "routing" : "_id"
          },
          "migrateConfig": {
              "sourceFilterParams": ""
          }
      }
      

Response parameters

Examples

Sample requests

POST /openapi/instances/es-cn-n6w1o1x0w001c****/data-task?ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

[ {
    "sourceCluster":{
        "dataSourceType":"elasticsearch",
        "endpoint" : "http://es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com:9200",
        "username" : "elastic",
        "password" : "xxxxxx",
        "index" : "default",
        "type" : "default"
     },
    "sinkCluster":{
        "dataSourceType":"elasticsearch",
        "username" : "elastic",
        "password" : "xxxxxx",
        "index" : "default",
        "type" : "default",
        "settings" : "{\n  \"index\": {\n    \"replication\": {\n      \"type\": .....}",
        "mapping" : "{\"doc\":{\"properties\":{\"interval_ms\":{\"type\":\"long\"},....}",
        "routing" : "_id"
    },
    "migrateConfig":{
        "sourceFilterParams": "index = 1"
    }
  } ]

Sample success response

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****",
  "Result" : [ {
    "sourceCluster" : {
      "password" : "xxxxxx",
      "endpoint" : "http://10.20.xx.xx:9200",
      "vpcId" : "vpc-2ze55voww95g82gak****",
      "vpcInstancePort" : 9200,
      "index" : "index_001",
      "type" : "index_001",
      "vpcInstanceId" : "es-cn-oew1oxiro000f****-worker",
      "dataSourceType" : "elasticsearch",
      "username" : "elastic"
    },
    "sinkCluster" : {
      "routing" : "cluster_name",
      "settings" : "{\\n  \\\"index\\\": {\\n    \\\"replication\\\": {\\n      \\\"type\\\": .....}",
      "password" : "xxxxx",
      "mapping" : "{\\\"doc\\\":{\\\"properties\\\":{\\\"interval_ms\\\":{\\\"type\\\":\\\"long\\\"},....}",
      "vpcInstancePort" : 9200,
      "vpcId" : "vpc-2ze55voww95g82gak****",
      "index" : "index_001",
      "type" : "index_001",
      "vpcInstanceId" : "es-cn-oew1oxiro000f****-worker",
      "dataSourceType" : "elasticsearch",
      "username" : "elastic"
    }
  } ]
}

Error codes

For a list of error codes, see Service error codes.