REST API - list

appliance system storage: list

Get disk to partition mapping.

Request:

HTTP request

GET https://{server}/rest/appliance/system/storage
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "disk""obj-103",
            "partition""string",
            "description"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"[
                    {
                        "value"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"[
                                    {
                                        "value"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"[
                                                    {
                                                        "key""string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key""string"
                                    }
                                ]
                            }
                        },
                        "key""string"
                    }
                ]
            }
        },
        {
            "disk""obj-103",
            "partition""string",
            "description"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"[
                    {
                        "value"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"[
                                    {
                                        "value"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"[
                                                    {
                                                        "key""string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key""string"
                                    }
                                ]
                            }
                        },
                        "key""string"
                    }
                ]
            }
        }
    ]
}

Response Type:

Name Type Description
bold = required
value storage_mapping[] list of mapping items.
value[].disk string The disk number in the vSphere Web Client.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.system.storage. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.system.storage.

value[].partition string Storage partition name.

value[].description localizable_message Description of partition. This attribute was added in vSphere API 6.7.

Optional. This field is optional because it was added in a newer version than its parent node.

value[].description.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

value[].description.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

value[].description.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

Errors:

HTTP Status Code Type Description
500 error Generic error