Get Deployment Resources Using GET

Get Deployment Resources Using GET

Returns a paginated list of resources corresponding to the deployment with the supplied ID.

Request
URI
GET
https://{api_host}//api.mgmt.cloud.vmware.com/deployment/api/deployments/{depId}/resources
COPY
Path Parameters
string
depId
Required

Deployment ID

Query Parameters
boolean
expandMetadata
Optional

Retrieves the 'metadata' field of each resource.

boolean
forceCachedResources
Optional

Retrieves the resources from a cache for a faster query.

boolean
forceRefreshResources
Optional

Guarantees the resources are up-to-date.

integer
page
Optional

Results page you want to retrieve (0..N)

integer
size
Optional

Number of records per page.

size example
20
string of array
sort
Optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.


Responses
200

OK

Returns PageOfResource of type(s) */*
{
    "content": [
        {
            "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"
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "size": 0,
    "sort": {
        "empty": false,
        "sorted": false,
        "unsorted": false
    },
    "totalElements": 0,
    "totalPages": 0
}
array of Resource
content
Optional

content

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

integer As int32 As int32
size
Optional

size

sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


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