Developer Documentation
List Instances
Released in v7.0.0Returns the information about all namespaces on this vCenter.
Request
Operation doesn't accept any path, query or header parameters.
URL
https://{api_host}/api/vcenter/namespaces/instances
Response
Response
Response BodyResponse Body
200 OK returns
array of
InstancesSummary
of type application/json
The list of summary of all namespaces.
{
"cluster": "string",
"config_status": "enum",
"description": "string",
"namespace": "string",
"stats": {
"cpu_used": 0,
"memory_used": 0,
"storage_used": 0
}
}| Property Name | Type | Description |
|---|---|---|
| cluster | string |
Identifier for the cluster hosting the namespace. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource. |
| config_status | InstancesConfigStatus Enum |
Current setting for Instances.ConfigStatus. |
| description | string |
Description of the namespace. |
| namespace | string |
Identifier of the namespace. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. |
| stats | InstancesStats |
Basic runtime statistics for the namespace. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege. |
| 404 | Error | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. |
| default | Error | Not available |
On This Page
Instances Operations
get
post
get
put
patch
delete
