[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"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

Post Datastore Query

Description

Post a datastore query

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/clusters/{id}/datastores/queries
Copy

Path Parameters

Path Parameters

string
id Required

Cluster ID


Request Body

Request Body

DatastoreCriterion of type(s) application/json Required

dsCriterion

{
    "name": "One among: VSAN_REMOTE_DATASTORES"
}
map of string
arguments Optional

Arguments required for a particular criterion


string
description Optional

Description of the criterion


string
name Optional

Name of the criterion for querying datastores

Response

Response

Response Body

Response Body

200 OK

Returns DatastoreQueryResponse of type(s) application/json
{
	"queryInfo": {
		"completed": false,
		"errorResponse": {
			"arguments": [
				"string"
			],
			"causes": [
				{
					"message": "string",
					"type": "string"
				}
			],
			"context": {
				"key": "string"
			},
			"errorCode": "string",
			"errorType": "string",
			"message": "string",
			"nestedErrors": "Error Object",
			"referenceToken": "string",
			"remediationMessage": "string"
		},
		"failure": false,
		"processing": false,
		"queryId": "string",
		"status": "string"
	},
	"result": {
		"elements": [
			{
				"datastoreType": "string",
				"freeCapacityGB": 0,
				"id": "string",
				"name": "string",
				"tags": [
					{
						"categoryId": "string",
						"categoryName": "string",
						"id": "string",
						"name": "string"
					}
				],
				"totalCapacityGB": 0,
				"url": "string",
				"vcDatacenterName": "string",
				"vcInstanceUuid": "string",
				"vmCount": 0
			}
		],
		"pageMetadata": {
			"pageNumber": 0,
			"pageSize": 0,
			"totalElements": 0,
			"totalPages": 0
		}
	}
}
queryInfo Optional

Query info


result Optional

Query result

Errors

Errors

Error
400

Bad Request


Error
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"name":"One among: VSAN_REMOTE_DATASTORES"}' https://sfo-vcf01.rainpole.io/v1/clusters/{id}/datastores/queries


[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"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?