List Instances
Released in v7.0.0Returns the information about all namespaces on this vCenter.
Request
URLURL
https://{api_host}/api/vcenter/namespaces/instances
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespacesInstancesSummary
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 | NamespacesInstancesConfigStatus 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 | NamespacesInstancesStats |
Basic runtime statistics for the namespace. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespaces/instances
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
