List Instances
Returns the information about all namespaces on this vCenter.
Request
URLURL
https://{api_host}/api/vcenter/namespaces/instances
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
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": "CONFIGURING",
"description": "string",
"namespace": "string",
"self_service_namespace": false,
"stats": {
"cpu_used": 0,
"memory_used": 0,
"storage_used": 0
}
}
]
string
cluster
Required
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
Required
The Instances.ConfigStatus enumerated type describes the status of reaching the desired state configuration for the namespace.
CONFIGURING : The configuration is being applied to the namespace.
REMOVING : The configuration is being removed and namespace is being deleted.
RUNNING : The namespace is configured correctly.
ERROR : Failed to apply the configuration to the namespace, user intervention needed.
Possible values are: CONFIGURING , REMOVING , RUNNING , ERROR
string
description
Required
Description of the namespace.
string
namespace
Required
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.
boolean
self_service_namespace
Optional
Flag to indicate the self service namespace. If unset, the namespace is not marked as self service namespace.
PowerCLI Client SDK Example
Invoke-ListNamespacesInstances
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespaces/instances
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.0
On This Page
Instances Operations
get
post
get
put
patch
delete
