Get Data Collector

Get Data Collector
Get Data Collector

Get Data Collector with a given id.

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/{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 refer to /iaas/api/about

Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

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

Data collector identifier

string
ipAddress
Required

Ip Address of the data collector VM

string
name
Required

Data collector name

string
hostName
Required

Data collector host name

string
status
Required

Current status of the data collector


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


404

Not found

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/{id}
On This Page
Data Collector Operations
GET
Get Data Collectors
POST
Create Data Collector
GET
Get Data Collector
DELETE
Delete Data Collector