VMware Cloud Assembly IaaS API Data Structures
State object representing an about page that includes api versioning information
{
"supportedApis": [
{
"apiVersion": "string",
"documentationLink": "string",
"deprecationPolicy": {
"deprecatedAt": "string",
"expiresAt": "string",
"description": "string"
}
}
],
"latestApiVersion": "string"
}
A collection of all currently supported api versions.
The latest version of the API in yyyy-MM-dd format (UTC).
{
"apiVersion": "string",
"documentationLink": "string",
"deprecationPolicy": {
"deprecatedAt": "string",
"expiresAt": "string",
"description": "string"
}
}
The version of the API in yyyy-MM-dd format (UTC).
The link to the documentation of this api version
Entity that holds auth token details.
{
"tokenType": "Bearer",
"token": "string"
}
Type of the token.
Base64 encoded auth token.
Defines a structure that holds list of storage policies defined for AWS for a specific region.HATEOAS links:
region - Region - Region for the profile.
self - AwsStorageProfile - Self link to this aws Storage Profile
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"deviceType": "ebs / instance-store",
"volumeType": "gp2 / io1 / sc1 / st1 / standard",
"iops": "2000",
"externalRegionId": "us-east-1"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates whether this storage profile is default or not..
Indicates whether this storage profile supports encryption or not.
Indicates the type of storage device.
Indicates the type of volume associated with type of storage device.
Indicates maximum I/O operations per second in range(1-20,000).
The id of the region for which this profile is defined
Defines a structure that holds list of storage policies defined for Azure for a specific region.HATEOAS links:
storage-account - FabricAzureStorageAccount - Storage account for the profile.
region - Region - Region for the profile.
self - AzureStorageProfile - Self link to this Azure storage profile.
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"diskType": "Standard_LRS / Premium_LRS",
"osDiskCaching": "None / ReadOnly / ReadWrite",
"dataDiskCaching": "None / ReadOnly / ReadWrite",
"externalRegionId": "uswest"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage profile contains default storage properties.
Indicates whether this storage profile should support encryption or not.
Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.
Indicates the caching mechanism for OS disk. Default policy for OS disks is Read/Write.
Indicates the caching mechanism for additional disk.
The id of the region for which this profile is defined
State object representing a block device.
HATEOAS links:
cloud-accounts - array[CloudAccount] - Cloud accounts where this disk is provisioned.
self - BlockDevice - Self link to this block device
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9e49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
"string"
],
"capacityInGB": 10,
"status": "ATTACHED",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The id of the project this entity belongs to.
The external zoneId of the resource.
The external regionId of the resource
Set of ids of the cloud accounts this entity belongs to.
Capacity of the block device in GB.
Status of the block device
A set of tag keys and optional values that were set on this resource instance.
Additional properties that may be used to extend the base type.
State object representing a query result of block device.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9e49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
"string"
],
"capacityInGB": 10,
"status": "ATTACHED",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
{
"name": "string",
"projectId": "e058",
"description": "string",
"capacityInGB": 78,
"encrypted": true,
"sourceReference": "ami-0d4cfd66",
"diskContentBase64": "dGVzdA",
"constraints": [
{
"mandatory": "boolean",
"expression": "ha:strong"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
The id of the project the current user belongs to.
A human-friendly description.
Capacity of the block device in GB.
Indicates whether the block device should be encrypted or not.
Reference to URI using which the block device has to be created.
Content of a disk, base64 encoded.
Additional custom properties that may be used toextend the block device.
Constraints that are used to drive placement policies for the block device that is produced from this specification. Constraint expressions are matched against tags on existing placement targets.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
State object representing a cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
associated-cloud-accounts - array[CloudAccount] - Cloud accounts associated to this cloud account. For example an NSX endpoint linked to a vSphere cloud account.
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccount - Self link to this cloud account
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Cloud account type
Cloud account specific properties
A set of region names to enable provisioning on.
Additional properties that may be used to extend the base type.
State object representing a AWS cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountAws - Self link to this cloud account
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"accessKeyId": "KLIKJ7EA4PPDZR7T7Z6K",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Access key id for Aws.
A set of region names that are enabled for this cloud account.
Additional properties that may be used to extend the base type.
State object representing a query result of Aws cloud accounts.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"accessKeyId": "KLIKJ7EA4PPDZR7T7Z6K",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for a Amazon cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"name": "string",
"description": "string",
"accessKeyId": "ACDC55DB4MFH6ADG75KK",
"secretAccessKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
"regionIds": [
"string"
],
"createDefaultZones": true,
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Aws Access key ID
Aws Secret Access Key
A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-aws/region-enumeration..
Create default cloud zones for the enabled regions.
State object representing an Azure cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountAzure - Self link to this cloud account
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"subscriptionId": "f3c86a85-e379-42ae-a8ba-7a51382d6dd7",
"tenantId": "027f73d5-0a19-452e-9d45-775693421508",
"clientApplicationId": "66f277f2-ff12-4c3a-a4c9-b13d131a9a4d",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Azure Subscription IDaccount.
Azure Tenant Idaccount.
Azure Client Application IDaccount.
A set of region names that are enabled for this cloud account.
Additional properties that may be used to extend the base type.
A set of tag keys and optional values that were set on on the Cloud Account
State object representing a query result of Azure cloud accounts.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"subscriptionId": "f3c86a85-e379-42ae-a8ba-7a51382d6dd7",
"tenantId": "027f73d5-0a19-452e-9d45-775693421508",
"clientApplicationId": "66f277f2-ff12-4c3a-a4c9-b13d131a9a4d",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for a Azure cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"name": "string",
"description": "string",
"subscriptionId": "064865b2-e914-4717-b415-8806d17948f7",
"tenantId": "9a13d920-4691-4e2d-b5d5-9c4c1279bc9a",
"clientApplicationId": "3287dd6e-76d8-41b7-9856-2584969e7739",
"clientApplicationSecretKey": "GDfdasDasdASFas321das32cas2x3dsXCSA76xdcasg=",
"regionIds": [
"string"
],
"createDefaultZones": true,
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Azure Subscribtion ID
Azure Tenant ID
Azure Client Application ID
Azure Client Application Secret Key
A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-azure/region-enumeration..
Create default cloud zones for the enabled regions.
State object representing a GCP cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountGcp - Self link to this cloud account
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"projectId": "example-gcp-project",
"privateKeyId": "027f73d50a19452eedf5775a9b42c5083678abdf",
"clientEmail": "[email protected]",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
GCP Project ID
GCP Private key ID
GCP Client email
A set of region names that are enabled for this
Additional properties that may be used to extend the base type.
A set of tag keys and optional values that were set on on the Cloud Account
State object representing a query result of GCP cloud accounts.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"projectId": "example-gcp-project",
"privateKeyId": "027f73d50a19452eedf5775a9b42c5083678abdf",
"clientEmail": "[email protected]",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for a GCP cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region where the associated cloud account resources are hosted.
{
"name": "string",
"description": "string",
"projectId": "example-gcp-project",
"privateKeyId": "027f73d50a19452eedf5775a9b42c5083678abdf",
"privateKey": "-----BEGIN PRIVATE KEY-----\nMIICXgIHAASBgSDHikastc8+I81zCg/qWW8dMr8mqvXQ3qbPAmu0RjxoZVI47tvs\nkYlFAXOf0sPrhO2nUuooJngnHV0639iTTEYG1vckNaW2R6U5QTdQ5Rq5u+uV3pMk\n7w7Vs4n3urQ4jnqt7rTXbC1DNa/PFeAZatbf7ffBBy0IGO0zc128IshYcwIDAQAB\nAoGBALTNl2JxTvq4SDW/3VH0fZkQXWH1MM10oeMbB2qO5beWb11FGaOO77nGKfWc\nbYgfp5Ogrql2yhBvLAXnxH8bcqqwORtFhlyV68U1y4R+8WxDNh0aevxH8hRS/1X5\n963DJm1JlU0E+vStiktN0tC3ebH5hE+1OxbIHSZ+WOWLYX7JAkEA5uigRgKp8ScG\nauUijvdOLZIhHWq9y5Wz+nOHUuDw8P7wOTKU34QJAoWEe771p9Pf/GTA/kr0BQnP\nQvWUDxGzJwJBAN05C6krwPeryFKrKtjOGJIbiIoY72wRnoNcdEEs3HDRhf48YWFo\nriRbZylzzzNFy/gmzT6XJQTfktGqq+FZD9UCQGIJaGrxHJgfmpDuAhMzGsUsYtTr\niRox0D1Iqa7dhE693t5aBG010OF6MLqdZA1CXrn5SRtuVVaCSLZEL/2J5UcCQQDA\nd3MXucNnN4NPuS/L9HMYJWD7lPoosaORcgyK77bSSNgk+u9WSjbH1uYIAIPSffUZ\nbti+jc2dUg5wb+aeZlgJAkEAurrpmpqj5vg087ZngKfFGR5rozDiTsK5DceTV97K\na1Y+Nzl+XWTxDBWk4YPh2ZlKv402hZEfWBYxUDn5ZkH/bw==\n-----END PRIVATE KEY-----\n",
"clientEmail": "[email protected]",
"regionIds": [
"string"
],
"createDefaultZones": true,
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
GCP Project ID
GCP Private key ID
GCP Private key
GCP Client email
A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-gcp/region-enumeration.
Create default cloud zones for the enabled regions.
State object representing an Nsx-T cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
self - CloudAccountNsxT - Self link to this cloud account
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"hostName": "nsxt.vmware.com",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Host name for the Nsx-T cloud account
Identifier of a data collector vm deployed in the on premise infrastructure.
Username to authenticate with the cloud account
Additional properties that may be used to extend the base type.
State object representing a query result of Nsx-T cloud accounts.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"hostName": "nsxt.vmware.com",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for an Nsx-T cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"name": "string",
"description": "string",
"hostName": "nsxt.mycompany.com",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"password": "cndhjslacd90ascdbasyoucbdh",
"acceptSelfSignedCertificate": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Host name for the Nsx-T endpoint
Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors
Username to authenticate with the cloud account
Password for the user used to authenticate with the cloud Account
Accept self signed certificate when connecting.
State object representing an Nsx-V cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
self - CloudAccountNsxV - Self link to this cloud account
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"hostName": "nsxv.vmware.com",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Host name for the Nsx-V cloud account
Identifier of a data collector vm deployed in the on premise infrastructure.
Username to authenticate with the cloud account
Additional properties that may be used to extend the base type.
State object representing a query result of Nsx-V cloud accounts.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"hostName": "nsxv.vmware.com",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for an Nsx-V cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"name": "string",
"description": "string",
"hostName": "nsxv.mycompany.com",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"password": "cndhjslacd90ascdbasyoucbdh",
"acceptSelfSignedCertificate": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Host name for the Nsx-T endpoint
Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors
Username to authenticate with the cloud account
Password for the user used to authenticate with the cloud Account
Accept self signed certificate when connecting.
State object representing a cloud account region.
{
"externalRegionIds": [
"string"
]
}
A set of region ids for the cloud account.
State object representing a query result of cloud accounts.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for a generic cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"name": "string",
"description": "string",
"cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
"privateKeyId": "ACDC55DB4MFH6ADG75KK",
"privateKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
"associatedCloudAccountIds": [
"string"
],
"regionIds": [
"string"
],
"createDefaultZones": true,
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Cloud account type
Access key id or username to be used to authenticate with the cloud account
Secret access key or password to be used to authenticate with the cloud account
Cloud account to link with this cloud account
Cloud Account specific properties supplied in as name value pairs
Additional custom properties that may be used toextend the Cloud Account.
A set of Region names to enable provisioning on.Refer to /iaas/cloud-accounts/region-enumeration.
Create default cloud zones for the enabled regions.
State object representing a vSphere cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountVsphere - Self link to this cloud account.
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"hostName": "vc1.vmware.com",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Host name for the vSphere cloud account
Identifier of a data collector vm deployed in the on premise infrastructure.
Username to authenticate with the cloud account
A set of region names that are enabled for this cloud account.
Additional properties that may be used to extend the base type.
State object representing a query result of vSphere cloud accounts.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"hostName": "vc1.vmware.com",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"enabledRegionIds": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for a vSphere cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"name": "string",
"description": "string",
"hostName": "vc.mycompany.com",
"acceptSelfSignedCertificate": "boolean",
"associatedCloudAccountIds": [
"string"
],
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"username": "[email protected]",
"password": "cndhjslacd90ascdbasyoucbdh",
"regionIds": [
"string"
],
"createDefaultZones": true,
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Host name for the vSphere endpoint
Accept self signed certificate when connecting to vSphere
Cloud accounts to associate with this cloud account
Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors
Username to authenticate with the cloud account
Password for the user used to authenticate with the cloud Account
A set of datacenter managed object reference identifiers (MoRef) to enable provisioning on. Refer to /iaas/cloud-accounts-vsphere/region-enumeration.
Create default cloud zones for the enabled regions.
A constraint that is conveyed to the policy engine.
{
"mandatory": "boolean",
"expression": "ha:strong"
}
Indicates whether this constraint should be strictly enforced or not.
An expression of the form "[!]tag-key[:[tag-value]]", used to indicate a constraint match on keys and values of tags.
Specification for token retrieval request.
{
"refreshToken": "5e7c2c-9a9e-4b0-9339-a7f94"
}
Refresh token obtained from the UI
State object representing a data collector.
The data collector is an OVA tool that contains the credentials and protocols needed to create a connection between a data collector appliance on a host vCenter and a vCenter-based cloud account.
{
"dcId": "d5316b00-f3b8-4895-9e9a-c4b98649c2ca",
"ipAddress": "10.0.0.1",
"name": "Datacollector1",
"hostName": "dc1-lnd.mycompany.com",
"status": "ACTIVE, INACTIVE"
}
Data collector identifier
Ip Address of the data collector VM
Data collector name
Data collector host name
Current status of the data collector
Data collector registration object.
The supplied data collector is an OVA tool that contains the credentials and protocols needed to create a connection between a data collector appliance on a host vCenter and a vCenter-based cloud account. . The process of deploying data collector is:
1. Download the data collector ova from the "ovaLink".
2. Import the .ova file to the vCenter Server and start the installation.
3. When asked for the key, copy and use the "key" provided.
4. It takes a few minutes to detect your Data Collector after it is deployed and powered on in vCenter.
{
"ovaLink": "https://ci-data-collector.s3.amazonaws.com/VMware-Cloud-Services-Data-Collector.ova",
"key": "eyJyZWdpc3RyYXRpb25VcmwiOiJodHRwczovL2Fw"
}
Data collector OVA Link
A registration key for the data collector
State object representing a query result of data collectors.
{
"content": [
{
"dcId": "d5316b00-f3b8-4895-9e9a-c4b98649c2ca",
"ipAddress": "10.0.0.1",
"name": "Datacollector1",
"hostName": "dc1-lnd.mycompany.com",
"status": "ACTIVE, INACTIVE"
}
],
"totalElements": 1
}
Total number of elements
{
"deprecatedAt": "string",
"expiresAt": "string",
"description": "string"
}
The date the api was deprecated in yyyy-MM-dd format (UTC). Could be empty if the api is not deprecated.
The date the api support will be dropped in yyyy-MM-dd format (UTC). The api may still be available for use after that date but this is not guaranteed.
A free text description that contains information about why this api is deprecated and how to migrate to a newer version.
Specification for attaching disk to a machine
{
"name": "string",
"description": "string",
"blockDeviceId": "1298765"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of the existing block device
Represents a structure that holds details of Azure endpoint's storage account.
HATEOAS links:
region - Region - Region for the storage account.
self - FabricAzureStorageAccount - Self link to this storage account
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "Standard_LRS / Premium_LRS",
"externalRegionId": "westus",
"cloudAccountIds": [
"string"
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.
Indicates the ID of region.
Set of ids of the cloud accounts this entity belongs to.
State object representing a query result of Azure storage accounts.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "Standard_LRS / Premium_LRS",
"externalRegionId": "westus",
"cloudAccountIds": [
"string"
]
}
],
"totalElements": 1
}
Total number of elements
Represents a fabric flavor from the corresponding cloud end-point
{
"id": "i3.large",
"name": "i3.large",
"cpuCount": 2,
"memoryInMB": 15616,
"storageType": "NVMe_SSD",
"bootDiskSizeInMB": 486400,
"dataDiskSizeInMB": 486400,
"dataDiskMaxCount": 1,
"networkType": "Up to 10 Gigabit"
}
The internal identification used by the corresponding cloud end-point
The value of the instance type in the corresponding cloud.
Number of CPU cores. Not populated when inapplicable.
Total amount of memory (in megabytes). Not populated when inapplicable.
The type of storage supported by this instance type. Not populated when inapplicable.
Size of the boot disk (in megabytes). Not populated when inapplicable.
Size of the data disks (in megabytes). Not populated when inapplicable.
Number of data disks. Not populated when inapplicable.
The type of network supported by this instance type. Not populated when inapplicable.
Represents fabric flavor instance type description. Used when creating flavor profiles.
{
"name": "t2.small, t2.medium",
"cpuCount": 4,
"memoryInMB": 4096
}
The value of the instance type in the corresponding cloud. Valid and mandatory for public clouds
Number of CPU cores. Mandatory for private clouds such as vSphere. Not populated when inapplicable.
Total amount of memory (in megabytes). Mandatory for private clouds such as vSphere. Not populated when inapplicable.
State object representing a query result of fabric flavors.
{
"content": [
{
"id": "i3.large",
"name": "i3.large",
"cpuCount": 2,
"memoryInMB": 15616,
"storageType": "NVMe_SSD",
"bootDiskSizeInMB": 486400,
"dataDiskSizeInMB": 486400,
"dataDiskMaxCount": 1,
"networkType": "Up to 10 Gigabit"
}
],
"totalElements": 1
}
Total number of elements
Represents a fabric image from the corresponding cloud end-point.
HATEOAS links:
region - Region - Region for the image.
self - FabricImage - Self link to this image
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"osFamily": "linux, win",
"externalRegionId": "us-east-1",
"isPrivate": true,
"cloudAccountIds": [
"string"
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
Operating System family of the image.
The regionId of the image
Additional properties that may be used to extend the base type.
Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library Items
Set of ids of the cloud accounts this entity belongs to.
Represents fabric image description. Used when creating image profiles.
{
"id": "9e49",
"name": "ami-ubuntu-16.04-1.9.1-00-1516139717",
"cloudConfig": "runcmd:\n - [\"mkdir\", \"/imageFolder\"]"
}
The id of the fabric image
Fabric image name. Valid if id not provided.
Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification.
State object representing a query result of fabric images.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"osFamily": "linux, win",
"externalRegionId": "us-east-1",
"isPrivate": true,
"cloudAccountIds": [
"string"
]
}
],
"totalElements": 1
}
Total number of elements
State object representing a network on a external cloud provider.
HATEOAS links:
region - Region - Region for the network.
self - FabricNetwork - Self link to this network
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"isPublic": "boolean",
"isDefault": "boolean",
"cidr": "10.1.2.0/24",
"externalRegionId": "us-east-1",
"tags": [
{
"key": "string",
"value": "string"
}
],
"cloudAccountIds": [
"string"
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
Indicates whether the sub-network supports public IP assignment.
Indicates whether this is the default subnet for the zone.
Network CIDR to be used.
The id of the region for which this network is defined
A set of tag keys and optional values that were set on this resource instance.
Set of ids of the cloud accounts this entity belongs to.
State object representing a query result of fabric networks.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"isPublic": "boolean",
"isDefault": "boolean",
"cidr": "10.1.2.0/24",
"externalRegionId": "us-east-1",
"tags": [
{
"key": "string",
"value": "string"
}
],
"cloudAccountIds": [
"string"
]
}
],
"totalElements": 1
}
Total number of elements
Specification for updating a FabricNetwork
{
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A set of tag keys and optional values that were set on this resource instance.
Represents a structure that holds details of vSphere datastore.
HATEOAS links:
self - FabricVsphereDatastore - Self link to this data store
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "VMFS / NFS / StoragePod",
"externalRegionId": "Datacenter:datacenter-2",
"freeSizeGB": "20",
"cloudAccountIds": [
"string"
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
Type of datastore.
Id of datacenter in which the datastore is present.
Indicates free size available in datastore.
Set of ids of the cloud accounts this entity belongs to.
State object representing a query result of vSphere datastores.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "VMFS / NFS / StoragePod",
"externalRegionId": "Datacenter:datacenter-2",
"freeSizeGB": "20",
"cloudAccountIds": [
"string"
]
}
],
"totalElements": 1
}
Total number of elements
Represents a structure that holds details of vSphere storage policy.HATEOAS links:
self - FabricVsphereStoragePolicy - Self link to this storage policy
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"externalRegionId": "Datacenter:datacenter-2",
"cloudAccountIds": [
"string"
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
Id of datacenter in which the storage policy is present.
Set of ids of the cloud accounts this entity belongs to.
State object representing a query result of vSphere storage policies.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"externalRegionId": "Datacenter:datacenter-2",
"cloudAccountIds": [
"string"
]
}
],
"totalElements": 1
}
Total number of elements
Describes a flavor mapping between a global fabric flavor key and fabric flavor.
HATEOAS links:
region - Region - Region for the mapping.
{
"externalRegionId": "us-east-1"
}
Flavors defined for the particular region. Keyed by global flavor key.
The id of the region for which this mapping is defined.
HATEOAS of the entity
Represents a structure that holds flavor mappings defined for the corresponding cloud end-point region.
HATEOAS links:
region - Region - Region for the profile.
self - FlavorProfile - Self link to this flavor profile
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"flavorMappings": {
"externalRegionId": "us-east-1"
},
"externalRegionId": "us-east-1"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of the region for which this profile is defined
State object representing a query result of flavor profiles.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"flavorMappings": {
"externalRegionId": "us-east-1"
},
"externalRegionId": "us-east-1"
}
],
"totalElements": 1
}
Total number of elements
Specification for flavor profile
{
"name": "string",
"description": "string",
"regionId": "9e49"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Map between global fabric flavor keys
The id of the region for which this profile is created
State object representing a query result of falvor mappings.
{
"content": [
{
"externalRegionId": "us-east-1"
}
],
"totalElements": 1
}
Total number of elements
Load balancer health check configuration.
{
"protocol": "HTTP, HTTPS",
"port": "80",
"urlPath": "/index.html",
"intervalSeconds": 60,
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2
}
The protocol used for the health check.
Port on the back-end instance machine to use for the health check.
URL path on the back-end instance against which a request will be performed for the health check. Useful when the health check protocol is HTTP/HTTPS.
Interval (in seconds) at which the health checks will be performed.
Timeout (in seconds) to wait for a response from the back-end instance.
Number of consecutive check failures before considering a particular back-end instance as unhealthy.
Number of consecutive successful checks before considering a particular back-end instance as healthy.
{
"href": "string",
"hrefs": [
"string"
]
}
href
hrefs
Describes an image mapping between image key and fabric image.
HATEOAS links:
region - Region - Region for the mapping.
{
"externalRegionId": "us-east-1"
}
Image mapping defined for the particular region.
The id of the region for which this mapping is defined.
HATEOAS of the entity
Represents a fabric image from the corresponding cloud end-point with additional cloud configuration script that will be executed on provisioning
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"osFamily": "linux, win",
"externalRegionId": "us-east-1",
"isPrivate": true,
"cloudAccountIds": [
"string"
],
"cloudConfig": "runcmd:\n - [\"mkdir\", \"/imageFolder\"]"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
Operating System family of the image.
The regionId of the image
Additional properties that may be used to extend the base type.
Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library Items
Set of ids of the cloud accounts this entity belongs to.
Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification.
Represents a structure that holds a list of image mappings defined for the particular region.
HATEOAS links:
region - Region - Region for the profile.
self - ImageProfile - Self link to this image profile
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"imageMappings": {
"externalRegionId": "us-east-1"
},
"externalRegionId": "us-east-1"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of the region for which this profile is defined
State object representing a query result of image profiles.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"imageMappings": {
"externalRegionId": "us-east-1"
},
"externalRegionId": "us-east-1"
}
],
"totalElements": 1
}
Total number of elements
Specification for image profile.
{
"name": "string",
"description": "string",
"regionId": "9e49"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Image mapping defined for the corresponding region.
The id of the region for which this profile is created
State object representing a query result of image mappings.
{
"content": [
{
"externalRegionId": "us-east-1"
}
],
"totalElements": 1
}
Total number of elements
Represents a load balancer.
HATEOAS links:
load-balancer-targets - array[Machine] - List of load balancer target machines.
cloud-account - CloudAccount - Cloud account where this LB is deployed.
self - LoadBalancer - Self link to this load balancer
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9e49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
"string"
],
"address": "lb-123456789.eu-west-1.elb.amazonaws.com",
"routes": [
{
"protocol": "TCP, UDP",
"port": "80",
"memberProtocol": "TCP, UDP",
"memberPort": "80",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"urlPath": "/index.html",
"intervalSeconds": 60,
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2
}
}
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The id of the project this entity belongs to.
The external zoneId of the resource.
The external regionId of the resource
Set of ids of the cloud accounts this entity belongs to.
Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
The load balancer route configuration regarding ports and protocols.
A set of tag keys and optional values that were set on this load balancer.
Additional properties that may be used to extend the base type.
State object representing a query result of load balancecrs.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9e49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
"string"
],
"address": "lb-123456789.eu-west-1.elb.amazonaws.com",
"routes": [
{
"protocol": "TCP, UDP",
"port": "80",
"memberProtocol": "TCP, UDP",
"memberPort": "80",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"urlPath": "/index.html",
"intervalSeconds": 60,
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2
}
}
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Load balancer configuration.
{
"name": "string",
"projectId": "e058",
"description": "string",
"routes": [
{
"protocol": "TCP, UDP",
"port": "80",
"memberProtocol": "TCP, UDP",
"memberPort": "80",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"urlPath": "/index.html",
"intervalSeconds": 60,
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2
}
}
],
"nics": [
{
"name": "string",
"description": "string",
"deviceIndex": 1,
"networkId": "dcd9",
"addresses": [
"string"
],
"securityGroupIds": [
"string"
]
}
],
"targetLinks": [
"string"
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"internetFacing": "boolean"
}
A human-friendly name used as an identifier in APIs that support this option.
The id of the project the current user belongs to.
A human-friendly description.
The load balancer route configuration regarding ports and protocols.
A set of network interface specifications for this load balancer.
A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
Additional custom properties that may be used to extend the load balancer.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
Represents a cloud agnostic machine.
HATEOAS links:
operations - array[String] - Supported operations for the machine.
network-interfaces - array[NetworkInterface] - Network interfaces for the machine.
disks - array[MachineDisk] - disks for the machine.
deployment - Deployment - Deployment that this machine is part of.
cloud-accounts - array[CloudAccount] - Cloud accounts where this machine is provisioned.
self - Machine - Self link to this machine
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9e49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
"string"
],
"powerState": "ON, OFF",
"address": "34.242.21.5",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The id of the project this entity belongs to.
The external zoneId of the resource.
The external regionId of the resource
Set of ids of the cloud accounts this entity belongs to.
Power state of machine.
Primary address allocated or in use by this machine. The actual type of the address depends on the adapter type. Typically it is either the public or the external IP address.
A set of tag keys and optional values that were set on this resource instance.
Additional properties that may be used to extend the base type.
Machine boot config that will be passed to the instance that can be used to perform common automated configuration tasks and even run scripts after the instance starts.
{
"content": "#cloud-config\nrepo_update: true\nrepo_upgrade: all\n\npackages:\n - mysql-server\n\nruncmd:\n - sed -e '/bind-address/ s/^#*/#/' -i /etc/mysql/mysql.conf.d/mysqld.cnf\n - service mysql restart\n - mysql -e \"GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY 'mysqlpassword';\"\n - mysql -e \"FLUSH PRIVILEGES;\"\n"
}
A valid cloud config data in json-escaped yaml syntax
State object representing a query result of machines.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9e49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
"string"
],
"powerState": "ON, OFF",
"address": "34.242.21.5",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for a cloud agnostic machine.
{
"name": "string",
"projectId": "e058",
"description": "string",
"flavor": "small, medium, large",
"image": "vmware-gold-master, ubuntu-latest, rhel-compliant, windows",
"imageRef": "ami-f6795a8c",
"nics": [
{
"name": "string",
"description": "string",
"deviceIndex": 1,
"networkId": "dcd9",
"addresses": [
"string"
],
"securityGroupIds": [
"string"
]
}
],
"disks": [
{
"name": "string",
"description": "string",
"blockDeviceId": "1298765"
}
],
"bootConfig": {
"content": "#cloud-config\nrepo_update: true\nrepo_upgrade: all\n\npackages:\n - mysql-server\n\nruncmd:\n - sed -e '/bind-address/ s/^#*/#/' -i /etc/mysql/mysql.conf.d/mysqld.cnf\n - service mysql restart\n - mysql -e \"GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY 'mysqlpassword';\"\n - mysql -e \"FLUSH PRIVILEGES;\"\n"
},
"machineCount": 3,
"constraints": [
{
"mandatory": "boolean",
"expression": "ha:strong"
}
],
"imageDiskConstraints": [
{
"mandatory": "boolean",
"expression": "ha:strong"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
The id of the project the current user belongs to.
Describes machine within the scope of your organization and is not propagated to the cloud
Flavor of machine instance.
Type of image used for this machine.
Direct image reference used for this machine (name, path, location, uri, etc.). Valid if no image property is provided
A set of network interface controller specifications for this machine. If not specified, then a default network connection will be created.
Number of machines to provision - default 1.
Constraints that are used to drive placement policies for the virtual machine that is produced from this specification. Constraint expressions are matched against tags on existing placement targets.
Constraints that are used to drive placement policies for the image disk. Constraint expressions are matched against tags on existing placement targets.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
Additional custom properties that may be used toextend the machine.
The network object is an opaque reference to a logical network that network interfaces are attached to.
Based on settings specified by your cloud administrator, it may be a reference to an existing network, or be backed by an on-demand network created for isolation, or a security group that will be attached to machines as part of provisioning.
Networks are a limited resource, when it is not needed it should be deleted.
HATEOAS links:
self - Network - Self link to this network
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9e49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
"string"
],
"cidr": "10.10.0.0/16",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The id of the project this entity belongs to.
The external zoneId of the resource.
The external regionId of the resource
Set of ids of the cloud accounts this entity belongs to.
IPv4 address range of the network in CIDR format
Additional properties that may be used to extend the base type.
The network domain object is the parent of related subnets that are configured together. Subnets within a domain must have non-overlapping address spaces.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this network domain exists.
self - NetworkDomain - Self link to this network domain
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"cidr": "10.0.0.0/8",
"externalRegionId": "ap-northeast-2",
"tags": [
{
"key": "string",
"value": "string"
}
],
"cloudAccountIds": [
"string"
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
IPv4 address range of the network domain in CIDR format
The external regionId of the network domain.
A set of tag keys and optional values that were set on this network domain.
Additional properties that may be used to extend the base type.
Set of ids of the cloud accounts this entity belongs to.
State object representing a query result of network domains.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"cidr": "10.0.0.0/8",
"externalRegionId": "ap-northeast-2",
"tags": [
{
"key": "string",
"value": "string"
}
],
"cloudAccountIds": [
"string"
]
}
],
"totalElements": 1
}
Total number of elements
Represents a network interface.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this network domain exists.
security-groups - array[SecurityGroup] - List of security groups for this network interface.
self - NetworkInterface - Self link to this network interface
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"deviceIndex": 1,
"addresses": [
"string"
],
"externalRegionId": "ap-northeast-2",
"tags": [
{
"key": "string",
"value": "string"
}
],
"cloudAccountIds": [
"string"
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The device index of this network interface.
A list of IP addresses allocated or in use by this network interface.
The external regionId of the network interface.
A set of tag keys and optional values that were set on this network interface.
Additional properties that may be used to extend the base type.
Set of ids of the cloud accounts this entity belongs to.
Specification for attaching nic to machine
{
"name": "string",
"description": "string",
"deviceIndex": 1,
"networkId": "dcd9",
"addresses": [
"string"
],
"securityGroupIds": [
"string"
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The device index of this network interface.
Id of the network instance that this network interface plugs into.
A list of IP addresses allocated or in use by this network interface.
A list of security group ids which this network interface will be assigned to.
Additional properties that may be used to extend the base type.
Represents a network Profile.
HATEOAS links:
fabric-networks - array[FabricNetwork] - Fabric networks defined in this profile.
security-groups - array[SecurityGroup] - List of security groups for this profile.
network-domains - array[NetworkDomain] - List of network domains for this profile.
isolated-external-fabric-networks - array[FabricNetwork] - Isolated external fabric networks in this profile.
self - NetowrkProfile - Self link to this network profile
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalRegionId": "us-east-1",
"isolationType": "string",
"isolationNetworkDomainCIDR": "string",
"isolatedNetworkCIDRPrefix": "integer",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of the region for which this profile is defined
Specifies the isolation type e.g. none, subnet or security group
CIDR of the isolation network domain.
The CIDR prefix length to be used for the isolated networks that are created with the network profile.
A set of tag keys and optional values that were set on this Network Profile.
Additional properties that may be used to extend the Network Profile object.
State object representing a query result of network profiles.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalRegionId": "us-east-1",
"isolationType": "string",
"isolationNetworkDomainCIDR": "string",
"isolatedNetworkCIDRPrefix": "integer",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
{
"name": "string",
"description": "string",
"fabricNetworkIds": [
"string"
],
"securityGroupIds": [
"string"
],
"regionId": "9e49",
"isolationType": "SUBNET",
"isolationNetworkDomainId": "1234",
"isolationNetworkDomainCIDR": "10.10.10.0/24",
"isolationExternalFabricNetworkId": "1234",
"isolatedNetworkCIDRPrefix": 24,
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A list of fabric network Ids which are assigned to the network profile.
A list of security group Ids which are assigned to the network profile.
The Id of the region for which this profile is created
Specifies the isolation type e.g. none, subnet or security group
The Id of the network domain used for creating isolated networks.
CIDR of the isolation network domain.
The Id of the fabric network used for outbound access.
The CIDR prefix length to be used for the isolated networks that are created with the network profile.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
Additional properties that may be used to extend the Network Profile object that is produced from this specification.
State object representing a query result of networks.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9e49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
"string"
],
"cidr": "10.10.0.0/16",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"totalElements": 1
}
Total number of elements
Specification for a cloud network
{
"name": "string",
"projectId": "e058",
"description": "string",
"constraints": [
{
"mandatory": "boolean",
"expression": "ha:strong"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"outboundAccess": true
}
A human-friendly name used as an identifier in APIs that support this option.
The id of the project the current user belongs to.
A human-friendly description.
Constraints that are used to drive placement policies for the network that is produced from this specification, related with the network profile. Constraint expressions are matched against tags on existing placement targets.
Additional custom properties that may be used toextend the network.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
Flag to indicate if the network needs to have outbound access or not. Default is true. This field will be ignored if there is proper input for networkType customProperty
Projects link users and cloud zones, thus controlling who can use what cloud resources.
HATEOAS links:
self - Project - Self link to this project
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"administrators": [
{
"email": "[email protected]"
}
],
"members": [
{
"email": "[email protected]"
}
],
"zones": [
{
"zoneId": "77ee1",
"priority": 1,
"maxNumberInstances": 50
}
],
"operationTimeout": "integer",
"machineNamingTemplate": "${project.name}-test-${####}",
"sharedResources": "boolean"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
List of administrator users associated with the project. Only administrators can manage project's configuration.
List of Cloud Zones assigned to this project. You can limit deployment to a single region or allow multi-region placement by adding more than one cloud zone to a project. A cloud zone lists available resources. Use tags on resources to control workload placement.
List of storage, network and extensibility constraints to be applied when provisioning through this project.
The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds
The naming template to be used for machines provisioned in this project
Specifies whether the resources in this projects are shared or not.
Represents the resource metadata associated with a project
{
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A list of keys and optional values to be applied to compute resources provisioned in a project
Specification for resource metadata associated with a project
{
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A list of keys and optional values to be applied to compute resources provisioned in a project
State object representing a query result of projects.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"administrators": [
{
"email": "[email protected]"
}
],
"members": [
{
"email": "[email protected]"
}
],
"zones": [
{
"zoneId": "77ee1",
"priority": 1,
"maxNumberInstances": 50
}
],
"operationTimeout": "integer",
"machineNamingTemplate": "${project.name}-test-${####}",
"sharedResources": "boolean"
}
],
"totalElements": 1
}
Total number of elements
Represents a specification for a project.
{
"name": "string",
"description": "string",
"administrators": [
{
"email": "[email protected]"
}
],
"members": [
{
"email": "[email protected]"
}
],
"zoneAssignmentConfigurations": [
{
"zoneId": "77ee1",
"priority": 1,
"maxNumberInstances": 50
}
],
"operationTimeout": 30,
"machineNamingTemplate": "${project.name}-test-${####}",
"sharedResources": true
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
List of administrator users associated with the project. Only administrators can manage project's configuration.
List of configurations for zone assignment to a project.
List of storage, network and extensibility constraints to be applied when provisioning through this project.
The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds
The naming template to be used for machines provisioned in this project
Specifies whether the resources in this projects are shared or not. If not set default will be used.
State object representing a region in a cloud account.
HATEOAS links:
cloud-account - CloudAccount - Cloud account for the region.self - Region - Self link to this region
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"externalRegionId": "us-west",
"cloudAccountId": "9e49"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
Unique identifier of region on the provider side.
The id of the cloud account this region belongs to.
State object representing a query result of regions.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"externalRegionId": "us-west",
"cloudAccountId": "9e49"
}
],
"totalElements": 1
}
Total number of elements
An object used to track long-running operations.
{
"progress": 90,
"message": "In Progress",
"status": "FINISHED",
"resources": [
"string"
],
"name": "Power-off",
"id": "we655aew4e8e",
"selfLink": "/.../request-tracker/we655aew4e8e"
}
Progress of the request as percentage.
Status message of the request.
Status of the request.
Collection of resources.
Name of the operation.
ID of this request.
Self link of this request.
State object representing a query result of request tracker objects.
{
"content": [
{
"progress": 90,
"message": "In Progress",
"status": "FINISHED",
"resources": [
"string"
],
"name": "Power-off",
"id": "we655aew4e8e",
"selfLink": "/.../request-tracker/we655aew4e8e"
}
],
"totalElements": 1
}
Total number of elements
Load balancer route configuration.
{
"protocol": "TCP, UDP",
"port": "80",
"memberProtocol": "TCP, UDP",
"memberPort": "80",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"urlPath": "/index.html",
"intervalSeconds": 60,
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2
}
}
The protocol of the incoming load balancer requests.
Port which the load balancer is listening to.
The protocol of the member traffic.
Member port where the traffic is routed to.
A rule used in a security group.
{
"name": "5756f7e2",
"protocol": "TCP, UDP",
"ipRangeCidr": "66.170.99.2/32",
"ports": "443, 1-655535",
"access": "Allow"
}
Name of security rule.
Protocol the security rule applies to.
IP address(es) in CIDR format which the security rule applies to.
Ports the security rule applies to.
Type of access (allow or deny) for the security rule. Traffic that does not match any rules will be denied.
State object representing a security group.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this security group exists.
self - SecurityGroup - Self link to this security group
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"ingress": [
{
"name": "5756f7e2",
"protocol": "TCP, UDP",
"ipRangeCidr": "66.170.99.2/32",
"ports": "443, 1-655535",
"access": "Allow"
}
],
"egress": [
{
"name": "5756f7e2",
"protocol": "TCP, UDP",
"ipRangeCidr": "66.170.99.2/32",
"ports": "443, 1-655535",
"access": "Allow"
}
],
"externalRegionId": "ap-northeast-2",
"cloudAccountIds": [
"string"
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The external regionId of the security group.
Set of ids of the cloud accounts this entity belongs to.
State object representing a query result of security groups.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"ingress": [
{
"name": "5756f7e2",
"protocol": "TCP, UDP",
"ipRangeCidr": "66.170.99.2/32",
"ports": "443, 1-655535",
"access": "Allow"
}
],
"egress": [
{
"name": "5756f7e2",
"protocol": "TCP, UDP",
"ipRangeCidr": "66.170.99.2/32",
"ports": "443, 1-655535",
"access": "Allow"
}
],
"externalRegionId": "ap-northeast-2",
"cloudAccountIds": [
"string"
]
}
],
"totalElements": 1
}
Total number of elements
Represents a machine snapshot
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"snapshotMemory": "boolean"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Captures the full state of a running virtual machine, including the memory.
Additional custom properties that may be used toextend the snapshot.
Represents a structure that holds details of storage profile linked to a cloud zone / region.HATEOAS links:
region - Region - Region for the profile.
self - StorageProfile - Self link to this storage profile.
datastore - FabricVsphereDatastore - Datastore of this storage profile.
storage-policy - FabricVsphereStoragePolicy - vSphere storage policy for this profile.
storage-account - FabricAzureStorageAccount - Azure storage account for this profile.
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"externalRegionId": "us-east-1"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage profile is default profile or not.
Indicates whether this storage profile supports encryption or not.
Map of storage properties that are to be applied on disk while provisioning.
The id of the region for which this profile is defined
State object representing a query result of Aws storage profiles.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"deviceType": "ebs / instance-store",
"volumeType": "gp2 / io1 / sc1 / st1 / standard",
"iops": "2000",
"externalRegionId": "us-east-1"
}
],
"totalElements": 1
}
Total number of elements
Represents a specification of AWS storage profile.
{
"name": "string",
"description": "string",
"defaultItem": true,
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"deviceType": "ebs / instance-store",
"volumeType": "gp2 / io1 / sc1 / st1 / standard",
"iops": "2000",
"regionId": "31186"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage profile is default or not.
Indicates whether this storage profile supports encryption or not.
Indicates the type of storage.
Indicates the type of volume associated with type of storage.
Indicates maximum I/O operations per second in range(1-20,000).
A link to the region that is associated with the storage profile.
State object representing a query result of Azure storage profiles.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"diskType": "Standard_LRS / Premium_LRS",
"osDiskCaching": "None / ReadOnly / ReadWrite",
"dataDiskCaching": "None / ReadOnly / ReadWrite",
"externalRegionId": "uswest"
}
],
"totalElements": 1
}
Total number of elements
Represents a specification of Azure storage profile.
{
"name": "string",
"description": "string",
"defaultItem": true,
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"diskType": "Standard_LRS / Premium_LRS",
"osDiskCaching": "None / ReadOnly / ReadWrite",
"dataDiskCaching": "None / ReadOnly / ReadWrite",
"storageAccountId": "aaa82",
"regionId": "31186"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage policy contains default storage properties.
Indicates whether this storage policy should support encryption or not.
A set of tag keys and optional values for a storage policy which define set of specifications for creating a disk.
Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.
Indicates the caching mechanism for OS disk. Default policy for OS disks is Read/Write.
Indicates the caching mechanism for additional disk.
Id of a storage account where in the disk is placed.
The If of the region that is associated with the storage profile.
State object representing a query result of storage profiles.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"externalRegionId": "us-east-1"
}
],
"totalElements": 1
}
Total number of elements
Represents a specification of generic storage profile.
{
"name": "string",
"description": "string",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"regionId": "31186"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage profile is a default profile.
Indicates whether this storage profile supports encryption or not.
Map of storage properties that are to be applied on disk while provisioning.
Map of storage placements to know where the disk is provisioned.
The Id of the region that is associated with the storage profile.
State object representing a query result of vShpere storage profiles.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"provisioningType": "thin / thick / eagerZeroedThick",
"sharesLevel": "low / normal / high / custom",
"shares": "2000",
"limitIops": "1000",
"diskMode": "undefined / independent-persistent / independent-nonpersistent",
"externalRegionId": "Datacenter:datacenter-2"
}
],
"totalElements": 1
}
Total number of elements
Represents a specification of vSphere storage profile.
{
"name": "string",
"description": "string",
"defaultItem": true,
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"datastoreId": "08d28",
"storagePolicyId": "6b59743af31d",
"provisioningType": "thin / thick / eagerZeroedThick",
"sharesLevel": "low / normal / high / custom",
"shares": "2000",
"limitIops": "1000",
"diskMode": "undefined / independent-persistent / independent-nonpersistent",
"regionId": "31186"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage profile acts as a default storage profile for a disk.
Indicates whether this storage profile supports encryption or not.
Id of the vSphere Datastore for placing disk and VM.
Id of the vSphere Storage Policy to be applied.
Type of provisioning policy for the disk.
Shares are specified as High, Normal, Low or Custom and these values specify share values with a 4:2:1 ratio, respectively.
A specific number of shares assigned to each virtual machine.
The upper bound for the I/O operations per second allocated for each virtual disk.
Type of mode for the disk
The Id of the region that is associated with the storage profile.
{
"key": "string",
"value": "string"
}
Tag's key.
Tag's value.
{
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"regionIds": [
"string"
],
"createDefaultZones": true
}
A human-friendly description.
A set of Region names to enable provisioning on.
Create default cloud zones for the enabled regions.
{
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"regionIds": [
"string"
],
"createDefaultZones": true
}
A human-friendly description.
A set of Region names to enable provisioning on.
Create default cloud zones for the enabled regions.
{
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"regionIds": [
"string"
],
"createDefaultZones": true
}
A human-friendly description.
A set of Region names to enable provisioning on.
Create default cloud zones for the enabled regions.
{
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"regionIds": [
"string"
],
"createDefaultZones": true,
"associatedCloudAccountIds": [
"string"
]
}
A human-friendly description.
Additional custom properties that may be used toextend the Cloud Account.
A set of Region names to enable provisioning on.
Create default cloud zones for the enabled regions.
Cloud accounts to link with this cloud account
{
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
A human-friendly description.
{
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"regionIds": [
"string"
],
"createDefaultZones": true
}
A human-friendly description.
A set of Region names to enable provisioning on.
Create default cloud zones for the enabled regions.
{
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
Describes machine within the scope of your organization and is not propagated to the cloud
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
The email of the user.
{
"volumeTypes": [
"string"
]
}
volumeTypes
Defines a structure that holds storage profile details defined for vSphere for a specific region.HATEOAS links:
datastore - FabricVsphereDatastore - Datastore for this storage profile.
storage-policy - FabricVsphereStoragePolicy - vSphere storage policy for this storage profile.
region - Region - Region for the profile.
self - VsphereStorageProfile - Self link to this vSphere storage profile.
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"defaultItem": "boolean",
"supportsEncryption": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"provisioningType": "thin / thick / eagerZeroedThick",
"sharesLevel": "low / normal / high / custom",
"shares": "2000",
"limitIops": "1000",
"diskMode": "undefined / independent-persistent / independent-nonpersistent",
"externalRegionId": "Datacenter:datacenter-2"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage profile contains default storage properties.
Indicates whether this storage profile should support encryption or not.
Type of format for the disk.
Shares level are specified as High, Normal, Low or Custom.
A specific number of shares assigned to each virtual machine.
The upper bound for the I/O operations per second allocated for each disk.
Type of mode for the disk
The id of the region for which this profile is defined
Description of a compute placement zone. This can be used to specify a subset of compute resources within a region where machines can be placed.region - Region - Region for the zone.
self - Zone - Self link to this zone
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"tags": [
{
"key": "string",
"value": "string"
}
],
"tagsToMatch": [
{
"key": "string",
"value": "string"
}
],
"placementPolicy": "DEFAULT, SPREAD, BINPACK",
"folder": "test-folder"
}
The id of this resource instance
Date when the entity was created. The date is in ISO 6801 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of tag keys and optional values for compute resource filtering.
The placement policy for the zone.
A list of key value pair of properties that will be used
The folder relative path to the datacenter where resources are deployed to. (only applicable for vSphere cloud zones)
A zone assignment configuration
{
"zoneId": "77ee1",
"priority": 1,
"maxNumberInstances": 50
}
The Cloud Zone Id
The priority of this zone in the current project. Lower numbers mean higher priority. Default is 0 (highest)
The maximum number of instances that can be provisioned in this cloud zone. Default is 0 (unlimited instances).
State object representing a query result of Zones.
{
"content": [
{
"id": "9e49",
"createdAt": "2012-09-27",
"updatedAt": "2012-09-27",
"owner": "[email protected]",
"organizationId": "deprecated",
"orgId": "9e49",
"name": "my-name",
"description": "my-description",
"tags": [
{
"key": "string",
"value": "string"
}
],
"tagsToMatch": [
{
"key": "string",
"value": "string"
}
],
"placementPolicy": "DEFAULT, SPREAD, BINPACK",
"folder": "test-folder"
}
],
"totalElements": 1
}
Total number of elements
Specification for a zone.
{
"name": "string",
"description": "string",
"regionId": "9e49",
"placementPolicy": "DEFAULT",
"tags": [
{
"key": "string",
"value": "string"
}
],
"tagsToMatch": [
{
"key": "string",
"value": "string"
}
],
"folder": "test-folder"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of the region for which this profile is created
Placement policy for the zone. One of DEFAULT, SPREAD or BINPACK.
A set of tag keys and optional values that are effectively applied to all compute resources in this zone, but only in the context of this zone.
A list of key value pair of properties that will be used
The folder relative path to the datacenter where resources are deployed to. (only applicable for vSphere cloud zones)