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
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
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
}
}
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
Current setting for Instances.ConfigStatus.
Possible values are:
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.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespaces/instances
Errors
401
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
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.
On This Page
Instances Operations
get
post
patch
delete
get
put
