List Vc Services

List Vc Services

List all vCenter Servers in the VMware Platform Services Controller (PSC).

Request
URI
POST
https://{api_host}/appliance/configuration-manager/actions/list-vc-services
COPY
Query Parameters
string
filter_property
Optional

The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1

string of array
filter
Optional

The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2

string
sort_by
Optional

Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.

sort_by example
name
string
order_by
Optional

Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.

string
limit
Optional

Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.

limit example
10
string
offset
Optional

The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10

offset example
10
Request Body

The specification to list the vCenter Server services.

ListVcServicesSpec of type(s) application/json
Optional

Show optional properties

{
    "psc_uri": "string"
}
{
    "psc_uri": "string",
    "psc_thumbprint": "string",
    "service_id": "string"
}
string
psc_uri
Required

Platform Service Controller URI.

string
psc_thumbprint
Optional

Thumbprint of the PSC node's certificate. When the correct value is provided all security checks of the certificate are off.

string
service_id
Optional

Optionally narrow VC search to a specific service ID.

Authentication
This operation uses the following authentication methods.
Responses
200

A list of the registered vCenter Server services.

Returns VcInfoDrResponseList of type(s) application/json 
"VcInfoDrResponseList Object"
array of object
list
Optional

Structure containing VC information.

object
_meta
Optional

List metadata


400

Bad request - the server cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"psc_uri:"string"}' https://{api_host}/appliance/configuration-manager/actions/list-vc-services
On This Page
Configuration Operations
POST
Check Existing Registrations
POST
Check Extension Key
Deprecated
POST
List Vc Services
POST
Validate Connection
GET
Get Configuration
PUT
Update Configuration
POST
Delete Configuration
GET
Get Reconfigure Required