vcenter namespaces instances: get
Returns information about a specific namespace.
Request:
HTTP request
GET https://{server}/api/vcenter/namespaces/instances/{namespace}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| namespace | string | Identifier for the namespace. |
Response:
HTTP Status Code: 200
Response Body Structure:
{
"cluster" : "obj-103",
"stats" : {
"cpu_used" : 1,
"memory_used" : 1,
"storage_used" : 1
},
"messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"description" : "string",
"access_list" : [
{
"role" : "EDIT",
"subject_type" : "USER",
"subject" : "string",
"domain" : "string"
},
{
"role" : "EDIT",
"subject_type" : "USER",
"subject" : "string",
"domain" : "string"
}
],
"networks" : [
"obj-103",
"obj-103"
],
"config_status" : "CONFIGURING",
"storage_specs" : [
{
"limit" : 1,
"policy" : "obj-103"
},
{
"limit" : 1,
"policy" : "obj-103"
}
],
"resource_spec" : {}
}
"cluster" : "obj-103",
"stats" : {
"cpu_used" : 1,
"memory_used" : 1,
"storage_used" : 1
},
"messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"description" : "string",
"access_list" : [
{
"role" : "EDIT",
"subject_type" : "USER",
"subject" : "string",
"domain" : "string"
},
{
"role" : "EDIT",
"subject_type" : "USER",
"subject" : "string",
"domain" : "string"
}
],
"networks" : [
"obj-103",
"obj-103"
],
"config_status" : "CONFIGURING",
"storage_specs" : [
{
"limit" : 1,
"policy" : "obj-103"
},
{
"limit" : 1,
"policy" : "obj-103"
}
],
"resource_spec" : {}
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | info | Information about the desired state of the specified namespace. |
| -.cluster | string | 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 | string | Current setting for config_status. Describes the status of reaching the desired state configuration for the namespace. Value is one of: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. |
| -.messages | message[] | Current set of messages associated with the object. |
| -.messages[].severity | string | Type of the message. Represents the severity of the message. Value is one of: INFO: Informational message. This may be accompanied by vCenter event. WARNING: Warning message. This may be accompanied by vCenter event. ERROR: Error message. This is accompanied by vCenter event and/or alarm. |
| -.messages[].details | localizable_message | Details about the message. Optional. If unset, message details are not required for taking actions. |
| -.messages[].details.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.messages[].details.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.messages[].details.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| -.stats | stats | Basic runtime statistics for the namespace. |
| -.stats.cpu_used | long | Overall CPU usage of the namespace, in MHz. This is the sum of CPU usage across all pods in the Kubernetes namespace. |
| -.stats.memory_used | long | Overall memory usage of the namespace (in mebibytes). This is the sum of memory usage across all pods. |
| -.stats.storage_used | long | Overall storage used by the namespace (in mebibytes). This is the sum of storage used by pods across all datastores in the cluster associated with storage policies configured for the namespace. |
| -.description | string | Description of the namespace. |
| -.resource_spec | object | Quotas on the namespace resources. Refer to get for the type of the value for this field. Optional. If unset, no resource constraints are associated with the namespace. |
| -.access_list | access[] | Access controls associated with the namespace. |
| -.storage_specs | storage_spec[] | Storage associated with the namespace. |
| -.networks | string[] | vSphere Networks associated with the namespace. This attribute was added in vSphere API 7.0.1.0. Optional. 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.namespaces.Instance. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if namespace could not be located. |
| 500 | error | if the system reports an error while responding to the request. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user does not have System.Read privilege. |