Fetch Component Statuses

Fetches the status for the components with the input IDs.

Request

URI

POST

https://vcf.broadcom.com/sddc-lcm/v1/components/status

COPY

Request Body

ComponentStatusesSpec of type(s) application/json

Optional

{
    "componentIds": [
        "string"
    ]
}

array of string

componentIds

Optional

componentIds

Authentication

This operation uses the following authentication methods.

bearerToken

Responses

200

Returns ComponentStatuses of type(s) application/json

{
    "componentStatuses": [
        {
            "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "status": "Unknown"
        },
        {
            "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "status": "Unknown"
        }
    ]
}

array of object

componentStatuses

Optional

Component current status

400

Bad request. Invalid input specification.

Returns ErrorResponse of type(s) application/json

{
    "code": "code",
    "detail": "detail",
    "message": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "resolution": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "referenceId": "referenceId",
    "timestamp": "2000-01-23T04:56:07.000Z"
}

string

code

Required

Unique error code for programmatic identification.

object

message

Required

message

object

resolution

Required

resolution

string

referenceId

Required

An identifier for tracing the error in the logs.

string As date-time As date-time

timestamp

Required

The date and time when the error occurred.

string

detail

Optional

Freeform extra information, such as raw error payloads or additional context.

401

Unauthorized

Returns ErrorResponse of type(s) application/json

{
    "code": "code",
    "detail": "detail",
    "message": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "resolution": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "referenceId": "referenceId",
    "timestamp": "2000-01-23T04:56:07.000Z"
}

string

code

Required

Unique error code for programmatic identification.

object

message

Required

message

object

resolution

Required

resolution

string

referenceId

Required

An identifier for tracing the error in the logs.

string As date-time As date-time

timestamp

Required

The date and time when the error occurred.

string

detail

Optional

Freeform extra information, such as raw error payloads or additional context.

500

Internal server error

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

string

code

Required

Unique error code for programmatic identification.

object

message

Required

message

object

resolution

Required

resolution

string

referenceId

Required

An identifier for tracing the error in the logs.

string As date-time As date-time

timestamp

Required

The date and time when the error occurred.

string

detail

Optional

Freeform extra information, such as raw error payloads or additional context.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/sddc-lcm/v1/components/status

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Components Operations

GET

Get Components

POST