Plan

List all plans.

get/v1/{tenantId}/plans

Query parameters

type'migration'

Filter the plans by plan type. Only migration support currently. New type will be added in the future.

namestring

Filter the plan by name.

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The numbers of items to return

sortstring

The sort key and direction of items to return, string must like:"id:asc,name:desc"

Response

successful operation.

nextinteger

Example response

{
  "plans": [
    {
      "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": "&#34;d97849a5d11d7f7f90e0c1609d091d0a&#34;"
          }
        ]
      }
    }
  ],
  "next": 1
}

Changes

Changed in 6 of the 33 revisions of this API.246

Jun 26, 2020443f565555ae42See the full diff
- ●
  added the new aws-file enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new aws-file enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new azure-file enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new azure-file enum value to the /// response property for the response status
  response-property-enum-value-added
- ○
  api tag Plan added
  api-tag-added
- ○
  api tag plan removed
  api-tag-removed
Jun 9, 2020bec7a127bf7f1See the full diff
- ○
  endpoint added
  endpoint-added
May 3, 2020f9da14548ae51See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 26, 20181c99d33875172See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Nov 1, 201856dbe50974ed1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 29, 201850fa096a39061See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 33 revisions, 3 have no diff computed.

Full history