Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-17504188.8 KB
Plan

Create a plan.

post/v1/{tenantId}/plans

Request body

Idstring

The plan ID, generated by server

TenantIdstring

The tenant UUID in a multi-tenancy environment.

UserIdstring

The user UUID in a multi-tenancy environment.

Descriptionstring

Plan description.

Namestring

The plan name specified by user.

Type'migration'

The plan type. Till now only migration support. New types will be added in the future.

PolicyEnabledboolean

Enable policy or not.

PolicyIdstring

Related policy id, plan will be scheduled automatically according this policy if PolicyEnabled is true.

RemainSourceboolean

Remain the source objects or not.

Example request

{
  "Id": "5eaa81fd6f384d000116d1d4",
  "TenantId": "94b280022d0c4401bcf3b0ea85870519",
  "UserId": "558057c4256545bd8a307c37464003c9",
  "Description": "AWS to HW OBS Bucket Migration",
  "Name": "plan001",
  "Type": "migration",
  "RemainSource": true,
  "SourceConn": {
    "StorType": "opensds-obj",
    "BucketName": "bucket001"
  },
  "DestConn": {
    "StorType": "opensds-obj",
    "BucketName": "bucket001"
  },
  "Filter": {
    "Prefix": "photos/",
    "Tag": [
      {
        "key": "Image001.PNG",
        "Value": ""d97849a5d11d7f7f90e0c1609d091d0a""
      }
    ]
  }
}

Response

successful operation

Example response

{
  "plan": {
    "Id": "5eaa81fd6f384d000116d1d4",
    "TenantId": "94b280022d0c4401bcf3b0ea85870519",
    "UserId": "558057c4256545bd8a307c37464003c9",
    "Description": "AWS to HW OBS Bucket Migration",
    "Name": "plan001",
    "Type": "migration",
    "RemainSource": true,
    "SourceConn": {
      "StorType": "opensds-obj",
      "BucketName": "bucket001"
    },
    "DestConn": {
      "StorType": "opensds-obj",
      "BucketName": "bucket001"
    },
    "Filter": {
      "Prefix": "photos/",
      "Tag": [
        {
          "key": "Image001.PNG",
          "Value": ""d97849a5d11d7f7f90e0c1609d091d0a""
        }
      ]
    }
  }
}