vcdc operator OpenAPI Data Structures
{
"id": "string",
"name": "string"
}
URN ID of CSP organization. This is immutable.
Name of CSP organization. This is immutable.
{
"type": "string",
"fixableByCurrentUser": "boolean"
}
The type of the configuration issue.
True if the current user can perform an action to fix this issue.
{
"issues": [
{
"type": "string",
"fixableByCurrentUser": "boolean"
}
]
}
{
"id": "string"
}
URN ID of CSP organization. This is immutable.
{
"values": [
{
"id": "string",
"name": "string"
}
]
}
{
"initial": false,
"service": "https://openapi-generator.tech",
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "https://openapi-generator.tech",
"enabled": true
}
URN ID for coordinator. This is immutable.
Display name.
Region where the coordinator is installed.
External coordinator URI endpoint, configured on the Ingress resource. Empty if the coordinator is not reachable externally.
Internal coordinator URI endpoint, configured on the Service resource. Empty unless your role allows it.
Whether the environment is currently enabled (it could, e.g., be under maintenance)
Can this Environment be assigned to Organizations registering for the first time
A list of coordinators
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"initial": false,
"service": "https://openapi-generator.tech",
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "https://openapi-generator.tech",
"enabled": true
}
]
}
{
"values": [
{
"initial": false,
"service": "https://openapi-generator.tech",
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "https://openapi-generator.tech",
"enabled": true
}
]
}
{
"code": "string",
"messageParameters": [
{}
],
"message": "string",
"localizedMessage": "string",
"type": "string",
"errors": [
"Error Object"
]
}
Error code. It will be of format VCDC_some-number
messageParameters
Detailed error message.
Localized error message.
Type of error.
{
"build": "string",
"sha": "string"
}
Internal build number of the operator service.
Git SHA of the operator service.
{
"appId": "string",
"appSecret": "string"
}
ID of the OAuth App as known to CSP.
The app secret for this OAuth App. This cannot be retrieved, only updated.
{
"hidden": false,
"identity_keys": "identity_keys",
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "https://openapi-generator.tech",
"local": false
}
URN ID for operator. This is immutable.
Display name.
Region where the operator is installed.
External operator URI endpoint, configured on the Ingress resource.
identity_keys of the operator.
Whether the operator is local to this location
Whether the operator is currently hidden (it could, e.g., be under maintenance)
{
"values": [
{
"hidden": false,
"identity_keys": "identity_keys",
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "https://openapi-generator.tech",
"local": false
}
]
}
{
"id": "string",
"phonehomeKey": "string",
"instanceId": "string",
"pvdcId": "string",
"organizationId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string"
}
URN ID of organization VDC
Identifier used for VMware telemetry.
URN of VCD instance containing this provider VDC.
URN ID of provider VDC containing this organization VDC.
URN ID of organization containing this organization VDC.
VCD entity reference for this provider VDC
Human-readable name of this provider VDC
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
Raw OrgVdc object returned by VCD
{
"id": "string",
"ovdcId": "string",
"instanceId": "string",
"updatedAt": "string",
"cores": "integer",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"contentType": "string",
"links": "string",
"allocationModel": "integer",
"storage": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"vcpu": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"ram": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
}
}
URN ID of the record
URN ID of provider VDC this relates to.
URN of VCD instance containing this provider VDC.
Instant when these stats were captured
Number of CPU cores attached to this PVDC
Number of external networks attached to this PVDC
Number of VApps deployed in this PVDC
Number of VMs in VApps deployed in this PVDC
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
allocation Model for vdc resource allocation
Raw ProviderVdc object returned by VCD
A page of organization VDC Statistics
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"ovdcId": "string",
"instanceId": "string",
"updatedAt": "string",
"cores": "integer",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"contentType": "string",
"links": "string",
"allocationModel": "integer",
"storage": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"vcpu": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"ram": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
}
}
]
}
{
"values": [
{
"id": "string",
"ovdcId": "string",
"instanceId": "string",
"updatedAt": "string",
"cores": "integer",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"contentType": "string",
"links": "string",
"allocationModel": "integer",
"storage": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"vcpu": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"ram": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
}
}
]
}
A page of organization VDCs
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"phonehomeKey": "string",
"instanceId": "string",
"pvdcId": "string",
"organizationId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string"
}
]
}
{
"values": [
{
"id": "string",
"phonehomeKey": "string",
"instanceId": "string",
"pvdcId": "string",
"organizationId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string"
}
]
}
Collection of paging-related metadata to be included by composition via allOf. This type should be included in pageable responses to avoid duplicating these common properties. It is intended to be included by composition rather than inheritance. Because of this, it has no discriminator and should be embedded via allOf. See QueryResults for a reference usage.
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string"
}
How many results there are in total (i.e., considering all pages).
How many pages there are in total.
The page that was fetched, 1-indexed.
Result count for page that was fetched.
Expected type of the page content.
{
"id": "string",
"instanceId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string",
"multisite": "boolean"
}
URN of provider VDC
URN of VCD instance containing this provider VDC.
VCD entity reference for this provider VDC
Human-readable name of this provider VDC
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
true if this PVDC is not reachable directly by a CDS instance.
Raw ProviderVdc object returned by VCD
{
"id": "string",
"pvdcId": "string",
"updatedAt": "string",
"hosts": "integer",
"vcpus": "integer",
"cores": "integer",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"contentType": "string",
"links": "string",
"storage": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"cpu": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"ram": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
}
}
URN ID of the record
URN ID of provider VDC this relates to.
Instant when these stats were captured
Number of hosts attached to this PVDC
Number of virtual CPUs attached to this PVDC
Number of CPU cores attached to this PVDC
Number of external networks attached to this PVDC
Number of VApps deployed in this PVDC
Number of VMs in VApps deployed in this PVDC
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
A page of provider VDC Statistics
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"pvdcId": "string",
"updatedAt": "string",
"hosts": "integer",
"vcpus": "integer",
"cores": "integer",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"contentType": "string",
"links": "string",
"storage": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"cpu": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"ram": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
}
}
]
}
{
"values": [
{
"id": "string",
"pvdcId": "string",
"updatedAt": "string",
"hosts": "integer",
"vcpus": "integer",
"cores": "integer",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"contentType": "string",
"links": "string",
"storage": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"cpu": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
},
"ram": {
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
}
}
]
}
A page of provider VDCs
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"instanceId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string",
"multisite": "boolean"
}
]
}
{
"values": [
{
"id": "string",
"instanceId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string",
"multisite": "boolean"
}
]
}
{
"unit": "string",
"limit": "number",
"allocated": "number",
"used": "number"
}
Units of this resource
number of units of this resource allowed to be used.
number of units of this resource guaranteed to be available.
number of units of this resource used at this moment.
{
"id": "string",
"pvdcId": "string",
"telemetryId": "string",
"cspOrganization": "string",
"directUrl": "string",
"name": "string",
"contentType": "string",
"links": "string",
"entityRef": "string",
"instanceId": "string"
}
URN ID of this record
URN ID of provider VDC containing this SDDC / vSphere.
Identifier of the SDDC used for VMware telemetry.
CSP organization ID where the VMC is deployed.
Raw Sddc object returned by VCD
URL to reach the SDDC
Human-readable name of this SDDC / vSphere
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
VCD entity reference for this Sddc
URN of VCD instance containing this Sddc.
A page of SDDC details.
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"pvdcId": "string",
"telemetryId": "string",
"cspOrganization": "string",
"directUrl": "string",
"name": "string",
"contentType": "string",
"links": "string",
"entityRef": "string",
"instanceId": "string"
}
]
}
{
"values": [
{
"id": "string",
"pvdcId": "string",
"telemetryId": "string",
"cspOrganization": "string",
"directUrl": "string",
"name": "string",
"contentType": "string",
"links": "string",
"entityRef": "string",
"instanceId": "string"
}
]
}
Connection statistics for a particular instance.
{
"id": "string",
"instanceId": "string",
"checkTime": "string",
"durationSinceLastCheckInSec": "number",
"unavailableInSec": "number",
"source": "string",
"internal": "boolean",
"responseTimeInMillis": "number",
"reachable": "boolean"
}
URN ID of the record
URN ID of VCD instance this relates to.
Instant when these stats were captured
Seconds for duration since last check
Seconds for unavailability since last check
Identifier of the connection source
true if using internal networking | false if using ingress connection
Seconds for round trip, or average if rolled up
If instance was reachable during this check
A paginated list of VcdConnectionStatistic
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"instanceId": "string",
"checkTime": "string",
"durationSinceLastCheckInSec": "number",
"unavailableInSec": "number",
"source": "string",
"internal": "boolean",
"responseTimeInMillis": "number",
"reachable": "boolean"
}
]
}
{
"id": "string",
"name": "string",
"telemetryId": "string",
"publicCertificate": "string",
"groupId": "string"
}
URN ID of vCD instance.
Name of vCD instance.
Identifer used by VMware telemetry.
Base64 encoded public certificate associated with this instance.
URN ID of virtual multi-site group containing all instance linked through multisite.
A paginated list of VcdInstanceStatistic
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"instanceId": "string",
"checkTime": "string",
"durationSinceLastCheckInSec": "number",
"unavailableInSec": "number",
"source": "string",
"internal": "boolean",
"responseTimeInMillis": "number",
"reachable": "boolean"
}
]
}
{
"values": [
{
"id": "string",
"instanceId": "string",
"checkTime": "string",
"durationSinceLastCheckInSec": "number",
"unavailableInSec": "number",
"source": "string",
"internal": "boolean",
"responseTimeInMillis": "number",
"reachable": "boolean"
}
]
}
A paginated list of VcdInstances
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"name": "string",
"telemetryId": "string",
"publicCertificate": "string",
"groupId": "string"
}
]
}
{
"values": [
{
"id": "string",
"name": "string",
"telemetryId": "string",
"publicCertificate": "string",
"groupId": "string"
}
]
}
{
"id": "string",
"instanceId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string",
"groupId": "string"
}
URN ID of VCD organization
URN ID of VCD instance containing this organization.
VCD entity reference for this provider VDC
Human-readable name of this provider VDC
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
Raw Org object returned by VCD
URN ID of virtual organization group containing this organization and all organizations linked through multisite.
A page of provider VDC
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"instanceId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string",
"groupId": "string"
}
]
}
{
"values": [
{
"id": "string",
"instanceId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string",
"groupId": "string"
}
]
}