Query Machines Allocated by MSP to Client Tenant (v2.5)
POST/v2.5/api/tenants/:tenant_id/clients/:client_id/machines/query
Query and get all machines allocated by ESP to a client tenant.
Request
Path Parameters
The tenant ID.
Tenant ID of the client tenant of ESP.
- application/json
Body
- Array [
- ]
aggregate Aggregate
The aggregate number of machines that match the query parameters.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
Field
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
Operator
QoS application aggregate statistics.
The unit.
The destination page.
The number machines deleted for a time frame.
Group the machines for the query.
List the machines by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Query using query parameters.
Retrieve information from a field.
List the fields to query.
Specify the order in which you want the search criteria to display.
The total number of query parameters.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
The tenant ID.
Total number.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_ESP_CLIENT"
},
{
"code": "TENANT_REGION_ASSOCIATION_NOT_FOUND"
}
]
}
}