Plan

List all plans.

Changed on Jan 8, 2025

get/v1/{tenantId}/plans

Request

Base URL
https://virtserver.swaggerhub.com/open83/crystal/1.0.0
Auth
none declared

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

Jan 8, 20256517d105571e Revision changes
- info
  removed the ceph-s3 enum value from the /// response property for the response status
- info
  removed the ceph-s3 enum value from the /// response property for the response status
- info
  removed the hw-obs enum value from the /// response property for the response status
- info
  removed the hw-obs enum value from the /// response property for the response status
Sep 17, 2023d4f502a59e17 Revision changes
- warning
  added the new ceph-s3 enum value to the /// response property for the response status
- warning
  added the new ceph-s3 enum value to the /// response property for the response status
- warning
  added the new hw-obs enum value to the /// response property for the response status
- warning
  added the new hw-obs enum value to the /// response property for the response status

Operation history