Get Namespace Resource Options
Get the information about the objects used to set and update resource quota keys for version of Kubernetes running on {#link cluster}.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/workload-resource-options
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster hosting the namespace on which the resource quota needs to be set. The parameter must be an identifier for the resource type: ClusterComputeResource.
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
NamespaceManagementNamespaceResourceOptionsInfo of type application/json
Information about the structures representing the resource spec.
{
"create_resource_quota_type": "string",
"update_resource_quota_type": "string"
}
string
create_resource_quota_type
Required
Identifier of the structure used to set resource quotas on the namespace. See com.vmware.vcenter.namespaces.Instances#create and com.vmware.vcenter.namespaces.Instances#set. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.structure. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.structure.
string
update_resource_quota_type
Required
Identifier of the structure used to update resource quotas on the namespace. See com.vmware.vcenter.namespaces.Instances#update. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.structure. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.structure.
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterNamespaceManagementWorkloadResourceOptions -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/workload-resource-options
Errors
400
com.vmware.vapi.std.errors.unsupported : if the specified cluster is not enabled for Namespaces.
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.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.0
