数据类型

ListMeta

名称 类型 是否必须 描述
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.
selfLink String SelfLink is a URL representing this object. Populated by the system. Read-only.

ObjectMeta

名称 类型 是否必须 描述
name String Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. 0 characters < name length ≤ 253 characters. The name must be a regular expression [a-z0-9]([-a-z0-9]*[a-z0-9])?
clusterName String The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
initializers Object(Initializers) An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
enable Boolean Enable identify whether the resource is available.
generateName String An optional prefix used by the server to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409. Instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified.
0 characters < generated name length ≤ 253 characters.
The generated name must be a regular expression [a-z0-9]([-a-z0-9]*[a-z0-9])?
namespace String Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated.
0 characters < namespace length ≤ 63 characters.
The namespace must be a regular expression [a-z0-9]([-a-z0-9]*[a-z0-9])?
selfLink String A URL representing this object. Populated by the system. Read-only.
说明:
This field is automatically generated. Do not assign any value to this field. Otherwise, API calls would fail.
uid No String UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only.
说明:
This field is automatically generated. Do not assign any value to this field. Otherwise, API calls would fail.
resourceVersion String An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients.
说明:
This field is automatically generated. Do not assign any value to this field. Otherwise, API calls would fail.
generation Integer A sequence number representing a specific generation of the desired state. Currently only implemented by replication controllers. Populated by the system. Read-only.
creationTimestamp String A timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists.
说明:
This field is automatically generated. Do not assign any value to this field. Otherwise, API calls would fail.
deletionTimestamp String RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only.
deletionGracePeriodSeconds Integer Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
labels Object Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services.
说明:
This field should be filled in to create the real storage dynamically.The value of the field is according to the real region and zone.
annotations Object An unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
说明:
This field should be filled in to create the real storage dynamically.This filed indicates the storage plugin and the StorageClass.
ownerReferences OwnerReference列表 List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
finalizers String array Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Initializers

名称 类型 是否必须 描述
pending Initializer列表 Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
result Status If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.

Initializer

名称 类型 是否必须 描述
name String name of the process that is responsible for initializing this object.

Status

名称 类型 是否必须 描述
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.
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.
metadata ListMeta Standard list metadata.
status String Status of the operation. One of: "Success" or "Failure".
message String A human-readable description of the status of this operation.
reason String A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
details StatusDetails Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
code integer (int32) Suggested HTTP return code for this status, 0 if not set.

StatusDetails

名称 类型 是否必须 描述
name String The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
group String The group attribute of the resource associated with the status StatusReason.
kind String The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind.
uid String UID of the resource. (when there is a single resource which can be described).
causes StatusCause列表 The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
retryAfterSeconds integer (int32) If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.

StatusCause

名称 类型 是否必须 描述
reason String A machine-readable description of the cause of the error. If this value is empty there is no information available.
message String A human-readable description of the cause of the error. This field may be presented as-is to a reader.
field String The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples:
"name" - the field "name" on the current resource
"items[0].name" - the field "name" on the first array entry in "items"

OwnerReference

名称 类型 是否必须 描述
apiVersion String API version of the referent.
kind String Kind of the referent.
name String Name of the referent.
uid String UID of the referent.
controller boolean If true, this reference points to the managing controller. Default FALSE
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. Default FALSE

PodSpec容器组描述

名称 类型 是否必须 描述
volumes Volume列表 挂载卷列表。
initContainers Container列表 初始化容器列表
containers Container列表 容器列表
dnsPolicy String DNS策略
restartPolicy String 重启策略
schedulerName String 调度名称
terminationGracePeriodSeconds Integer 终止周期
imagePullSecrets String 拉取的私仓镜像名称

Container容器

名称 类型 是否必须 描述
image String 镜像名称
imagePullPolicy String 镜像拉取策略
name String 镜像名称编码
terminationMessagePath String 终端信息路径
terminationMessagePolicy String 终端信息挂载策略
ports ContainerPorts 容器端口

ContainerPorts

名称 类型 是否必须 描述
containerPort Integer Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
protocol String Protocol for port. Must be UDP or TCP. Defaults to "TCP".
name String If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
hostPort Integer Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
hostIP String What host IP to bind the external port to.

ServicePort服务端口

