List Usage Meters By Contract Id Using GET

List Usage Meters By Contract Id Using GET

Get the usage meter list of a contract. Supported selectors: instanceId, name, version, mode, connectionMode, uploadHealthStatus.

Pre-authorized roles: Auto Report Operations, Read Only

Request
URI
GET
https://{api_host}//vcp.vmware.com/api/provider/v1/contracts/{contractId}/usageMeters
COPY
Path Parameters
string
contractId
Required

Contract id

contractId example
630c2f68-xxxx-xxxx-xxxx-61f8245eaca1
Query Parameters
string
filter
Optional

FIQL format

integer
limit
Optional

limit

integer
offset
Optional

offset

string
sort
Optional

sort


Responses
200

OK

Returns PageOfUsageMeter of type(s) application/json
{
    "content": [
        {
            "id": "6a2ac963-xxxx-xxxx-xxxx-64151fe188f9",
            "instanceId": "de16af2a-xxxx-xxxx-xxxx-8cd5d5bdad1e",
            "name": "my_um",
            "version": "4.0.0.0",
            "mode": "PRODUCTION",
            "usageSite": {
                "id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
                "name": "my_site"
            },
            "connectionMode": "ONLINE",
            "lastUploadTime": "2022-05-06T00:00:00Z",
            "uploadHealthStatus": "GREEN",
            "lastModifiedTime": "2022-05-06T00:00:00Z"
        }
    ],
    "total": 1
}
array of UsageMeter
content
Optional

content

integer As int64 As int64
total
Optional

total


400

Bad Request

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Contract not found

Operation doesn't return any data structure