Vcenter Namespaces Instances getV2
Returns information about a specific namespace on a Supervisor.
This operation was added in vSphere API 8.0.0.1.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
com.vmware.vcenter.namespaces.Instancereferenced by the parameter namespace requiresSystem.Read.
Identifier for the namespace.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.
Information about the desired state of the specified namespace on a Supervisor.
{
"supervisor": "string",
"zones": [
{
"zone": "string",
"type": "string",
"marked_for_removal": false
}
],
"network_spec": {
"network_provider": "string",
"vpc_network": {
"vpc_config": {
"private_cidrs": [
{
"address": "string",
"prefix": 0
}
]
},
"vpc": "string",
"auto_created": false,
"default_subnet_size": 0
}
},
"config_status": "string",
"messages": [
{
"severity": "string",
"details": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
}
],
"stats": {
"cpu_used": 0,
"memory_used": 0,
"storage_used": 0
},
"description": "string",
"resource_spec": {},
"access_list": [
{
"subject_type": "string",
"subject": "string",
"domain": "string",
"role": "string",
"identity_provider": "string"
}
],
"storage_specs": [
{
"policy": "string",
"limit": 0
}
],
"networks": [
"string"
],
"vm_service_spec": {
"content_libraries": [
"string"
],
"vm_classes": [
"string"
]
},
"content_libraries": [
{
"content_library": "string",
"writable": false,
"allow_import": false,
"resource_naming_strategy": "string"
}
],
"creator": {
"subject": "string",
"domain": "string"
},
"self_service_namespace": false
}Identifier for the Supervisor hosting the namespace.
This property was added in vSphere API 8.0.0.1.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
Configuration of vSphere Zones associated with this namespace on which workloads are created.
This property was added in vSphere API 9.0.0.0.
This property is optional because it was added in a newer version than its parent node.
Network related configurations associated with this namespace.
This property was added in vSphere API 9.0.0.0.
This property is optional because it was added in a newer version than its parent node.
Current setting for Vcenter Namespaces Instances ConfigStatus.
For more information see: Vcenter Namespaces Instances ConfigStatus.
This property was added in vSphere API 7.0.0.0.
Current set of messages associated with the object.
This property was added in vSphere API 7.0.0.0.
Basic runtime statistics for the namespace.
This property was added in vSphere API 7.0.0.0.
Description of the namespace.
This property was added in vSphere API 7.0.0.0.
Quotas on the namespace resources. Refer to GET /vcenter/namespace-management/clusters/{cluster}/workload-resource-options for the type of the value for this field.
This property was added in vSphere API 7.0.0.0.
If missing or null, no resource constraints are associated with the namespace.
Access controls associated with the namespace.
This property was added in vSphere API 7.0.0.0.
Storage associated with the namespace.
This property was added in vSphere API 7.0.0.0.
The vSphere Networks associated with the namespace.
This property was added in vSphere API 7.0.1.0.
This field is missing or null if the cluster hosting this namespace uses NSXT_CONTAINER_PLUGIN or NSX_VPC as its network provider.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network.
VM Service specification associated with the namespace.
This property was added in vSphere API 7.0.2.00100.
This property is optional because it was added in a newer version than its parent node.
List of Content Libraries used by the VM Image Service. This list refers to existing Content Libraries in vSphere inventory.
The Content Libraries specified in {VMServiceSpec#contentLibraries} will also be included in this list but will be read-only by default to users.
If the same Content Library is present both here and in {VMServiceSpec#contentLibraries}, then:
- The Content Library is only surfaced to users once.
- The settings here are honored.
This property was added in vSphere API 8.0.2.0.
If missing or null, no Content Libraries are configured for the VM Image Service.
Creator of the namespace. Namespace self-service uses this field to populate the user who created this namespace.
This property was added in vSphere API 7.0.2.00100.
This property is optional because it was added in a newer version than its parent node.
Flag to indicate the self service namespace.
This property was added in vSphere API 7.0.2.00100.
If missing or null, the namespace is not marked as self service namespace.
if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have System.Read privilege.
"Vapi Std Errors Unauthorized Object"if namespace could not be located.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespaces/instances/v2/{namespace}