Sign in

v1

latestSwagger 2.02026-07-17123181472.9 KB
OBTenant

Create backup policy of specific tenant

Create backup policy of specific tenant, passwords should be encrypted by AES

put/api/v1/obtenants/{namespace}/{name}/backupPolicy

Path parameters

namespacestring required

obtenant namespace

namestring required

obtenant name

Request body

appIdstring

Used for COS

archivePathstring required
bakDataPathstring required
bakEncryptionPasswordstring
destType'NFS' | 'OSS' | 'COS' | 'S3' | 'S3_COMPATIBLE' required
hoststring
jobKeepDaysinteger
ossAccessIdstring

Used for non-NFS

ossAccessKeystring
pieceIntervalDaysinteger
recoveryDaysinteger
regionstring

Used for S3

scheduleTimestring

Description: HH:MM Example: 04:00

scheduleTypestring

Enum: Weekly, Monthly

Example request

{
  "appId": "123456",
  "bakEncryptionPassword": "encryptedPassword",
  "host": "https://oss-cn-hangzhou.aliyuncs.com",
  "jobKeepDays": 5,
  "ossAccessId": "encryptedPassword",
  "ossAccessKey": "encryptedPassword",
  "pieceIntervalDays": 1,
  "recoveryDays": 3,
  "region": "cn-hangzhou",
  "scheduleDates": [
    {
      "backupType": "Full",
      "day": 3
    }
  ],
  "scheduleTime": "04:00",
  "scheduleType": "Weekly"
}

Response

OK

messagestring required
successfulboolean required

Example response

{
  "data": {
    "jobKeepDays": 5,
    "pieceIntervalDays": 1,
    "recoveryDays": 3,
    "scheduleDates": [
      {
        "backupType": "Full",
        "day": 3
      }
    ],
    "scheduleTime": "04:00",
    "scheduleType": "Weekly"
  }
}