Get Edge Cluster Query Criteria
Get the Edge Cluster criterion list for the NSX query
Request
URI
GET
https://{api_host}/v1/edge-clusters/{edgeClusterId}/criteria
COPY
Path Parameters
string
edgeClusterId
Required
Edge Cluster ID
Responses
200
Ok
Returns PageOfEdgeClusterNsxtEntityCriterion of type(s) application/json
{
"elements": [
{
"name": "One among: TIER_0_GATEWAY_ASSOCIATED_WITH_EDGE_CLUSTER, TIER_1_GATEWAY_ASSOCIATED_WITH_EDGE_CLUSTER",
"arguments": {
"arguments": "string"
},
"description": "string"
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}array of object
elements
Optional
The list of elements included in this page
object
pageMetadata
Optional
Represents pageable elements pagination metadata
404
Resource Not Found
Returns Page of type(s) application/json
"Page Object"array of object
elements
Optional
The list of elements included in this page
object
pageMetadata
Optional
Represents pageable elements pagination metadata
500
InternalServerError
Returns Error of type(s) application/json
"Error Object"string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
message
Optional
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of object
causes
Optional
The underlying cause exceptions.
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/edge-clusters/{edgeClusterId}/criteria