Get Data Collector

Get Data Collector

Get Data Collector with a given id.

Note: Data collector endpoints are not available in vRA on-prem release.

Request
URI
GET
https://{api_host}/iaas/api/data-collectors/{id}
COPY
Path Parameters
string
id
Required

The ID of the Data Collector.

Query Parameters
string
apiVersion
Optional

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

Responses
200

successful operation

Returns DataCollector of type(s) application/json 
{
    "hostName": "dc1-lnd.mycompany.com",
    "dcId": "d5316b00-f3b8-4895-9e9a-c4b98649c2ca",
    "ipAddress": "10.0.0.1",
    "name": "Datacollector1",
    "status": "ACTIVE, INACTIVE"
}
string
hostName
Required

Data collector host name

string
dcId
Required

Data collector identifier

string
ipAddress
Required

Ip Address of the data collector VM

string
name
Required

Data collector name

string
status
Required

Current status of the data collector


403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

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