类型
object

规格

属性类型描述
apiVersionstring

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/api-conventions.md#resources

kindstring

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/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject
statusobject

.spec

类型
object
属性类型描述
intervalstring
jobLabelstring

INSERT ADDITIONAL SPEC FIELDS - desired state of cluster Important: Run "make" to regenerate code after modifying this file

monitorResultsobject

SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.

namespaceSelectorobject

NamespaceSelector to select which namespaces the Endpoints objects are discovered from.

pingurlsarray

A list of urls allowed as part of this ServiceMonitor.

selectorobject

Selector transfers labels on the Kubernetes Pod onto the target.

crdsarray

A list of crds allowed as part of this CaseMonitor.

.spec.monitorResults

描述
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
类型
object
属性类型描述
latestUpdatedstring
targetsarray

.spec.monitorResults.targets

类型
array

.spec.monitorResults.targets[]

类型
object
属性类型描述
lastErrorsarray
namestring
runningstring
targetTypestring

.spec.monitorResults.targets[].lastErrors

类型
array

.spec.monitorResults.targets[].lastErrors[]

类型
string

.spec.namespaceSelector

描述
NamespaceSelector to select which namespaces the Endpoints objects are discovered from.
类型
object
属性类型描述
matchNamesarray

List of namespace names.

.spec.namespaceSelector.matchNames

描述
List of namespace names.
类型
array

.spec.namespaceSelector.matchNames[]

类型
string

.spec.pingurls

描述
A list of urls allowed as part of this ServiceMonitor.
类型
array

.spec.pingurls[]

类型
object
属性类型描述
hoststring

HTTP path to scrape for metrics.

intervalstring

Interval at which metrics should be scraped

namestring

HTTP path to scrape for metrics.

paramsobject

Optional HTTP URL parameters

pathstring

HTTP path to scrape for metrics.

portstring

Name of the service port this url refers to. Mutually exclusive with targetPort.

schemestring

HTTP scheme to use for scraping.

scrapeTimeoutstring

Timeout after which the scrape is ended

tlsConfigobject

TLS configuration to use when scraping the url

urlstring

url for whole url

customErrorsarray

List of custom errors.

.spec.pingurls[].params

描述
Optional HTTP URL parameters
类型
object

.spec.pingurls[].tlsConfig

描述
TLS configuration to use when scraping the url
类型
object
属性类型描述
insecureSkipVerifyboolean

Disable target certificate validation.

.spec.pingurls[].customErrors

描述
List of custom errors.
类型
array

.spec.pingurls[].customErrors[]

类型
string

.spec.selector

描述
Selector transfers labels on the Kubernetes Pod onto the target.
类型
object
属性类型描述
matchExpressionsarray

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabelsobject

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.selector.matchExpressions

描述
matchExpressions is a list of label selector requirements. The requirements are ANDed.
类型
array

.spec.selector.matchExpressions[]

描述
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
类型
object
必填
keyoperator
属性类型描述
keystring

key is the label key that the selector applies to.

operatorstring

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

valuesarray

values is 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.

.spec.selector.matchExpressions[].values

描述
values is 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.
类型
array

.spec.selector.matchExpressions[].values[]

类型
string

.spec.selector.matchLabels

描述
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
类型
object

.spec.crds

描述
A list of crds allowed as part of this CaseMonitor.
类型
array

.spec.crds[]

类型
object
必填
namegroupkindversionoperator
属性类型描述
namestring

name of job.

groupstring

group for apigroups GroupVersionKind.

kindstring

kind for GroupVersionKind.

versionstring

version for GroupVersionKind.

crdnamestring

name of crd.

namespacestring

namespace of crd.

operatorstring

operator of the crd, like Exists, HttpPing.

basicAuthobject

BasicAuth allow an http to authenticate over basic authentication

urlstring

property name of url

customErrorsarray

List of custom errors.

.spec.crds[].basicAuth

描述
BasicAuth allow an http to authenticate over basic authentication
类型
object
属性类型描述
passwordstring

property name of password.

usernamestring

property name of username.

.spec.crds[].customErrors

描述
List of custom errors.
类型
array

.spec.crds[].customErrors[]

类型
string

.status

类型
object

API 端点

可用的 API 端点如下:

  • /apis/asm.alauda.io/v1beta2/namespaces/{namespace}/casemonitors
    • DELETE: delete collection of CaseMonitor
    • GET: list objects of kind CaseMonitor
    • POST: create a new CaseMonitor
  • /apis/asm.alauda.io/v1beta2/namespaces/{namespace}/casemonitors/{name}
    • DELETE: delete the specified CaseMonitor
    • GET: read the specified CaseMonitor
    • PATCH: partially update the specified CaseMonitor
    • PUT: replace the specified CaseMonitor

/apis/asm.alauda.io/v1beta2/namespaces/{namespace}/casemonitors

HTTP 方法
DELETE
描述
delete collection of CaseMonitor
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind CaseMonitor
HTTP 响应
HTTP 状态码响应体
200 - OKCaseMonitorList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new CaseMonitor
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyCaseMonitor schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKCaseMonitor schema
201 - CreatedCaseMonitor schema
202 - AcceptedCaseMonitor schema
401 - UnauthorizedEmpty

/apis/asm.alauda.io/v1beta2/namespaces/{namespace}/casemonitors/{name}

HTTP 方法
DELETE
描述
delete the specified CaseMonitor
查询参数
参数类型描述
dryRunstringWhen 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 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified CaseMonitor
HTTP 响应
HTTP 状态码响应体
200 - OKCaseMonitor schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified CaseMonitor
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 响应
HTTP 状态码响应体
200 - OKCaseMonitor schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified CaseMonitor
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyCaseMonitor schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKCaseMonitor schema
201 - CreatedCaseMonitor schema
401 - UnauthorizedEmpty