名称 类型 是否必须 描述
targetPort Integer 服务目标端口。
protocol String 服务协议

SecretItem

名称 位置 类型 是否必须 描述
data body map 密钥数据
metadata body ObjectMeta列表 密钥元数据
type body String 密钥类型

ConfigMap

名称 类型 是否必须 描述
metadata Object(ObjectMeta) Standard metadata
data map 配置项数据(键值对)

PodDetail容器组详情

名称 类型 是否必须 描述
obejectMeta ObjectMeta 元数据信息
typeMeta TypeMeta 类型信息
podPhase String 容器组状态
podIp String 容器组的ip
nodeName String 节点名称
restartCount int 重启次数
containers List<Container> 容器组
initContainers List<Container> 初始化容器组
conditions List<Condition> 现状信息
eventList EventList 事件列表信息
persistentvolumeclaimList PersistentvolumeclaimListpvc列表 pvc列表信息

Condition现状信息

名称 类型 是否必须 描述
type String 类型信息
status String 状态信息
lastProbeTime String 上次检测时间
lastTransitionTime String 上次改变时间
reason String 原因
message String 消息信息

EventList事件列表

名称 类型 是否必须 描述
listMeta ListMeta 事件数量信息
events List<Event> 事件列表信息

Event事件

名称 类型 是否必须 描述
objectMeta ObjectMeta 元数据信息
typeMeta String 类型信息
count int 发生次数
reason String 事件原因
type String 事件类别信息

PersistentVolumeClaim

名称 类型 是否必须 描述
objectMeta ObjectMeta 元数据信息
typeMeta TypeMeta 类型信息
status String pvc状态
volume String 挂载卷名称
capacity map 性能信息
accessModes List 读写访问权限
storageClass String 存储类别

PersistentVolumeClaimList

名称 类型 是否必须 描述
listMeta ListMeta 列表数量信息
items List<PersistentVolumeClaim> pvc列表
errors List 错误信息

Instance应用实例详情

名称 类型 是否必须 描述
accessMode String 访问模式
appName String 应用ID
containerImage String 镜像名称
containerImageId String 镜像编码
createTime String 实例创建时间
creatorId String 创建者ID
deleteTime String 实例删除时间
deploymentDetail DeploymentDetail 无状态负载详情
statefulsetDetail StatefulsetDetail 有状态负载详情
displayName String 实例名称
environmentId String 集群ID
id String UUID
name String 实例ID
namespace String 命名空间
ownerGroupId String 实例所属组
ownerId String 实例所有者ID
podSpec PodSpec 容器组描述
releaseStrategyType String 发布策略
replicas Integer 副本数
routeHost String 域名前缀
routeSubDomain String 域名后缀
servicePort Object(ServicePort列表) 服务端口
updateTime String 实例更新时间
virtualService VirtualService 服务网关详情

Instance应用实例

名称 类型 是否必须 描述
accessMode String 访问模式
appName String 应用ID
containerImage String 镜像名称
containerImageId String 镜像编码
createTime String 实例创建时间
creatorId String 创建者ID
deleteTime String 实例删除时间
displayName String 实例名称
environmentId String 集群ID
id String UUID
name String 实例ID
namespace String 命名空间
ownerGroupId String 实例所属组
ownerId String 实例所有者ID
podSpec PodSpec 容器组描述
virtualService VirtualService 服务网关详情

TypeMeta

名称 类型 是否必须 描述
kind String 类型信息

DeploymentDetail无状态负载详情

名称 类型 是否必须 描述
obejectMeta ObjectMeta 元数据信息
typeMeta TypeMeta 类型信息
podList podList 容器组列表
selector map 标签选择器
statusInfo StatusInfo 状态信息
oldReplicaSetList OldReplicaSetList 旧副本集合列表
newReplicaSet ReplicaSet 新副本集合
revisionHistoryLimit int 允许回滚的版本限制
eventList EventList 事件列表信息
errors List 错误信息

StatefulsetDetail有状态负载详情

名称 类型 是否必须 描述
objectMeta ObjectMeta 元数据信息
typeMeta TypeMeta 类型信息
podList podList 容器组列表
podInfo PodInfo 容器组列表状态信息
statusInfo StatusInfo 状态信息
eventList EventList 事件列表信息
errors List 错误信息
replicas integer 副本个数

