功能介绍
查询指定namespace下的resourcequotas(资源用量)。
调用方法
请参见如何调用API。
URI
GET /api/v1/namespaces/{namespace}/resourcequotas
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
namespace |
是 |
String |
object name and auth scope, such as for teams and projects |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
allowWatchBookmarks |
否 |
Boolean |
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue |
否 |
String |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector |
否 |
String |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector |
否 |
String |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit |
否 |
Integer |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion |
否 |
String |
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch |
否 |
String |
resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds |
否 |
Integer |
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch |
否 |
Boolean |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
pretty |
否 |
String |
If 'true', then the output is pretty printed. |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items |
Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
|
kind |
String |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kind |
String |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
spec |
Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
|
status |
Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. |
fieldsType |
String |
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" |
fieldsV1 |
Object |
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. |
manager |
String |
Manager is an identifier of the workflow managing these fields. |
operation |
String |
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. |
time |
String |
Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply' |
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
API version of the referent. |
blockOwnerDeletion |
Boolean |
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
controller |
Boolean |
If true, this reference points to the managing controller. |
kind |
String |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
name |
String |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
uid |
String |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
参数 |
参数类型 |
描述 |
---|---|---|
hard |
Map<String,String> |
hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
scopeSelector |
scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. |
|
scopes |
Array of strings |
A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |
参数 |
参数类型 |
描述 |
---|---|---|
matchExpressions |
Array of io.k8s.api.core.v1.ScopedResourceSelectorRequirement objects |
A list of scope selector requirements by scope of the resources. |
参数 |
参数类型 |
描述 |
---|---|---|
operator |
String |
Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. |
scopeName |
String |
The name of the scope that the selector applies to. |
values |
Array of strings |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
参数 |
参数类型 |
描述 |
---|---|---|
hard |
Map<String,String> |
Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
used |
Map<String,String> |
Used is the current observed total usage of the resource in the namespace. |
参数 |
参数类型 |
描述 |
---|---|---|
continue |
String |
continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. |
remainingItemCount |
Long |
remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. |
resourceVersion |
String |
String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
selfLink |
String |
selfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. |
请求示例
无
响应示例
状态码: 200
OK
{
"apiVersion" : "v1",
"items" : [ {
"metadata" : {
"creationTimestamp" : "2022-09-07T06:07:58Z",
"name" : "compute-resources",
"namespace" : "namespace-test",
"resourceVersion" : "42717140",
"selfLink" : "/api/v1/namespaces/namespace-test/resourcequotas/compute-resources",
"uid" : "df6e7f78-717d-48e2-bf41-afab0ba0a3de"
},
"spec" : {
"hard" : {
"configmaps" : "480k",
"count/cronjobs.batch" : "960",
"count/deployments.apps" : "480",
"count/ingresses.extensions" : "480",
"count/jobs.batch" : "960",
"count/networks.networking.cci.io" : "72",
"count/statefulsets.apps" : "480",
"limits.cpu" : "100k",
"limits.memory" : "800000Gi",
"persistentvolumeclaims" : "960",
"pods" : "480k",
"requests.nvidia.com/gpu-tesla-p4" : "256",
"requests.nvidia.com/gpu-tesla-p100-16GB" : "256",
"requests.nvidia.com/gpu-tesla-v100-16GB" : "256",
"requests.nvidia.com/gpu-tesla-v100-32GB" : "256",
"secrets" : "480k",
"services" : "9600"
}
},
"status" : {
"hard" : {
"configmaps" : "480k",
"count/cronjobs.batch" : "960",
"count/deployments.apps" : "480",
"count/ingresses.extensions" : "480",
"count/jobs.batch" : "960",
"count/networks.networking.cci.io" : "72",
"count/statefulsets.apps" : "480",
"limits.cpu" : "100k",
"limits.memory" : "800000Gi",
"persistentvolumeclaims" : "960",
"pods" : "480k",
"requests.nvidia.com/gpu-tesla-p4" : "256",
"requests.nvidia.com/gpu-tesla-p100-16GB" : "256",
"requests.nvidia.com/gpu-tesla-v100-16GB" : "256",
"requests.nvidia.com/gpu-tesla-v100-32GB" : "256",
"secrets" : "480k",
"services" : "9600"
},
"used" : {
"configmaps" : "0",
"count/cronjobs.batch" : "0",
"count/deployments.apps" : "0",
"count/ingresses.extensions" : "0",
"count/jobs.batch" : "0",
"count/networks.networking.cci.io" : "1",
"count/statefulsets.apps" : "0",
"limits.cpu" : "0",
"limits.memory" : "0",
"persistentvolumeclaims" : "0",
"pods" : "0",
"requests.nvidia.com/gpu-tesla-p4" : "0",
"requests.nvidia.com/gpu-tesla-p100-16GB" : "0",
"requests.nvidia.com/gpu-tesla-v100-16GB" : "0",
"requests.nvidia.com/gpu-tesla-v100-32GB" : "0",
"secrets" : "2",
"services" : "1"
}
}
} ],
"kind" : "ResourceQuotaList",
"metadata" : {
"resourceVersion" : "42732540",
"selfLink" : "/api/v1/namespaces/namespace-test/resourcequotas"
}
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
NotFound |
405 |
MethodNotAllowed |
406 |
NotAcceptable |
409 |
Conflict |
415 |
UnsupportedMediaType |
422 |
Invalid |
429 |
TooManyRequests |
500 |
InternalError |
503 |
ServiceUnavailable |
504 |
ServerTimeout |