Get V2 Instances
Returns information about a specific namespace on a Supervisor.
Request
URLURL
https://{api_host}/api/vcenter/namespaces/instances/v2/{namespace}
Path Parameters
Path Parameters
string
namespace
Required
Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.
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
NamespacesInstancesInfoV2
of type application/json
Information about the desired state of the specified namespace on a Supervisor.
{
"access_list": [
{
"domain": "string",
"identity_provider": "string",
"role": "OWNER",
"subject": "string",
"subject_type": "USER"
}
],
"config_status": "CONFIGURING",
"creator": {
"domain": "string",
"subject": "string"
},
"description": "string",
"messages": [
{
"details": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"severity": "INFO"
}
],
"networks": [
"string"
],
"resource_spec": {},
"self_service_namespace": false,
"stats": {
"cpu_used": 0,
"memory_used": 0,
"storage_used": 0
},
"storage_specs": [
{
"limit": 0,
"policy": "string"
}
],
"supervisor": "string",
"vm_service_spec": {
"content_libraries": [
"string"
],
"vm_classes": [
"string"
]
}
}
array of
NamespacesInstancesAccess
access_list
Required
Access controls associated with the namespace.
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.
array of
NamespacesInstancesMessage
messages
Required
Current set of messages associated with the object.
array of
NamespacesInstancesStorageSpec
storage_specs
Required
Storage associated with the namespace.
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.
array of
string
networks
Optional
vSphere Networks associated with the namespace. This field is unset if the cluster hosting this namespace uses NSXT_CONTAINER_PLUGIN as its network provider. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network.
object
resource_spec
Optional
Quotas on the namespace resources. Refer to com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get for the type of the value for this field. If unset, no resource constraints are associated with the namespace.
boolean
self_service_namespace
Optional
Flag to indicate the self service namespace. If unset, the namespace is not marked as self service namespace.
creator
Optional
Creator of the namespace. Namespace self-service uses this field to populate the user who created this namespace. This field is optional because it was added in a newer version than its parent node.
vm_service_spec
Optional
VM Service specification associated with the namespace. This field is optional because it was added in a newer version than its parent node.
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-GetNamespaceInstancesV2 -Namespace "MyNamespace"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespaces/instances/v2/{namespace}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get_v2
Availability
Added in 8.0.0.1
On This Page
Instances Operations
get
post
get
put
patch
delete
post
get
