REST API - list
  1. Operations
  2. vcenter
  3. host
  4. maintenance
  5. requests v1

vcenter host maintenance requests v1: list

Returns information about maintenance requests matching the vcenter.host.maintenance.requests_v1.filter_spec. This operation was added in vSphere API 7.0.1.0.

Request:

HTTP request

GET https://{server}/api/vcenter/host/maintenance/requests-v1

?hosts={value-1}
&hosts={value-2}

Query Parameters:

Name Type Description
bold = required
hosts string[] Identifiers of hosts that can match the filter. This attribute was added in vSphere API 7.0.1.0.

Optional. If unset or empty, hosts with any identifier match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "summaries" : [
        {
            "request" : "obj-103",
            "host" : "obj-103",
            "description" : "string"
        },
        {
            "request" : "obj-103",
            "host" : "obj-103",
            "description" : "string"
        }
    ]
}

Headers:

None

Type:

Name Type Description
bold = required
- list_result Commonly used information about the maintenance requests matching this vcenter.host.maintenance.requests_v1.filter_spec.
-.summaries summary[] The list of requests. This attribute was added in vSphere API 7.0.1.0.
-.summaries[].request string Identifier of the request. This attribute was added in vSphere API 7.0.1.0.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.host.maintenance.RequestV1. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.host.maintenance.RequestV1.
-.summaries[].host string Identifier of the host. This attribute was added in vSphere API 7.0.1.0.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.
-.summaries[].description string Description of the maintenance request. This attribute was added in vSphere API 7.0.1.0.

Errors:

HTTP Status Code Type Description
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.