APIRequestCount [apiserver.openshift.io/v1]

Description

APIRequestCount tracks requests made to an API. The instance name must be of the form resource.version.group, matching the resource. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

`object`

Required

• spec

Specification

Property	Type	Description
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	ObjectMeta	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec	object	spec defines the characteristics of the resource.
status	object	status contains the observed state of the resource.

.spec

Description

spec defines the characteristics of the resource.

Type

`object`

Property	Type	Description
numberOfUsersToReport	integer	numberOfUsersToReport is the number of users to include in the report. If unspecified or zero, the default is ten. This is default is subject to change.

.status

Description

status contains the observed state of the resource.

Type

`object`

Property	Type	Description
conditions	array	conditions contains details of the current status of this API Resource.
conditions[]	object	Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }
currentHour	object	currentHour contains request history for the current hour. This is porcelain to make the API easier to read by humans seeing if they addressed a problem. This field is reset on the hour.
last24h	array	last24h contains request history for the last 24 hours, indexed by the hour, so 12:00AM-12:59 is in index 0, 6am-6:59am is index 6, etc. The index of the current hour is updated live and then duplicated into the requestsLastHour field.
last24h[]	object	PerResourceAPIRequestLog logs request for various nodes.
removedInRelease	string	removedInRelease is when the API will be removed.
requestCount	integer	requestCount is a sum of all requestCounts across all current hours, nodes, and users.

.status.conditions

Description

conditions contains details of the current status of this API Resource.

Type

`array`

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Type

`object`

Required

• lastTransitionTime
• message
• reason
• status
• type

Property	Type	Description
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	string	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	string	reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	string	status of the condition, one of True, False, Unknown.
type	string	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.currentHour

Description

currentHour contains request history for the current hour. This is porcelain to make the API easier to read by humans seeing if they addressed a problem. This field is reset on the hour.

Type

`object`

Property	Type	Description
byNode	array	byNode contains logs of requests per node.
byNode[]	object	PerNodeAPIRequestLog contains logs of requests to a certain node.
requestCount	integer	requestCount is a sum of all requestCounts across nodes.

.status.currentHour.byNode

Description

byNode contains logs of requests per node.

Type

`array`

.status.currentHour.byNode[]

Description

PerNodeAPIRequestLog contains logs of requests to a certain node.

Type

`object`

Property	Type	Description
byUser	array	byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list.
byUser[]	object	PerUserAPIRequestCount contains logs of a user’s requests.
nodeName	string	nodeName where the request are being handled.
requestCount	integer	requestCount is a sum of all requestCounts across all users, even those outside of the top 10 users.

.status.currentHour.byNode[].byUser

Description

byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list.

Type

`array`

.status.currentHour.byNode[].byUser[]

Description

PerUserAPIRequestCount contains logs of a user’s requests.

Type

`object`

Property	Type	Description
byVerb	array	byVerb details by verb.
byVerb[]	object	PerVerbAPIRequestCount requestCounts requests by API request verb.
requestCount	integer	requestCount of requests by the user across all verbs.
userAgent	string	userAgent that made the request. The same user often has multiple binaries which connect (pods with many containers). The different binaries will have different userAgents, but the same user. In addition, we have userAgents with version information embedded and the userName isn’t likely to change.
username	string	userName that made the request.

.status.currentHour.byNode[].byUser[].byVerb

Description

byVerb details by verb.

Type

`array`

.status.currentHour.byNode[].byUser[].byVerb[]

Description

PerVerbAPIRequestCount requestCounts requests by API request verb.

Type

`object`

Property	Type	Description
requestCount	integer	requestCount of requests for verb.
verb	string	verb of API request (get, list, create, etc...)

.status.last24h

Description

last24h contains request history for the last 24 hours, indexed by the hour, so 12:00AM-12:59 is in index 0, 6am-6:59am is index 6, etc. The index of the current hour is updated live and then duplicated into the requestsLastHour field.

Type

`array`

.status.last24h[]

Description

PerResourceAPIRequestLog logs request for various nodes.

Type

`object`

