VMware Service Broker API Data Structures
A patch to update attributes for a catalog item
{
"bulkRequestLimit": "integer",
"iconId": "string"
}
Max number of instances that can be requested at a time
icon id
Represents a Catalog Item that can eventually be requested by a consumer.
{
"bulkRequestLimit": "integer",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"iconId": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"projectIds": [
"string"
],
"projects": [
{
"id": "string",
"link": "string",
"name": "string"
}
],
"sourceId": "string",
"sourceName": "string",
"type": {
"id": "string",
"link": "string",
"name": "string"
}
}
Max number of instances that can be requested at a time
Creation time
Created By
CatalogItem description
Icon ID
CatalogItem id
Update time
Updated By
CatalogItem name
Associated project IDs that can be used for requesting
Json schema describing request parameters, a simplified version of http://json-schema.org/latest/json-schema-validation.html#rfc.section.5
LibraryItem source ID.
LibraryItem source name.
A request to create a deployment based on a catalog item
{
"bulkRequestCount": "integer",
"deploymentName": "string",
"projectId": "string",
"reason": "string",
"version": "string"
}
Deployment request count; defaults to 1 if not specified.
Name of the requested deployment
Input parameters for the request. These must be compliant with the schema of the corresponding catalog item
Project to be used for the request
Reason for request
Version of the catalog item. e.g. v2.0
The blueprint service's response to a deployment request
{
"deploymentId": "string",
"deploymentName": "string"
}
The created deployment's ID
The created deployment's name
A response with upfront price for a resource in given catalog item
{
"dailyAdditionalPrice": "number",
"dailyComputePrice": "number",
"dailyNetworkPrice": "number",
"dailyStoragePrice": "number",
"dailyTotalPrice": "number",
"resourceName": "string",
"resourceType": "string",
"resourceUpfrontPriceId": "string",
"status": "string",
"statusDetails": "string",
"unit": "string"
}
Additional Price incurred for the catalog.
Compute Price of the catalog resource.
Network Price of the catalog resource.
Storage Price of the catalog resource.
Total Price of the catalog resource.
resourceName
resourceType
Id
Upfront price sync status
Upfront price status detail.
Monetary unit.
Represents a type of Catalog Item.
{
"baseUri": "string",
"createdAt": "string",
"createdBy": "string",
"iconId": "string",
"id": "string",
"name": "string"
}
Base callback URI for import operations
Configuration schema for this type, requests to create a source of this type should have a compliant 'config' field
Creation time
Service that created this type
Default Icon Id
Human-readable unique ID containing only lowercase letters and periods, neither starting nor ending with a period, and never having two consecutive periods
Unique Catalog Item Type name
The response to a catalog item upfront price request
{
"dailyAdditionalPrice": "number",
"dailyComputePrice": "number",
"dailyNetworkPrice": "number",
"dailyStoragePrice": "number",
"dailyTotalPrice": "number",
"resourcePriceDetails": [
{
"dailyAdditionalPrice": "number",
"dailyComputePrice": "number",
"dailyNetworkPrice": "number",
"dailyStoragePrice": "number",
"dailyTotalPrice": "number",
"resourceName": "string",
"resourceType": "string",
"resourceUpfrontPriceId": "string",
"status": "string",
"statusDetails": "string",
"unit": "string"
}
],
"status": "string",
"statusDetails": "string",
"unit": "string",
"upfrontPriceId": "string"
}
Additional Price incurred for the catalog.
Compute Price of the catalog.
Network Price of the catalog.
Storage Price of the catalog.
Total Price of the catalog.
Upfront price sync status
Upfront price status detail.
Monetary unit.
Id
Represents a version of a Catalog Item that can be requested by a consumer.
{
"createdAt": "string",
"description": "string",
"id": "string"
}
Created At
Description
Version ID
Input Schema
Represents a source of templates from which Catalog Items can be created
{
"createdAt": "string",
"createdBy": "string",
"description": "string",
"global": "boolean",
"iconId": "string",
"id": "string",
"itemsFound": "integer",
"itemsImported": "integer",
"lastImportCompletedAt": "string",
"lastImportErrors": [
"string"
],
"lastImportStartedAt": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"projectId": "string",
"typeId": "string"
}
Source custom configuration
Creation time
Created By
Catalog Source description
Global flag indicating that all the items can be requested across all projects.
Default Icon Id
Catalog Source id
Number of items found
Number of items imported.
Last import completion time
Last import error(s)
Last import start time
Update time
Updated By
Catalog Source name
Project id where the source belongs
Type of source, e.g. blueprint, CFT... etc
Represents a catalog item or content source that is linked to a project via an entitlement.
{
"description": "string",
"iconId": "string",
"id": "string",
"name": "string",
"numItems": "integer",
"sourceName": "string",
"sourceType": "string",
"type": "string"
}
Description of either the catalog item or the catalog source
Icon id of associated catalog item (if association is with catalog item)
Id of either the catalog source or catalog item.
Name of either the catalog item or the catalog source
Number of items in the associated catalog source
Catalog source name
Catalog source type
Content definition type
{
"description": "string",
"error": "string",
"id": "string",
"name": "string"
}
description
error
id
name
A group of resources such as machines, network, software, etc... typically provisioned together to deliver a complete/workable application.
{
"blueprintId": "string",
"blueprintVersion": "string",
"catalogItemId": "string",
"catalogItemVersion": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"iconId": "string",
"id": "string",
"lastRequest": {
"actionId": "string",
"approvedAt": "string",
"blueprintId": "string",
"cancelable": "boolean",
"catalogItemId": "string",
"completedAt": "string",
"completedTasks": "integer",
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"dismissed": "boolean",
"id": "string",
"initializedAt": "string",
"name": "string",
"parentId": "string",
"requestedBy": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"totalTasks": "integer",
"updatedAt": "string"
},
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"leaseExpireAt": "string",
"name": "string",
"orgId": "string",
"project": {
"id": "string",
"link": "string",
"name": "string"
},
"projectId": "string",
"resources": [
{
"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"
}
],
"status": "string"
}
Deployment blueprint id
Deployment blueprint version
Deployment catalog item id
Deployment catalog version
Creation time
Created by
Description of the deployment
Deployment icon id
Id of the deployment
The inputs that were used to request this deployment
Update time
Updated by
Lease expiration time
Name of the deployment
orgId
Deployment project id
Expanded resources for the deployment. Content of this property will not be maintained backward compatible
Deployment status.
Represents deployment events.
{
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"id": "string",
"name": "string",
"parentId": "string",
"resourceName": "string",
"resourceType": "string",
"updatedAt": "string"
}
Creation time (e.g. date format '2019-07-13T23:16:49.310Z').
Deployment id to which the event applies to
Longer user-friendly details of the event.
Event identifier
Short user-friendly label of the event (e.g. 'shuting down myVM')
Parent event/request identifier
Optional resource name to which the event applies to
Optional resource type to which the event applies to
Last update time (e.g. date format '2019-07-13T23:16:49.310Z').
Expense history of a deployment.
{
"currency": "string",
"data": [
{
"timestamp": "string",
"value": "number"
}
],
"interval": "string"
}
The currency code of the expense history.
The requested interval type.
Represents deployment requests.
{
"actionId": "string",
"approvedAt": "string",
"blueprintId": "string",
"cancelable": "boolean",
"catalogItemId": "string",
"completedAt": "string",
"completedTasks": "integer",
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"dismissed": "boolean",
"id": "string",
"initializedAt": "string",
"name": "string",
"parentId": "string",
"requestedBy": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"totalTasks": "integer",
"updatedAt": "string"
}
Identifier of the requested action
Time at which the request was approved.
Identifier of the requested blueprint in the form 'UUID:version'
Indicates whether request can be canceled or not.
Identifier of the requested catalog item in the form 'UUID:version'
Time at which the request completed.
The number of tasks completed while fulfilling this request.
Creation time (e.g. date format '2019-07-13T23:16:49.310Z').
Deployment id to which the event applies to
Longer user-friendly details of the event.
Indicates whether request is in dismissed state.
Event identifier
Time at which the request was initialized.
Request inputs
Short user-friendly label of the event (e.g. 'shuting down myVM')
Parent event/request identifier
User that initiated the request
Optional resource name to which the event applies to
Optional resource type to which the event applies to
Request overall execution status.
The total number of tasks need to be completed to fulfil this request.
Last update time (e.g. date format '2019-07-13T23:16:49.310Z').
A deployment update request
{
"description": "string",
"name": "string"
}
New description of the deployment
New name of the deployment
Represents an entitlement that is configured by admins to enforce user access to catalog items, services, etc., within their own organizations.
{
"definition": {
"description": "string",
"iconId": "string",
"id": "string",
"name": "string",
"numItems": "integer",
"sourceName": "string",
"sourceType": "string",
"type": "string"
},
"id": "string",
"projectId": "string"
}
Entitlement id
Project id
{
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
}
Additional expense incurred for the resource.
Expense sync message code if any.
Compute expense of the resource.
Last expense sync time.
Expense sync message if any.
Network expense of the resource.
Storage expense of the resource.
Total expense of the resource.
Monetary unit.
{
"content": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"empty": "boolean",
"filterType": "string",
"first": "boolean",
"id": "string",
"last": "boolean",
"name": "string",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
filterType
first
id
last
name
number
numberOfElements
size
totalElements
totalPages
{
"count": "integer",
"id": "string",
"name": "string"
}
count
id
name
{
"filters": [
{
"content": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"empty": "boolean",
"filterType": "string",
"first": "boolean",
"id": "string",
"last": "boolean",
"name": "string",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
]
}
{
"chargePeriod": "string",
"rate": "number"
}
chargePeriod
rate
{
"formURI": "string"
}
formURI
{
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
}
baseRate
chargeBasedOn
chargeOnPowerState
chargePeriod
fixedPrice
unit
Metering Assignment Strategy
{
"entityType": "string"
}
Metering Policy Assignment entityType(Strategy)
{
"itemName": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
}
}
itemName
{
"chargeModel": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"fixedPrice": {
"chargePeriod": "string",
"rate": "number"
},
"id": "string",
"lastUpdatedAt": "string",
"meteringItems": [
{
"itemName": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
}
}
],
"name": "string",
"namedMeteringItems": [
{
"itemName": "string",
"namedMeterings": [
{
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"name": "string"
}
]
}
],
"oneTimeMeteringItems": [
{
"itemName": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
}
}
],
"orgId": "string",
"pricingCardAssignmentInfo": {
"count": "integer",
"entityType": "string"
},
"tagBasedMeteringItems": [
{
"itemName": "string",
"tagBasedMeterings": [
{
"key": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"value": "string"
}
]
}
],
"tagBasedOneTimeMeteringItems": [
{
"itemName": "string",
"oneTimeMeterings": [
{
"key": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
},
"value": "string"
}
]
}
],
"tagBasedRateFactorItems": [
{
"itemName": "string",
"rateFactors": [
{
"key": "string",
"rateFactor": {
"contextMeteringItem": "string",
"rateFactor": "number"
},
"value": "string"
}
]
}
]
}
chargeModel
createdAt
createdBy
description
id
lastUpdatedAt
name
orgId
tagBasedOneTimeMeteringItems
Pricing card assignment for project/cloud zone
{
"createdAt": "string",
"entityId": "string",
"entityName": "string",
"entityType": "string",
"id": "string",
"lastUpdatedAt": "string",
"orgId": "string",
"pricingCardId": "string",
"pricingCardName": "string"
}
Creation time
Pricing card assigned entity id
Pricing card assigned entity name
Pricing card assigned entity type
Id of the pricingCardAssignment
Updated time
OrgId of the pricingCardAssignment
Pricing card id
Pricing card name
{
"count": "integer",
"entityType": "string"
}
count
entityType
{
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"name": "string"
}
name
{
"itemName": "string",
"namedMeterings": [
{
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"name": "string"
}
]
}
itemName
{
"oneTimeFixedPrice": "number"
}
oneTimeFixedPrice
{
"itemName": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
}
}
itemName
Project callback response containing count of deployments
{
"totalElements": "integer"
}
Count of the deployments
{
"content": [
{
"bulkRequestLimit": "integer",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"iconId": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"projectIds": [
"string"
],
"projects": [
{
"id": "string",
"link": "string",
"name": "string"
}
],
"sourceId": "string",
"sourceName": "string",
"type": {
"id": "string",
"link": "string",
"name": "string"
}
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"baseUri": "string",
"createdAt": "string",
"createdBy": "string",
"iconId": "string",
"id": "string",
"name": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"createdAt": "string",
"description": "string",
"id": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"createdAt": "string",
"createdBy": "string",
"description": "string",
"global": "boolean",
"iconId": "string",
"id": "string",
"itemsFound": "integer",
"itemsImported": "integer",
"lastImportCompletedAt": "string",
"lastImportErrors": [
"string"
],
"lastImportStartedAt": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"projectId": "string",
"typeId": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"blueprintId": "string",
"blueprintVersion": "string",
"catalogItemId": "string",
"catalogItemVersion": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"iconId": "string",
"id": "string",
"lastRequest": {
"actionId": "string",
"approvedAt": "string",
"blueprintId": "string",
"cancelable": "boolean",
"catalogItemId": "string",
"completedAt": "string",
"completedTasks": "integer",
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"dismissed": "boolean",
"id": "string",
"initializedAt": "string",
"name": "string",
"parentId": "string",
"requestedBy": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"totalTasks": "integer",
"updatedAt": "string"
},
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"leaseExpireAt": "string",
"name": "string",
"orgId": "string",
"project": {
"id": "string",
"link": "string",
"name": "string"
},
"projectId": "string",
"resources": [
{
"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"
}
],
"status": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"id": "string",
"name": "string",
"parentId": "string",
"resourceName": "string",
"resourceType": "string",
"updatedAt": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"chargeModel": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"fixedPrice": {
"chargePeriod": "string",
"rate": "number"
},
"id": "string",
"lastUpdatedAt": "string",
"meteringItems": [
{
"itemName": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
}
}
],
"name": "string",
"namedMeteringItems": [
{
"itemName": "string",
"namedMeterings": [
{
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"name": "string"
}
]
}
],
"oneTimeMeteringItems": [
{
"itemName": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
}
}
],
"orgId": "string",
"pricingCardAssignmentInfo": {
"count": "integer",
"entityType": "string"
},
"tagBasedMeteringItems": [
{
"itemName": "string",
"tagBasedMeterings": [
{
"key": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"value": "string"
}
]
}
],
"tagBasedOneTimeMeteringItems": [
{
"itemName": "string",
"oneTimeMeterings": [
{
"key": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
},
"value": "string"
}
]
}
],
"tagBasedRateFactorItems": [
{
"itemName": "string",
"rateFactors": [
{
"key": "string",
"rateFactor": {
"contextMeteringItem": "string",
"rateFactor": "number"
},
"value": "string"
}
]
}
]
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"createdAt": "string",
"entityId": "string",
"entityName": "string",
"entityType": "string",
"id": "string",
"lastUpdatedAt": "string",
"orgId": "string",
"pricingCardId": "string",
"pricingCardName": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"createdAt": "string",
"createdBy": "string",
"criteria": {
"matchExpression": [
{}
]
},
"description": "string",
"enforcementType": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"statistics": {
"conflictCount": "integer",
"enforcedCount": "integer",
"notEnforcedCount": "integer"
},
"typeId": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"description": "string",
"dryRunId": "string",
"dryRunSubTaskId": "string",
"id": "string",
"orgId": "string",
"policies": [
{
"enforcementType": "string",
"id": "string",
"name": "string",
"projectId": "string",
"rank": "integer",
"status": "string"
}
],
"projectId": "string",
"targetId": "string",
"targetName": "string",
"timestamp": "string",
"typeId": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"config": {
"enableDryRun": "boolean",
"enableEnforcementType": "boolean",
"enableUpdateNotification": "boolean"
},
"displayName": "string",
"id": "string",
"name": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"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": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"accountType": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"displayName": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"providerId": "string",
"updatedAt": "string",
"updatedBy": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
A policy such as lease policy that will be enforced.
{
"createdAt": "string",
"createdBy": "string",
"criteria": {
"matchExpression": [
{}
]
},
"description": "string",
"enforcementType": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"statistics": {
"conflictCount": "integer",
"enforcedCount": "integer",
"notEnforcedCount": "integer"
},
"typeId": "string"
}
createdAt
createdBy
definition
definitionLegend
description
Defines enforcement type for policy. Default is HARD
id
lastUpdatedAt
lastUpdatedBy
name
orgId
projectId
typeId
A decision made to enforce policies.
{
"description": "string",
"dryRunId": "string",
"dryRunSubTaskId": "string",
"id": "string",
"orgId": "string",
"policies": [
{
"enforcementType": "string",
"id": "string",
"name": "string",
"projectId": "string",
"rank": "integer",
"status": "string"
}
],
"projectId": "string",
"targetId": "string",
"targetName": "string",
"timestamp": "string",
"typeId": "string"
}
description
dryRunId
dryRunSubTaskId
effectivePolicyDefinition
id
orgId
projectId
targetId
targetName
timestamp
typeId
Element of a decision.
{
"enforcementType": "string",
"id": "string",
"name": "string",
"projectId": "string",
"rank": "integer",
"status": "string"
}
enforcementType
id
name
projectId
rank
status
{
"enableDryRun": "boolean",
"enableEnforcementType": "boolean",
"enableUpdateNotification": "boolean"
}
enableDryRun
enableEnforcementType
enableUpdateNotification
{
"conflictCount": "integer",
"enforcedCount": "integer",
"notEnforcedCount": "integer"
}
conflictCount
enforcedCount
notEnforcedCount
A type of policy that includes the schema of the policy itself and the schema of the objects affected by the policy
{
"config": {
"enableDryRun": "boolean",
"enableEnforcementType": "boolean",
"enableUpdateNotification": "boolean"
},
"displayName": "string",
"id": "string",
"name": "string"
}
Schema describing a policy object of this type
Policy type display-name/label
Policy type ID
Policy type name
Schema describing objects that can be affected by this policy
{
"contextMeteringItem": "string",
"rateFactor": "number"
}
contextMeteringItem
rateFactor
{
"key": "string",
"rateFactor": {
"contextMeteringItem": "string",
"rateFactor": "number"
},
"value": "string"
}
A resource part of a deployment.
{
"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"
}
Creation time
A list of other resources this resource depends on
A description of the resource
Unique identifier of the resource
metadata
Name of the resource
properties
The current state of the resource
The current sync status
Type of the resource
{
"actionType": "string",
"dependents": [
"string"
],
"description": "string",
"displayName": "string",
"formDefinition": {
"formURI": "string"
},
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"valid": "boolean"
}
Resource action type
Dependent resources
Resource action description
Resource action display name
Resource action id
Resource action name
Resource action org ID
Resource action project ID
Resource action input schema
Resource action is valid for current state
Represents a resource day-two request
{
"actionId": "string",
"reason": "string"
}
The id of the action to perform.
Resource action request inputs
Reason for requesting a day2 operation
{
"id": "string",
"link": "string",
"name": "string"
}
id
link
name
{
"accountType": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"displayName": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"providerId": "string",
"updatedAt": "string",
"updatedBy": "string"
}
Optional. Account type to which the resource type belongs to. Example: AWS, Azure etc
Time at which the resource type was created.
Name of the user who created the resource type.
Resource type description
Resource display name
Resource type id
Resource type name
Org ID where resource type belongs
Project ID where resource type belongs
Provider Id
Resource type schema
Time at which the resource type was updated.
Name of the user who updated the resource type.
{
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
}
empty
sorted
unsorted
{
"key": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"value": "string"
}
{
"itemName": "string",
"tagBasedMeterings": [
{
"key": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"value": "string"
}
]
}
itemName
{
"key": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
},
"value": "string"
}
key
value
{
"itemName": "string",
"oneTimeMeterings": [
{
"key": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
},
"value": "string"
}
]
}
itemName
{
"itemName": "string",
"rateFactors": [
{
"key": "string",
"rateFactor": {
"contextMeteringItem": "string",
"rateFactor": "number"
},
"value": "string"
}
]
}
itemName
A timeseries object containing timestamp and price value at the timestamp
{
"timestamp": "string",
"value": "number"
}
The timestamp of the metric.
The expense value at the timestamp.