Get Vcf Management Components Task Spec

Get Vcf Management Components Task Spec

Gets VCF Management Components task spec by its task ID

Request
URI
GET
https://{api_host}/v1/vcf-management-components/tasks/{taskId}/spec
COPY
Path Parameters
string
taskId
Required

VCF Management Components task ID

taskId example
123e4567-e89b-42d3-a456-556642440000

Responses
200

Ok

Returns VcfManagementComponentsSpec of type(s) application/json
{
    "vcfOperationsFleetManagementSpec": {
        "hostname": "vcf-operations-fleet-management.rainpole.io",
        "rootUserPassword": "string",
        "adminUserPassword": "string",
        "useExistingDeployment": true,
        "version": "9.0.0.0.24597083",
        "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
    },
    "vcfOperationsSpec": {
        "nodes": [
            {
                "hostname": "vcfoperations-master.rainpole.io",
                "rootUserPassword": "string",
                "type": "master",
                "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
            }
        ],
        "adminUserPassword": "string",
        "applianceSize": "medium",
        "loadBalancerFqdn": "string",
        "useExistingDeployment": true,
        "version": "9.0.0.0.24597083"
    },
    "vcfOperationsCollectorSpec": {
        "hostname": "vcf-operations-collector.rainpole.io",
        "rootUserPassword": "string",
        "applianceSize": "small",
        "useExistingDeployment": true,
        "version": "9.0.0.0.24597083",
        "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
    },
    "vcfAutomationSpec": {
        "hostname": "vcfautomation.rainpole.io",
        "adminUserPassword": "string",
        "ipPool": [
            "['10.0.0.80', '10.0.0.81']"
        ],
        "internalClusterCidr": "198.18.0.0/15",
        "nodePrefix": "node-123",
        "useExistingDeployment": true,
        "version": "9.0.0.0.24597083",
        "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
    },
    "vcfMangementComponentsInfrastructureSpec": {
        "localRegionNetwork": {
            "networkName": "string",
            "subnetMask": "255.255.255.0",
            "gateway": "10.0.0.250"
        },
        "xRegionNetwork": {
            "networkName": "string",
            "subnetMask": "255.255.255.0",
            "gateway": "10.0.0.250"
        },
        "xregionNetwork": {
            "networkName": "string",
            "subnetMask": "255.255.255.0",
            "gateway": "10.0.0.250"
        }
    },
    "vcfInstanceName": "string",
    "existingDataStore": "string",
    "workflowType": "One among: VCF, VCF_EXTEND"
}
object
vcfOperationsFleetManagementSpec
Optional

Specification for VCF Operations fleet management

object
vcfOperationsSpec
Optional

Specification for VCF Operations

object
vcfOperationsCollectorSpec
Required

Specification for VCF Operations collector

object
vcfAutomationSpec
Optional

Specification for VCF Automation

object
vcfMangementComponentsInfrastructureSpec
Optional

Specification for infrastructure to be used for VCF Management Components deployment

string
vcfInstanceName
Optional

Specification for VCF Instance Name

string
existingDataStore
Optional

Existing data store for VCF Operations Fleet management deployment

string As (VCF|VCF_EXTEND)
workflowType
Optional

Type of workflow to initiate creation and/or validation


403

Forbidden

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

Internal Server Error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/vcf-management-components/tasks/{taskId}/spec