REST API - set

vcenter namespaces instances: set

Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.

Request:

HTTP request

PUT https://{server}/api/vcenter/namespaces/instances/{namespace}

{
    "description" : "string",
    "access_list" : [
        {
            "role" : "EDIT",
            "subject_type" : "USER",
            "subject" : "string",
            "domain" : "string"
        },
        {
            "role" : "EDIT",
            "subject_type" : "USER",
            "subject" : "string",
            "domain" : "string"
        }
    ],
    "storage_specs" : [
        {
            "limit" : 1,
            "policy" : "obj-103"
        },
        {
            "limit" : 1,
            "policy" : "obj-103"
        }
    ],
    "resource_spec" : {}
}

Path Parameters

Name	Type	Description
Required
namespace	string	Identifier for the namespace.

Body Parameters:

Name	Type	Description
bold = required
-	set_spec	New specification for the namespace.
-.description	string	Description for the namespace. Optional. If unset, the description of the namespace will be cleared.
-.resource_spec	object	Resource quota for the namespace. This will replace the existing resource constraints on the namespace in entirety. Refer to vcenter.namespace_management.namespace_resource_options.info.create_resource_quota_type and use get for retrieving the type for the value for this field. For an example of this, see vcenter.namespaces.resource_quota_options_v1. Optional. If unset, the resource constraints on the namespace will be cleared.
-.access_list	access[]	Access control associated with the namespace. Optional. If unset, the existing access controls on the namespace will be removed and users will not be able to access this namespace to create new pods. Existing pods from users will continue to run.
-.access_list[].subject_type	string	Type of the subject. Lists the types of subjects who can be associated with a `role` on the namespace. Value is one of: USER: Single user. GROUP: Group of users.
-.access_list[].subject	string	Name of the subject.
-.access_list[].domain	string	Domain of the subject.
-.access_list[].role	string	Role of the subject on the namespace instance. Lists the default roles which can be associated with a subject on a domain on the namespace. Value is one of: EDIT: This role allows modification of the namespace. VIEW: This is a read-only role on the namespace.
-.storage_specs	storage_spec[]	Storage associated with the namespace. Optional. If unset, the existing storage policies will be disassociated with the namespace and existing limits will be cleared. Pods which are already using persistent storage from the earlier version of storage policies will be able to access them till the datastores are attached to the worker nodes.
-.storage_specs[].policy	string	ID of the storage policy. A Kubernetes storage class is created for this storage policy if it does not exist already. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `SpsStorageProfile`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `SpsStorageProfile`.
-.storage_specs[].limit	long	The maximum amount of storage (in mebibytes) which can be utilized by the namespace for this specification. Optional. If unset, no limits are placed.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
400	invalid_argument	if `spec` contain any errors.
400	not_allowed_in_current_state	if the namespace is marked for deletion or the associated cluster is being disabled.
404	not_found	if namespace with the name `namespace` could not be located.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.