Query Hcx Migrations

Query Hcx Migrations

Returns the virtual machine migrations and their status details.

Request
URI
POST
https://{api_host}/hybridity/api/migrations
COPY
Query Parameters
string
action
Required

Represents which action type to do on migration(s). This API is for querying migration(s) action.

Request Body

Query migrations filtering payload.

queryMigrationsRequest of type(s) application/json
Required 
{
    "filter": {
        "migrationGroupId": [
            "string"
        ],
        "creationDateInterval": "number",
        "state": [
            "string"
        ],
        "id": [
            "string"
        ],
        "migrationId": [
            "string"
        ],
        "entityId": [
            "string"
        ],
        "migrationType": [
            "string"
        ],
        "transferType": [
            "string"
        ],
        "source_endpointId": [
            "string"
        ],
        "destination_endpointId": [
            "string"
        ],
        "destination_resourceId": [
            "string"
        ],
        "source_resourceId": [
            "string"
        ],
        "endpointId": [
            "string"
        ],
        "resourceId": [
            "string"
        ],
        "userName": [
            "string"
        ],
        "draftsOnly": false,
        "includeArchived": false,
        "entity_id": [
            "string"
        ],
        "skipDrafts": false,
        "createTimeEpoch": "number"
    },
    "options": {
        "resultLevel": "string",
        "compat": "number"
    },
    "paging": {
        "pageSize": 0,
        "offset": 0,
        "skipCount": 0
    }
}
object
filter
Optional

This section is to specify filter parameters to query specified filter-matched migrations.

object
options
Optional

options

object
paging
Optional

paging

Authentication
This operation uses the following authentication methods.
Responses
200

Ok

Returns queryMigrationsResponse of type(s) application/json 
"queryMigrationsResponse Object"
object
data
Optional

data


400

Bad Request

Returns errorResponse of type(s) application/json 
"errorResponse Object"
array of object
errors
Optional

errors


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

500

Internal Server Error

Returns errorResponse of type(s) application/json 
"errorResponse Object"
array of object
errors
Optional

errors


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/hybridity/api/migrations
On This Page
Query Migrations Details Operations
POST
Query Hcx Migrations