OldReplicaSetList旧副本列表

名称 类型 是否必须 描述
listMeta ListMeta 列表数量信息
status ResourceStatisticsInfo 资源统计信息
replicaSets List<ReplicaSet> 副本列表详情
errors List 错误信息

ReplicaSet副本信息

名称 类型 是否必须 描述
obejectMeta ObjectMeta 元数据信息
typeMeta TypeMeta 类型信息
pods PodsInfo 所属容器组信息
containerImages List 容器镜像信息
initContainerImages List 初始化容器镜像信息

PodInfo

名称 类型 是否必须 描述
current int 当前容器组数量
desired int 期望容器组数量
running int 运行中容器组数量
pending int 启动中容器组数量
failed int 失败容器组数量
succeeded int 成功容器组数量
warnings List<Event> 警告事件信息

ResourceStatisticsInfo资源统计信息

名称 类型 是否必须 描述
running int 运行中资源数量
pending int 启动中资源数量
failed int 失败资源数量
succeeded int 成功资源数量

StatusInfo状态信息

名称 类型 是否必须 描述
replicas int 期望副本数
updated int 已更新个数
available int 可用数量
unavailable int 不可用数量

PodList容器组列表

名称 类型 是否必须 描述
listMeta ListMeta 列表资源数量信息
status ResourceStatisticsInfo 资源统计信息
pods List<Pod> 容器组列表数据
errors List 错误信息列表

容器组

名称 类型 是否必须 描述
obejectMeta ObjectMeta 元数据信息
typeMeta TypeMeta 类型信息
podStatus PodStatus 容器组状态
restartCount int 重启次数
warnings List<Event> 错误事件信息
nodeName String 节点名称

PodStatus容器组状态

名称 类型 是否必须 描述
phase string 容器组状态
message string 容器组信息
reason string 状态原因
hostIP string HostIP
podIP string 容器组IP
qosClass string qos分类
conditions List<condition> Pod Condition

LogInfo容器组日志信息

名称 类型 是否必须 描述
podName string 容器组名称
containerName string 容器名称
initContainerName string 初始化容器名称
fromDate int string 首个日志
toDate int string 末位日志
Truncated bool 截断标志

LogLine

名称 类型 是否必须 描述
timestamp string 时间戳
content string 日志内容

Selection日志选择

名称 类型 是否必须 描述
offsetFrom int 索引起始位
offsetTo int 索引结束位
logFilePosition string log位
referencePoint LogLineId 参考ID

LogLineId日志参考ID

名称 类型 是否必须 描述
logTimestamp string 日志时间戳
lineNum int 所在行

DeploymentSpec无状态负载详情

名称 类型 是否必须 描述
progressDeadlineSeconds Integer 时长上限
replicas Integer 副本数
revisionHistoryLimit Integer 历史版本上限
selector map 标签选择器
strategy Strategy 更新策略
template Template 模板

DeploymentStatus无状态负载状态

名称 类型 是否必须 描述
availableReplicas Integer 可用副本数
observedGeneration Integer 观测版本
replicas Integer 副本数
unavailableReplicas Integer 不可用副本数
updatedReplicas Integer 更新副本数
conditions DeploymentCondition 无状态负载状态

Strategy更新策略

名称 类型 是否必须 描述
type String 更新机制类型
rollingUpdate map 滚动升级参数

Template模板

名称 类型 是否必须 描述
metadata Object(ObjectMeta) Standard metadata
spec Object(spec) 模板详情

DeploymentCondition

名称 类型 是否必须 描述
type String Type of deployment condition.
status String Status of the condition, one of True, False, Unknown.
lastUpdateTime String The last time this condition was updated.
lastTransitionTime String Last time the condition transitioned from one status to another.
reason String The reason for the condition’s last transition.
message String A human readable message indicating details about the transition.

K8s-Pod

名称 类型 是否必须 描述
obejectMeta ObjectMeta 元数据信息
typeMeta TypeMeta 类型信息
spec PodSpec pod描述信息
status PodStatus 容器组状态信息

PodEnvs容器组环境变量

