VCDC Coordinator OpenAPI Data Structures
{
"code": "string",
"messageParameters": [
{}
],
"message": "string",
"localizedMessage": "string"
}Error code. It will be of format VCDC_some-number
messageParameters
Detailed error message.
Localized error message.
{
"id": "string",
"name": "string",
"description": "string",
"type": "string",
"timestamp": "string"
}URN ID of file
Filename of file
Description of the file
Type of the file
Timestamp of the file
{
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "url"
}URN ID for coordinator. This is immutable.
Display name.
Region where the coordinator is installed.
public URL to the coordinator service which manages the environment.
{
"metadata": {
"endpoint": "sample.endpoint.com",
"username": "serviceaccount",
"password": "samplesecret"
},
"name": "name",
"subType": "subType",
"id": "id",
"type": "type"
}URN ID for resource. This is immutable and will be ignored for all mutable method calls.
Display name.
The type of resource available.
An optional subtype for the resource, such as POSTGRES for DATABASE or EFS for STORAGE.
Free-form configuration object containing resource metadata.
{
"values": [
{
"metadata": {
"endpoint": "sample.endpoint.com",
"username": "serviceaccount",
"password": "samplesecret"
},
"name": "name",
"subType": "subType",
"id": "id",
"type": "type"
}
]
}{
"0": "E",
"1": "r",
"2": "r",
"3": "o",
"4": "r",
"5": "_",
"6": "a",
"7": "l",
"8": "l",
"9": "O",
"10": "f",
"11": " ",
"12": "O",
"13": "b",
"14": "j",
"15": "e",
"16": "c",
"17": "t",
"code": "string",
"messageParameters": [
{}
],
"message": "string",
"localizedMessage": "string"
}{
"type": "string",
"errors": [
"Error Object"
]
}Type of error.
{
"id": "string",
"eventName": "string",
"entityId": "string",
"environmentId": "string",
"timestamp": "string",
"providerId": "string",
"cspUserId": "string",
"message": "string"
}URN ID of event
Name of event
URN ID of entity associated with event
URN ID of environment where this event was recorded
Timestamp when event was registered
URN ID of provider for this event
URN ID of csp user for this event
Text message of event
{
"values": [
{
"id": "string",
"eventName": "string",
"entityId": "string",
"environmentId": "string",
"timestamp": "string",
"providerId": "string",
"cspUserId": "string",
"message": "string"
}
]
}{
"build": "string",
"sha": "string"
}Internal build number of the coordinator service.
Git SHA of the coordinator service.
A pre-defined operation and its required arguments associated with a template.
{
"operationType": "string",
"enabled": "boolean",
"name": "string",
"submit": "string",
"arguments": [
{
"id": "string",
"name": "string",
"description": "string",
"group": "string",
"type": "string",
"subType": "string",
"postValidate": "boolean",
"defaultValue": "string",
"required": "boolean",
"enabled": "boolean",
"validationRegex": "string"
}
]
}operationType
Whether the operation can currently be performed or not.
name
submit
{
"id": "string",
"name": "string",
"description": "string",
"group": "string",
"type": "string",
"subType": "string",
"postValidate": "boolean",
"defaultValue": "string",
"required": "boolean",
"enabled": "boolean",
"validationRegex": "string"
}URN for operation argument
Name for this operation argument
Description of this operation argument
Argument hierarchy
Type of this operation argument
Sub type for this operation argument.
Flag to indicate if changes to this field require recalculation of the config on the server.
Suggested value for the argument (Optional).
options
Is this a required OperationArgumentDefinition
Flag to indicate if this argument is required in the invocation request.
Optional regular expression to validate input
{
"operationType": "string"
}An operation and its arguments that can be invoked on an instance.
arguments
Response for operation validation request.
{
"complete": "boolean",
"errors": [
{
"code": "string",
"messageParameters": [
{}
],
"message": "string",
"localizedMessage": "string",
"argumentId": "string"
}
],
"operation": {
"operationType": "string",
"enabled": "boolean",
"name": "string",
"submit": "string",
"arguments": [
{
"id": "string",
"name": "string",
"description": "string",
"group": "string",
"type": "string",
"subType": "string",
"postValidate": "boolean",
"defaultValue": "string",
"required": "boolean",
"enabled": "boolean",
"validationRegex": "string"
}
]
}
}complete
{
"code": "string",
"messageParameters": [
{}
],
"message": "string",
"localizedMessage": "string",
"argumentId": "string"
}{
"argumentId": "string"
}identifier for argument.
{
"id": "string",
"instanceId": "string",
"updatedAt": "string",
"entityRef": "string",
"name": "string",
"displayName": "string",
"contentType": "string",
"links": "string",
"multisite": "boolean"
}URN of CDS object for a VCD Organization
URN of VCD instance containing this organization.
Instant when these org records were captured
VCD entity reference for this organization
Short org name of this organization
Human-readable name of this organization
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
true if this organization is not reachable directly by a CDS instance.
Raw organization object returned by VCD
{
"id": "string",
"name": "string",
"contentType": "string",
"links": "string",
"instanceId": "string",
"pvdcId": "string",
"organizationId": "string",
"updatedAt": "string",
"entityRef": "string",
"multisite": "boolean"
}URN of CDS object for a VCD Organization VDC
Human-readable name of this organization vdc
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
URN of VCD instance containing this organization
URN of VCD provider vcdc containing this org vdc
URN of VCD organization containing this vdc
Instant when these org vdc records were captured
VCD entity reference for this organization vdc
true if this organization is not reachable directly by a CDS instance
Raw organization vdc object returned by VCD
{
"id": "string",
"instanceId": "string",
"orgVdcId": "string",
"orgVdcName": "string",
"contentType": "string",
"links": "string",
"updatedAt": "string",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"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 CDS org VDC Stats Object
URN of VCD instance containing this org vdc
URN ID of org VDC this relates to.
Human-readable name of this organization vdc this relates to.
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
Instant when these stats were captured
Number of external networks attached to this org vdc
Number of VApps deployed in this org vdc
Number of VMs in VApps deployed in this org vdc
Raw organization vdc object returned by VCD
allocation Model for vdc resource allocation
{
"values": [
{
"id": "string",
"instanceId": "string",
"orgVdcId": "string",
"orgVdcName": "string",
"contentType": "string",
"links": "string",
"updatedAt": "string",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"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",
"name": "string",
"contentType": "string",
"links": "string",
"instanceId": "string",
"pvdcId": "string",
"organizationId": "string",
"updatedAt": "string",
"entityRef": "string",
"multisite": "boolean"
}
]
}{
"values": [
{
"id": "string",
"instanceId": "string",
"updatedAt": "string",
"entityRef": "string",
"name": "string",
"displayName": "string",
"contentType": "string",
"links": "string",
"multisite": "boolean"
}
]
}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 age content.
{
"id": "string",
"instanceId": "string",
"entityRef": "string",
"name": "string",
"contentType": "string",
"links": "string",
"multisite": "boolean"
}URN of CDC provider VDC Object
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",
"instanceId": "string",
"pvdcId": "string",
"updatedAt": "string",
"contentType": "string",
"links": "string",
"hosts": "integer",
"cores": "integer",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"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 CDS provider VDC Stats Object
URN of VCD instance containing this org vdc
URN ID of provider VDC this relates to.
Instant when these stats were captured
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
Number of hosts 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
Raw organization vdc object returned by VCD
{
"values": [
{
"id": "string",
"instanceId": "string",
"pvdcId": "string",
"updatedAt": "string",
"contentType": "string",
"links": "string",
"hosts": "integer",
"cores": "integer",
"networks": "integer",
"vapps": "integer",
"vappVms": "integer",
"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",
"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",
"name": "string",
"contentType": "string",
"links": "string",
"instanceId": "string",
"entityRef": "string"
}URN id of CDC Sddc Object
Human-readable name of this Sddc
Content-type returned by VCD (includes api version)
Http links for this entity returnd by VCD
URN of VCD instance containing this Sddc.
VCD entity reference for this Sddc
Raw Sddc object returned by VCD
{
"values": [
{
"id": "string",
"name": "string",
"contentType": "string",
"links": "string",
"instanceId": "string",
"entityRef": "string"
}
]
}{
"id": "string",
"name": "string",
"entityId": "string",
"entityName": "string",
"ownerId": "string",
"userId": "string",
"steps": "string",
"status": "string",
"startTime": "string",
"endTime": "string",
"queuedTime": "string",
"message": "string",
"isolation": "string",
"output": {
"providerAdminUsername": "administrator",
"providerAdminPassword": "mysecretpassword"
},
"activity": "string"
}URN ID of task
name of task.
URN ID of entity for which task is created.
Name of the entity at the time the task was created.
URN ID of the organization for this task.
Username of the user who initiated the task.
represents current_running_step/total_steps by this task.
Describe current status of task.
Start time for task.
Finish time for task
The time the initial request for the task was queued.
Progress or error messages.
isolation
Free-form configuration object.
URN of the activity that corresponds to this Task
A list of tasks
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"name": "string",
"entityId": "string",
"entityName": "string",
"ownerId": "string",
"userId": "string",
"steps": "string",
"status": "string",
"startTime": "string",
"endTime": "string",
"queuedTime": "string",
"message": "string",
"isolation": "string",
"output": {
"providerAdminUsername": "administrator",
"providerAdminPassword": "mysecretpassword"
},
"activity": "string"
}
]
}{
"values": [
{
"id": "string",
"name": "string",
"entityId": "string",
"entityName": "string",
"ownerId": "string",
"userId": "string",
"steps": "string",
"status": "string",
"startTime": "string",
"endTime": "string",
"queuedTime": "string",
"message": "string",
"isolation": "string",
"output": {
"providerAdminUsername": "administrator",
"providerAdminPassword": "mysecretpassword"
},
"activity": "string"
}
]
}{
"name": "string",
"stations": [
"string"
]
}Name of the vCD upgrade track.
vCD upgrade track and stations.
Connection statistics for a particular instance.
{
"id": "string",
"instanceId": "string",
"checkTime": "string",
"durationSinceLastCheck": "number",
"unavailable": "number",
"source": "string",
"internal": "boolean",
"responseTime": "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
Millis for round trip, or average if rolled up
If instance was reachable during this check
{
"values": [
{
"id": "string",
"instanceId": "string",
"checkTime": "string",
"durationSinceLastCheck": "number",
"unavailable": "number",
"source": "string",
"internal": "boolean",
"responseTime": "number",
"reachable": "boolean"
}
]
}{
"id": "string",
"name": "string",
"ownerId": "string",
"environmentId": "string",
"password": "string",
"domain": "string",
"publicCertificate": "string",
"activeTask": {
"id": "string",
"name": "string",
"entityId": "string",
"entityName": "string",
"ownerId": "string",
"userId": "string",
"steps": "string",
"status": "string",
"startTime": "string",
"endTime": "string",
"queuedTime": "string",
"message": "string",
"isolation": "string",
"output": {
"providerAdminUsername": "administrator",
"providerAdminPassword": "mysecretpassword"
},
"activity": "string"
},
"environment": {
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "url"
},
"environmentSettings": [
{
"id": "string",
"name": "string",
"type": "string",
"subType": "string"
}
],
"statistics": [
{
"type": "string",
"value": "number",
"max": "number"
}
],
"upgradeAfter": "string",
"upgradeCategory": "string",
"oauthClientId": "string"
}URN ID of vCD instance. This is immutable.
Name of vCD instance.
URN ID of the organization for this task.
URN ID of environment. This is immutable.
Provider administrator password for vCD instance. Password must follow the following rules:
- At least one lowercase letter.
- At least one digit i.e. 0-9.
- At least one special character
- At least one capital letter.
- Minimum 6 letters to maximum 128 This value is input only, the password cannot be retrieved via the API.
The public domain of the instance (e.g. vcd.acme.example).
Free-form configuration object.
Base64 encoded public certificate associated with this instance.
Date which upgrade should be performed after
Category that defines the upgrade strategy
ID of Oauth Client used by the instance's system org. Null if the instance's system org hasn't been integrated with CSP.
{
"id": "string",
"name": "string",
"type": "string",
"subType": "string"
}URN ID of vCD resource instance. This is immutable.
Name of vCD resource instance.
The major type of the resource.
The sub-type of the resource.
Statistics for a particular instance.
{
"type": "string",
"value": "number",
"max": "number"
}The type of the statistics represented.
The current value of the statistic.
The maximum value of the statistic.
A paginated list of VcdInstances
{
"resultTotal": "integer",
"pageCount": "integer",
"page": "integer",
"pageSize": "integer",
"valueType": "string",
"values": [
{
"id": "string",
"name": "string",
"ownerId": "string",
"environmentId": "string",
"password": "string",
"domain": "string",
"publicCertificate": "string",
"activeTask": {
"id": "string",
"name": "string",
"entityId": "string",
"entityName": "string",
"ownerId": "string",
"userId": "string",
"steps": "string",
"status": "string",
"startTime": "string",
"endTime": "string",
"queuedTime": "string",
"message": "string",
"isolation": "string",
"output": {
"providerAdminUsername": "administrator",
"providerAdminPassword": "mysecretpassword"
},
"activity": "string"
},
"environment": {
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "url"
},
"environmentSettings": [
{
"id": "string",
"name": "string",
"type": "string",
"subType": "string"
}
],
"statistics": [
{
"type": "string",
"value": "number",
"max": "number"
}
],
"upgradeAfter": "string",
"upgradeCategory": "string",
"oauthClientId": "string"
}
]
}{
"values": [
{
"id": "string",
"name": "string",
"ownerId": "string",
"environmentId": "string",
"password": "string",
"domain": "string",
"publicCertificate": "string",
"activeTask": {
"id": "string",
"name": "string",
"entityId": "string",
"entityName": "string",
"ownerId": "string",
"userId": "string",
"steps": "string",
"status": "string",
"startTime": "string",
"endTime": "string",
"queuedTime": "string",
"message": "string",
"isolation": "string",
"output": {
"providerAdminUsername": "administrator",
"providerAdminPassword": "mysecretpassword"
},
"activity": "string"
},
"environment": {
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "url"
},
"environmentSettings": [
{
"id": "string",
"name": "string",
"type": "string",
"subType": "string"
}
],
"statistics": [
{
"type": "string",
"value": "number",
"max": "number"
}
],
"upgradeAfter": "string",
"upgradeCategory": "string",
"oauthClientId": "string"
}
]
}