Get Computing Resource

This API enables you to list details of the specified computing resource.

Syntax

The syntax for calling this method is:

POST <Base_Url>/computingResource/{computingResourceId}

A sample API call is as follows:

POST https://123.123.123.123/vCenter-CB/api/computingResource/15

User Privilege Required

None.

Request Body Parameters

This API does not require any request parameters.

API Response

The API, on successful execution, returns the details of the specified computing resource.

XPath

Type

Min Occurs

Max occurs

Description

ComputingResources/ComputingResource

 

0

unbounded

Computing resource.

ComputingResources/ComputingResource/@Id

xs:long

1

1

ID of the computing resource.

ComputingResources/ComputingResource/Name

xs:string

1

1

Name of the computing resource.

ComputingResources/ComputingResource/Description

xs:string

1

1

Description of the computing resource.

ComputingResources/ComputingResource/Unit

xs:string

1

1

Unit in which the computer resource is measured.

ComputingResources/ComputingResource/Attributes/Attribute

1

unbounded

Attributes for the computing resource.

ComputingResources/ComputingResource/Attributes/Attribute/Name

xs:string

1

1

Name of the attribute for the computing resource.

A sample response is provided here. <<provide link to sample XML.>>

Error Response

The following table explains the error codes displayed by the API.

Error Code

Description

VCB_ERR_INVALID_COMPUTING_RESOURCE_ID

The computing resource with the given id does not exist.