[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf

Retrieve SDDC

Description

Retrieve a SDDC

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/sddcs/{id}
Copy

Path Parameters

Path Parameters

string
id Required

SDDC ID


Response

Response

Response Body

Response Body

200 OK returns SddcTask of type(s) application/json
{
	"creationTimestamp": "string",
	"id": "string",
	"localizableNamePack": {
		"arguments": [
			"string"
		],
		"component": "string",
		"message": "string",
		"messageKey": "string"
	},
	"name": "string",
	"sddcSubTasks": [
		{
			"creationTimestamp": "string",
			"description": "string",
			"errors": [
				{
					"arguments": [
						"string"
					],
					"causes": [
						{
							"message": "string",
							"type": "string"
						}
					],
					"context": {
						"key": "string"
					},
					"errorCode": "string",
					"errorType": "string",
					"message": "string",
					"nestedErrors": "Error Object",
					"referenceToken": "string",
					"remediationMessage": "string"
				}
			],
			"localizableDescriptionPack": {
				"arguments": [
					"string"
				],
				"component": "string",
				"message": "string",
				"messageKey": "string"
			},
			"localizableNamePack": {
				"arguments": [
					"string"
				],
				"component": "string",
				"message": "string",
				"messageKey": "string"
			},
			"name": "string",
			"processingStateDescription": "string",
			"processingStateName": "string",
			"sddcId": "123e4567-e89b-42d3-a456-556642440000",
			"status": "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
			"updateTimestamp": "string"
		}
	],
	"status": "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}
string
creationTimestamp Optional

SDDC Task creation timestamp


string
id Optional

SDDC ID


localizableNamePack Optional

Localizable SDDC Task name


string
name Optional

Task name


array of SddcSubTask
sddcSubTasks Optional

All SDDC Sub-Tasks


string
status Optional

SDDC Task status

Errors

Errors

400

Bad Request


404

Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/sddcs/{id}


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Feedback

Was this page helpful?