REST API - list

vcenter hlm sddcs: list

Lists all Sddcs that are under the same organization as the local node. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/rest/vcenter/hlm/sddcs

?filter.only_available_to_add=true

Request Query Parameters:

Name	Type	Description
bold = required
filter	filter_spec	Optional. Specification on how to filter the Sddcs.
filter.only_available_to_add	boolean	Whether or not to filter results based on if the sddc is available to add to the community. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "hostname" : "string",
            "name" : "string",
            "region" : "string"
        },
        {
            "hostname" : "string",
            "name" : "string",
            "region" : "string"
        }
    ]
}

Response Type:

Name	Type	Description
bold = required
value	summary[]	the list of Sddcs.
value[].hostname	string	The vCenter hostname. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value[].name	string	The Sddc display name. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value[].region	string	The AWS region of the Sddc. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Errors:

HTTP Status Code	Type	Description
403	unauthorized	if the caller is not authorized.
500	error	if the system reports an error while responding to the request.