List V2 Instances
Returns the information about all namespaces in this vCenter Server. The information is tied to a Supervisor.
Request
URLURL
https://{api_host}/api/vcenter/namespaces/instances/v2
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespacesInstancesSummaryV2
of type application/json
Information about all namespaces in this vCenter server.
[
{
"config_status": "CONFIGURING",
"description": "string",
"namespace": "string",
"self_service_namespace": false,
"stats": {
"cpu_used": 0,
"memory_used": 0,
"storage_used": 0
},
"supervisor": "string"
}
]
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.
string
supervisor
Required
Identifier for the Supervisor hosting 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.namespace_management.supervisor.Supervisor. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
boolean
self_service_namespace
Optional
Flag to indicate the self service namespace. If unset, the namespace is not marked as self service namespace.
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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetNamespacesInstancesV2
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespaces/instances/v2
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list_v2
Availability
Added in 8.0.0.1
On This Page
Instances Operations
get
post
get
put
patch
delete
post
get
