Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-17524793.1 KB
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": ""d97849a5d11d7f7f90e0c1609d091d0a""
          }
        ]
      }
    }
  ],
  "next": 1
}