Chown Recovery Plan | VMware Cloud Director Availability API

Chown Recovery Plan

This request allows the administrators to change the owner of the specified recovery plan. Note: By default, the plans are owned by the user that created them. Any plans created by an administrator user are not visible to the respective organization unless the administrator explicitly changes the ownership of the replication to that organization.Alternatively, an administrator can temporarily take ownership of a plan to prevent the tenant from seeing and managing it, for example, during troubleshooting or while an emergency recovery is in progress.

Request

URI

POST

https://{api_host}//recovery-plans/{recoveryPlanId}/chown

COPY

Path Parameters

string

recoveryPlanId

Required

recoveryPlanId

recoveryPlanId example

e7bf7128-2825-48ca-9075-3f496de70ffe

Header Parameters

string

operationID

Optional

Operation ID for correlating logs across multiple services

Request Body

ChownSettings of type(s) application/json

Required

{
    "owner": "org1@site1"
}

string

owner

Optional

Optional owner of the replication, if omitted the currently logged in user becomes the owner.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns RecoveryPlanInfo of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8

{
    "description": "Example of a plan",
    "displayName": "Plan 1",
    "executionInfo": {
        "isSuspendRequested": false,
        "lastError": {
            "args": [],
            "code": "Forbidden",
            "msg": "Permission denied.",
            "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
        },
        "lastOperation": "string",
        "promptStepId": "5ee9224f-305d-46f6-865f-b605e70acef8",
        "state": "string"
    },
    "id": "2bfb7696-3aa1-49d3-bb40-d9e97df1baba",
    "isMigration": false,
    "owner": "org1@site1",
    "scheduledSyncTime": 1901071800000
}

string

description

Optional

Recovery plan description.

string

displayName

Optional

Recovery plan display name (unique across recovery plans).

RecoveryPlanInfo_ExecutionInfo

executionInfo

Optional

executionInfo

string As uuid As uuid

Optional

Recovery plan id.

boolean

isMigration

Optional

Whether the plan is a migration plan.

string

owner

Optional

Recovery plan owner.

integer As int64 As int64

scheduledSyncTime

Optional

Time at which the replications of the recovery plan will get synced. 0 means not scheduled.

401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8

{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}

array of string

args

Optional

Positional arguments.

string

code

Optional

Specific error code.

string

msg

Optional

Detailed error message.

string

stacktrace

Optional

Exception stacktrace.

500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8

{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}

array of string

args

Optional

Positional arguments.

string

code

Optional

Specific error code.

string

msg

Optional

Detailed error message.