Property	Type	Description
byNode	array	byNode contains logs of requests per node.
byNode[]	object	PerNodeAPIRequestLog contains logs of requests to a certain node.
requestCount	integer	requestCount is a sum of all requestCounts across nodes.

.status.last24h[].byNode

Description

byNode contains logs of requests per node.

Type

`array`

.status.last24h[].byNode[]

Description

PerNodeAPIRequestLog contains logs of requests to a certain node.

Type

`object`

Property	Type	Description
byUser	array	byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list.
byUser[]	object	PerUserAPIRequestCount contains logs of a user’s requests.
nodeName	string	nodeName where the request are being handled.
requestCount	integer	requestCount is a sum of all requestCounts across all users, even those outside of the top 10 users.

.status.last24h[].byNode[].byUser

Description

byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list.

Type

`array`

.status.last24h[].byNode[].byUser[]

Description

PerUserAPIRequestCount contains logs of a user’s requests.

Type

`object`

Property	Type	Description
byVerb	array	byVerb details by verb.
byVerb[]	object	PerVerbAPIRequestCount requestCounts requests by API request verb.
requestCount	integer	requestCount of requests by the user across all verbs.
userAgent	string	userAgent that made the request. The same user often has multiple binaries which connect (pods with many containers). The different binaries will have different userAgents, but the same user. In addition, we have userAgents with version information embedded and the userName isn’t likely to change.
username	string	userName that made the request.

.status.last24h[].byNode[].byUser[].byVerb

Description

byVerb details by verb.

Type

`array`

.status.last24h[].byNode[].byUser[].byVerb[]

Description

PerVerbAPIRequestCount requestCounts requests by API request verb.

Type

`object`

Property	Type	Description
requestCount	integer	requestCount of requests for verb.
verb	string	verb of API request (get, list, create, etc...)

API endpoints

The following API endpoints are available:

• /apis/apiserver.openshift.io/v1/apirequestcounts
  • DELETE: delete collection of APIRequestCount
  • GET: list objects of kind APIRequestCount
  • POST: create an APIRequestCount
• /apis/apiserver.openshift.io/v1/apirequestcounts/{name}
  • DELETE: delete an APIRequestCount
  • GET: read the specified APIRequestCount
  • PATCH: partially update the specified APIRequestCount
  • PUT: replace the specified APIRequestCount
• /apis/apiserver.openshift.io/v1/apirequestcounts/{name}/status
  • GET: read status of the specified APIRequestCount
  • PATCH: partially update status of the specified APIRequestCount
  • PUT: replace status of the specified APIRequestCount

/apis/apiserver.openshift.io/v1/apirequestcounts

HTTP method

`DELETE`

Description

delete collection of APIRequestCount

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind APIRequestCount

HTTP responses

HTTP code	Reponse body
200 - OK	APIRequestCountList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create an APIRequestCount

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	APIRequestCount schema

HTTP responses

HTTP code	Reponse body
200 - OK	APIRequestCount schema
201 - Created	APIRequestCount schema
202 - Accepted	APIRequestCount schema
401 - Unauthorized	Empty

/apis/apiserver.openshift.io/v1/apirequestcounts/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the APIRequestCount

HTTP method

`DELETE`

Description

delete an APIRequestCount

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified APIRequestCount

HTTP responses

HTTP code	Reponse body
200 - OK	APIRequestCount schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified APIRequestCount

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	APIRequestCount schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified APIRequestCount

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	APIRequestCount schema

HTTP responses

HTTP code	Reponse body
200 - OK	APIRequestCount schema
201 - Created	APIRequestCount schema
401 - Unauthorized	Empty

/apis/apiserver.openshift.io/v1/apirequestcounts/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the APIRequestCount

HTTP method

`GET`

Description

read status of the specified APIRequestCount

HTTP responses

HTTP code	Reponse body
200 - OK	APIRequestCount schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified APIRequestCount

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	APIRequestCount schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified APIRequestCount

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	APIRequestCount schema

HTTP responses

HTTP code	Reponse body
200 - OK	APIRequestCount schema
201 - Created	APIRequestCount schema
401 - Unauthorized	Empty