Get Resource By Id Using GET
Returns the resource with the specified ID that is correlated with the supplied deployment.
Request
URI
GET
https://{api_host}//api.mgmt.cloud.vmware.com/deployment/api/deployments/{depId}/resources/{resourceId}
COPY
Path Parameters
string
depId
Required
Deployment ID
string
resourceId
Required
Resource ID
Query Parameters
boolean
expandMetadata
Optional
Retrieves the 'metadata' field of the resource.
boolean
forceCachedResources
Optional
Retrieves the resource from a cache for a faster query.
boolean
forceRefreshResources
Optional
Guarantees the resource is up-to-date.
Responses
200
OK
Returns Resource of type(s) */*
{
"createdAt": "string",
"dependsOn": [
"string"
],
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"id": "string",
"name": "string",
"state": "string",
"syncStatus": "string",
"type": "string"
}
string As date-time As date-time
createdAt
Optional
Creation time
array of string
dependsOn
Optional
A list of other resources this resource depends on
string
description
Optional
A description of the resource
string As uuid As uuid
id
Optional
Unique identifier of the resource
object
metadata
Optional
metadata
string
name
Required
Name of the resource
object
properties
Optional
properties
string
state
Optional
The current state of the resource
Possible values are : PARTIAL, TAINTED, OK,
string
syncStatus
Optional
The current sync status
Possible values are : SUCCESS, MISSING, STALE,
string
type
Required
Type of the resource
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Not Found
Operation doesn't return any data structure
Deployments Operations
GET
Check Deployment Name Using GET
DELETE
Delete Deployment Using DELETE
DELETE
Delete Resource Using DELETE
GET
Get Deployment By Id Using GET
GET
Get Deployment Filter By Id Using GET
GET
Get Deployment Filters Using GET
GET
Get Deployment Resources Using GET
GET
Get Deployments For Project Using GET
GET
Get Deployments Using GET
GET
Get Resource By Id Using GET
PATCH
Patch Deployment Using PATCH