Get Interconnect Tasks By Filter
query interconnect tasks.
query interconnect tasks.
Request
URI
POST
https://{server}/hybridity/api/interconnect/tasks/query
COPY
Request Body
Filter object.
taskFilter
of type(s)
application/json
Required
Show optional properties
{
"filter": {}
}{
"filter": {
"interconnectTaskIds": [
"string"
],
"status": [
"string"
],
"entityIds": [
"string"
],
"startTime": 0,
"endTime": 0
},
"paging": {
"offset": 0,
"pageSize": 0
}
}
object
filter
Required
filter
object
paging
Optional
paging
Authentication
This operation uses the following authentication methods.
Responses
200
Accepted
Returns
tasksListResponse
of type(s)
application/json
{
"items": [
{
"interconnectTaskId": "string",
"entityDetails": {
"id": "string",
"type": "string",
"name": "string"
},
"type": "string",
"progress": 0,
"status": "string",
"message": "string",
"startTime": 0,
"endTime": 0,
"request": {
"computeProfile": {
"computeProfileId": "string",
"name": "string",
"location": "string",
"locationName": "string",
"state": "string",
"deploymentComputeClusterName": "string",
"deploymentComputeClusterId": "string",
"compute": [
{
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"services": [
{
"name": "string"
}
],
"deploymentContainer": {
"compute": [
{
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"storage": [
{
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"folder": {
"cmpId": "string",
"cmpName": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
},
"cpuReservation": 0,
"memoryReservation": 0
},
"networks": [
{
"id": "string",
"name": "string",
"tags": [
"string"
],
"staticRoutes": [
{
"network": "string",
"nextHop": "string"
}
],
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"switches": [
{
"cmpId": "string",
"id": "string",
"type": "string",
"name": "string",
"maxMtu": "number",
"l2cApplianceCount": "number",
"host": {
"id": "string",
"name": "string"
},
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"storage": [
{
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
}
]
}
},
"response": {
"computeProfile": {
"computeProfileId": "string",
"name": "string",
"location": "string",
"locationName": "string",
"state": "string",
"deploymentComputeClusterName": "string",
"deploymentComputeClusterId": "string",
"compute": [
{
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"services": [
{
"name": "string"
}
],
"deploymentContainer": {
"compute": [
{
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"storage": [
{
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"folder": {
"cmpId": "string",
"cmpName": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
},
"cpuReservation": 0,
"memoryReservation": 0
},
"networks": [
{
"id": "string",
"name": "string",
"tags": [
"string"
],
"staticRoutes": [
{
"network": "string",
"nextHop": "string"
}
],
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"switches": [
{
"cmpId": "string",
"id": "string",
"type": "string",
"name": "string",
"maxMtu": "number",
"l2cApplianceCount": "number",
"host": {
"id": "string",
"name": "string"
},
"status": {
"state": "string",
"errorMessage": "string"
}
}
],
"storage": [
{
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
}
]
}
},
"steps": [
{
"title": "string",
"type": "string",
"status": "string",
"progress": 0,
"startTime": 0,
"endTime": 0,
"message": "string",
"jobId": "string",
"children": [
{
"title": "string",
"type": "string",
"status": "string",
"progress": 0,
"startTime": 0,
"endTime": 0,
"message": "string",
"parentJobId": "string",
"jobId": "string",
"location": "string"
}
],
"errors": [
{
"code": "string",
"message": "string"
}
],
"warnings": [
{
"message": "string"
}
]
}
]
}
],
"paging": {
"offset": 0,
"pageSize": 0,
"totalSize": 0
}
}
array of
object
items
Optional
items
object
paging
Optional
paging
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
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
array of
object
errors
Optional
errors
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"filter":"object"}' https://{api_host}/hybridity/api/interconnect/tasks/query