Plan

Create a plan.

Changed on Jan 8, 2025

post/v1/{tenantId}/plans

Request

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

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": "&#34;d97849a5d11d7f7f90e0c1609d091d0a&#34;"
      }
    ]
  }
}

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": "&#34;d97849a5d11d7f7f90e0c1609d091d0a&#34;"
        }
      ]
    }
  }
}

Changes

Jan 8, 20256517d105571e Revision changes
- breaking
  removed the enum value ceph-s3 of the request property /
- breaking
  removed the enum value ceph-s3 of the request property /
- breaking
  removed the enum value hw-obs of the request property /
- breaking
  removed the enum value hw-obs of the request property /
- 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
- info
  added the new ceph-s3 enum value to the request property /
- info
  added the new ceph-s3 enum value to the request property /
- info
  added the new hw-obs enum value to the request property /
- info
  added the new hw-obs enum value to the request property /

Operation history