Get Namespace Instances

Returns information about a specific namespace on a single vSphere cluster.

Request

URI

GET

https://{api_host}/api/vcenter/namespaces/instances/{namespace}

COPY

Path Parameters

string

namespace

Required

Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

Information about the desired state of the specified namespace.

Returns Namespaces_Instances_Info of type(s) application/json

{
    "cluster": "string",
    "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": {
                            "id": "string",
                            "params": {
                                "params": "Std_LocalizationParam 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
        }
    ],
    "creator": {
        "subject": "string",
        "domain": "string"
    },
    "self_service_namespace": false
}

string

cluster

Required

Identifier for the vSphere 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.

Namespaces_Instances_ConfigStatus

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.

array of Namespaces_Instances_Message

messages

Required

Current set of messages associated with the object.

Namespaces_Instances_Stats

stats

Required

The Instances.Stats structure contains the basic runtime statistics about the namespace.

string

description

Required

Description of the namespace.

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.

array of Namespaces_Instances_Access

access_list

Required

Access controls associated with the namespace.

array of Namespaces_Instances_StorageSpec

storage_specs

Required

Storage associated with the namespace.

array of string

networks

Optional

The vSphere Networks associated with the namespace. This field is unset if the cluster hosting this namespace uses NSXT_CONTAINER_PLUGIN or NSXT_VPC 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.

Namespaces_Instances_VMServiceSpec

vm_service_spec

Optional

The Instances.VMServiceSpec structure contains the specification required to configure the VM Service specification associated with a namespace.

array of Namespaces_Instances_ContentLibrarySpec

content_libraries

Optional

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.

If unset, no Content Libraries are configured for the VM Image Service.

Namespaces_Instances_Principal

creator

Optional

The Instances.Principal structure contains the information about the creator of namespace.

boolean

self_service_namespace

Optional

Flag to indicate the self service namespace. If unset, the namespace is not marked as self service namespace.

401

com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

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.

object

data

Optional

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 ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.

403

com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

404

com.vmware.vapi.std.errors.not_found : if namespace could not be located.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

500

com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

default

'Default' means this response is used for all HTTP codes that are not covered individually for this operation.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespaces/instances/{namespace}

Power CLI Samples

# Module 'VMware.Sdk.vSphere.vCenter.Namespaces'

Invoke-GetNamespaceInstances -Namespace "MyNamespace"

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Namespaces Operations

POST

Create Namespaces Instances

GET

List Namespaces Instances

POST

Create Namespaces Instances V2

GET

Get Namespaces Instances V2

DELETE

Delete Namespace Instances

GET

Get Namespace Instances

PUT

Set Namespace Instances

PATCH

Update Namespace Instances

GET

Get Namespace Instances V2

POST

Create Namespace Instances Registervm