Get Data Collectors

Get Data Collectors
Get Data Collectors

Get all Data Collectors.

Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release.

Request
URI
GET
https://vcfa-10-162-161-9.vcfd.broadcom.net/iaas/api/data-collectors
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

boolean
disabled
Optional

If query param is provided with value equals to true, only disabled data collectors will be retrieved.

Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns DataCollectorResult of type(s) application/json 
{
    "content": [
        {
            "dcId": "d5316b00-f3b8-4895-9e9a-c4b98649c2ca",
            "ipAddress": "10.0.0.1",
            "name": "Datacollector1",
            "hostName": "dc1-lnd.mycompany.com",
            "status": "ACTIVE, INACTIVE"
        }
    ],
    "totalElements": 1,
    "numberOfElements": 1
}
array of object
content
Optional

List of content items

integer As int64 As int64
totalElements
Optional

Total number of elements. In some cases the field may not be populated

integer As int64 As int64
numberOfElements
Optional

Number of elements in the current page


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json 
{
    "message": "string",
    "messageId": "string",
    "stackTrace": [
        "string"
    ],
    "statusCode": 0,
    "errorCode": 0,
    "details": [
        "string"
    ],
    "serverErrorId": "string",
    "documentKind": "string",
    "internalErrorCode": 0
}
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/iaas/api/data-collectors
On This Page
Data Collector Operations
GET
Get Data Collectors
POST
Create Data Collector
GET
Get Data Collector
DELETE
Delete Data Collector