名称 类型 是否必须 描述
PodName String 容器组名称
Name String 环境变量名称
Value String
ValueFrom map 值来源

PodVolumeMounts容器组挂载卷

名称 类型 是否必须 描述
PodName String 容器组名称
Name String 挂载卷名称
MountPath String 挂载路径

PodStatus容器组状态信息

名称 类型 是否必须 描述
Phase String 状态
Conditions List<Condition> 现状信息列表
Message String 驼峰消息标识
Reason String 原因
HostIP String hostip
PodIP String 容器组IP
StartTime String 开始时间
InitContainerStatuses List<ContainerStatus> 初始化容器状态
ContainerStatuses List<ContainerStatus> 容器状态
QOSClass String 服务质量级别

ContainerStatus容器状态

名称 类型 是否必须 描述
Name String 容器名称
State String 容器状态
LastTerminationState String 上次状态
Ready String 是否就绪
RestartCount int 重启次数
Image String 镜像
ImageId String 镜像ID
ContainerID String 容器ID

DeployChange部署改变记录

名称 类型 是否必须 描述
version String 版本
status String 状态
cause String 原因
time String 发生时间

Maintainer

名称 类型 是否必须 描述
name String Name is a user name or organization name
email String Email is an optional email address to contact the named maintainer
url String Url is an optional URL to an address for the named maintainer

ChartMetadata

名称 类型 是否必须 描述
name String The name of the chart
home String The URL to a relevant project page, git repo, or contact person
sources []string Source is the URL to the source code of this chart
version String A SemVer 2 conformant version string of the chart
description String A one-sentence description of the chart
keywords []string A list of string keywords
maintainers Object(Maintainer) 发生时间
engine String The name of the template engine to use. Defaults to 'gotpl'.
icon String he URL to an icon file.
apiVersion String The API Version of this chart.
condition String The condition to check to enable chart
tags String The tags to check to enable chart
appVersion String The version of the application enclosed inside of this chart.
deprecated bool Whether or not this chart is deprecated
tillerVersion String illerVersion is a SemVer constraints on what version of Tiller is required.
annotations map[string]string Annotations are additional mappings uninterpreted by Tiller
kubeVersion String KubeVersion is a SemVer constraint specifying the version of Kubernetes required.

ChartDetail

名称 类型 是否必须 描述
metadata Object(ChartMetadata) 版本
valuesRaw String 模板配置参数base64加密
values map[string]interface{} 模板配置参数
templates map[string]string 模板文件列表
chartURL String 模板缓存url
created String 模板创建时间
repoUrl String 模板仓库url
readme String 模板使用说明

Repository镜像详情

名称 位置 类型 是否必须 描述
id body Integer 镜像ID
name body String 镜像全称
repoName body String 镜像名称
pullCount body Integer 下载次数
tagsCount body String 标签数量
creationTime body String 创建时间
updateTime body String 更新时间

Repository镜像tag详情

名称 位置 类型 是否必须 描述
digest body String 镜像标识
path body String 镜像访问路径
name body String tag名称
size body Long 镜像tag大小
created body String 创建时间

NetAddress访问地址

名称 位置 类型 是否必须 描述
matchMode body String url匹配方式
netAddress body String 访问地址

Job

名称 位置 类型 是否必须 描述
metadata body ObjectMeta 普通任务元数据信息
jobSpec body JobSpec 普通任务规格信息
jobStatus body JobStatus 普通任务状态信息

JobSpec

名称 位置 类型 是否必须 描述
parallelism body integer 并行度
completions body integer 要完成的次数
activeDeadlineSeconds body integer 超时时间
backoffLimit body integer 重试次数
selector body map 标签选择器
template body Template 容器组模板信息

JobStatus

名称 位置 类型 是否必须 描述
conditions body List<Condition> 普通任务现状信息
startTime body string 开始时间
completionTime body string 完成时间
active body integer 存活个数
succeeded body integer 成功个数
failed body integer 失败个数

Cronjob

名称 位置 类型 是否必须 描述
ObjectMeta body ObjectMeta 定时任务元数据信息
TypeMeta body TypeMeta 定时任务类型信息
Schedule body string 定时规则
Suspend body bool 定时任务是否处于暂停状态
Active body integer 正在执行的任务个数