Changed2

[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]

vcf-for-vxrail

Post Datastore Query

Description

Post a datastore query

Request

URL

post

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

Copy

Path Parameters

string

id Required

Cluster ID

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 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

queryInfo Optional

Query info

PageOfDatastore

result Optional

Query result

Errors

Error

400

Bad Request

Error

500

Internal Server Error

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

vcf-for-vxrail

What's changed in 4.5.0?

INTRODUCED

New in this version

Clusters Operations

post

Add Datastore To Cluster Introduced

put

Assign Tags To Existing Cluster Introduced

get

Assignable Tags To Cluster Introduced

post

Create Cluster

delete

Delete Cluster

get

Get Cluster

get

Get Cluster Create Validation

get

Get Cluster Datastores Introduced

get

Get Cluster Tag Manager URL

get

Get Cluster Update Validation

get

Get Clusters

get

Get Datastore Criterion Introduced

get

Get Datastore Query Response Introduced

get

Get Datastores Criteria Introduced

get

Get Host Criteria

get

Get Host Criterion

get

Get Host Query Response

get

Get Tags Assigned To Cluster

get

Get Tags Assigned To Clusters Introduced

get

Get VDses

post

Post Datastore Query Introduced

post

Post Host Query

delete

Remove Datastore From Cluster Introduced

delete

Remove Tags From Existing Cluster Introduced

patch

Update Cluster

post

Validate Cluster Operations

post

Validate Clusters Operations

post

Validate vSAN Remote Datastore Introduced

Post Datastore Query

Request

URL

Path Parameters

Request Body

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

What's changed in 4.5.0?

On This Page

Clusters Operations

Was this page helpful?