21.3. GetDeployment


GET /v1/deployments/{id}

GetDeployment 返回指定其 ID 的部署。

21.3.1. 描述

21.3.2. 参数

21.3.2.1. 路径参数

Expand
Name描述必填defaultpattern

id

 

X

null

 

21.3.3. 返回类型

StorageDeployment

21.3.4. 内容类型

  • application/json

21.3.5. 响应

Expand
表 21.3. HTTP 响应代码
代码消息datatype

200

成功响应。

StorageDeployment

0

意外错误响应。

RuntimeError

21.3.6. Samples

21.3.7. 常规对象参考

21.3.7.1. ContainerConfigEnvironmentConfig

Expand
字段名称必填nullable类型描述格式

key

  

字符串

  

value

  

字符串

  

envVarSource

  

EnvironmentConfigEnvVarSource

 

UNSET, RAW, SECRET_KEY, CONFIG_MAP_KEY, FIELD, RESOURCE_FIELD, UNKNOWN,

21.3.7.2. EnvironmentConfigEnvVarSource

For any update to EnvVarSource, please also update 'ui/src/messages/common.js'
Copy to Clipboard Toggle word wrap
Expand
Enum 值

UNSET

RAW

SECRET_KEY

CONFIG_MAP_KEY

字段

RESOURCE_FIELD

UNKNOWN

21.3.7.3. PortConfigExposureInfo

Expand
字段名称必填nullable类型描述格式

level

  

PortConfigExposureLevel

 

UNSET, EXTERNAL, NODE, INTERNAL, HOST, ROUTE,

serviceName

  

字符串

  

serviceId

  

字符串

  

serviceClusterIp

  

字符串

  

servicePort

  

整数

 

int32

nodePort

  

整数

 

int32

externalIps

  

字符串列表

  

externalHostnames

  

字符串列表

  

21.3.7.4. PortConfigExposureLevel

Expand
Enum 值

UNSET

EXTERNAL

节点

INTERNAL

HOST

ROUTE (路由)

21.3.7.5. ProtobufAny

any 包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。

protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。

示例 1: Pack 并在 C++ 中解包信息。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
Copy to Clipboard Toggle word wrap

示例 2:打包并解压缩 Java 消息。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
Copy to Clipboard Toggle word wrap
Example 3: Pack and unpack a message in Python.
Copy to Clipboard Toggle word wrap
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Copy to Clipboard Toggle word wrap
Example 4: Pack and unpack a message in Go
Copy to Clipboard Toggle word wrap
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}
Copy to Clipboard Toggle word wrap

默认情况下,protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中的完全限定类型名称,如 "foo.bar.com/x/x/y.z"。

21.3.7.5.1. JSON 表示

any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @typeExample:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}
Copy to Clipboard Toggle word wrap

如果嵌入式消息类型是知名且具有自定义 JSON 表示法,则该表示将被嵌入一个字段值,该值@type 字段外还包含自定义 JSON。示例(用于消息 [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

typeUrl

  

字符串

唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 path/google.protobuf.Duration)。名称应采用规范形式(例如,未接受前面的 \".\")。在实践中,团队通常会预编译到期望其在任意上下文中使用的所有类型的二进制代码。但是,对于使用方案 httphttps 或无方案的 URL,可以选择设置一个类型服务器,将类型 URL 映射到消息定义,如下所示:* 如果没有提供方案,则假设 https。* URL 上的 HTTP GET 必须以二进制格式生成一个 [google.protobuf.Type][] 值,或者产生错误。* 应用程序允许根据 URL 缓存查找结果,或者预先编译到二进制文件以避免出现任何查找。因此,为了更改类型,二进制兼容性需要保留。(使用版本控制类型名称来管理中断的更改。)注意:这个功能目前在官方 protobuf 版本中可用,它不用于以 type.googleapis.com 开头的类型 URL。自 2023 年 5 月起,没有广泛使用的类型服务器实施,没有计划实施。http 之外的方案(或空方案)可以与实施特定语义一起使用。

 

value

  

byte[]

必须是上述指定类型的有效序列化协议缓冲。

BYTE

21.3.7.6. RuntimeError

Expand
字段名称必填nullable类型描述格式

错误

  

字符串

  

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  

21.3.7.7. SeccompProfileProfileType

Expand
Enum 值

UNCONFINED

RUNTIME_DEFAULT

LOCALHOST

21.3.7.8. SecurityContextSELinux

Expand
字段名称必填nullable类型描述格式

user

  

字符串

  

role

  

字符串

  

type

  

字符串

  

level

  

字符串

  

21.3.7.9. SecurityContextSeccompProfile

Expand
字段名称必填nullable类型描述格式

type

  

SeccompProfileProfileType

 

UNCONFINED, RUNTIME_DEFAULT, LOCALHOST,

localhostProfile

  

字符串

  

21.3.7.10. StorageContainer

Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

config

  

StorageContainerConfig

  

image

  

StorageContainerImage

  

securityContext

  

StorageSecurityContext

  

  

StorageVolume列表

  

ports

  

StoragePortConfig列表

  

secrets

  

StorageEmbeddedSecret列表

  

resources

  

StorageResources

  

名称

  

字符串

  

livenessProbe

  

StorageLivenessProbe

  

readinessProbe

  

StorageReadinessProbe

  

21.3.7.11. StorageContainerConfig

Expand
字段名称必填nullable类型描述格式

env

  

ContainerConfigEnvironmentConfig列表

  

命令

  

字符串列表

  

args

  

字符串列表

  

目录

  

字符串

  

user

  

字符串

  

uid

  

字符串

 

int64

appArmorProfile

  

字符串

  

21.3.7.12. StorageContainerImage

Next tag: 12
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

名称

  

StorageImageName

  

notPullable

  

布尔值

  

isClusterLocal

  

布尔值

  

21.3.7.13. StorageDeployment

Next available tag: 35
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

名称

  

字符串

  

hash

  

字符串

 

uint64

type

  

字符串

  

namespace

  

字符串

  

namespaceId

  

字符串

  

orchestratorComponent

  

布尔值

  

replicas

  

字符串

 

int64

labels

  

字符串映射

  

podLabels

  

字符串映射

  

labelSelector

  

StorageLabelSelector

  

created

  

Date

 

date-time

clusterId

  

字符串

  

clusterName

  

字符串

  

containers

  

StorageContainer列表

  

annotations

  

字符串映射

  

priority

  

字符串

 

int64

Inactive

  

布尔值

  

imagePullSecrets

  

字符串列表

  

serviceAccount

  

字符串

  

serviceAccountPermissionLevel

  

StoragePermissionLevel

 

UNSET, NONE, DEFAULT, ELEVATED_IN_NAMESPACE, ELEVATED_CLUSTER_WIDE, CLUSTER_ADMIN,

automountServiceAccountToken

  

布尔值

  

hostNetwork

  

布尔值

  

hostPid

  

布尔值

  

hostIpc

  

布尔值

  

runtimeClass

  

字符串

  

容限(tolerations)

  

StorageToleration列表

  

ports

  

StoragePortConfig列表

  

stateTimestamp

  

字符串

 

int64

riskScore

  

浮点值

 

浮点值

21.3.7.14. StorageEmbeddedSecret

Expand
字段名称必填nullable类型描述格式

名称

  

字符串

  

path

  

字符串

  

21.3.7.15. StorageImageName

Expand
字段名称必填nullable类型描述格式

registry

  

字符串

  

remote

  

字符串

  

tag

  

字符串

  

fullName

  

字符串

  

21.3.7.16. StorageLabelSelector

Label selector components are joined with logical AND, see     https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
Copy to Clipboard Toggle word wrap

下一个可用标签:3

Expand
字段名称必填nullable类型描述格式

matchLabels

  

字符串映射

这实际上是一个,但由于向后兼容性限制,我们不能使其成为一种。

 

要求

  

StorageLabelSelectorRequirement列表

  

21.3.7.17. StorageLabelSelectorOperator

Expand
Enum 值

UNKNOWN

IN

NOT_IN

EXISTS

NOT_EXISTS

21.3.7.18. StorageLabelSelectorRequirement

Next available tag: 4
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

key

  

字符串

  

op

  

StorageLabelSelectorOperator

 

UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS,

values

  

字符串列表

  

21.3.7.19. StorageLivenessProbe

Expand
字段名称必填nullable类型描述格式

已定义

  

布尔值

  

21.3.7.20. StoragePermissionLevel

For any update to PermissionLevel, also update: - pkg/searchbasedpolicies/builders/k8s_rbac.go - ui/src/messages/common.js
Copy to Clipboard Toggle word wrap
Expand
Enum 值

UNSET

NONE

DEFAULT

ELEVATED_IN_NAMESPACE

ELEVATED_CLUSTER_WIDE

CLUSTER_ADMIN

21.3.7.21. StoragePortConfig

Next Available Tag: 6
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

名称

  

字符串

  

containerPort

  

整数

 

int32

protocol

  

字符串

  

exposure

  

PortConfigExposureLevel

 

UNSET, EXTERNAL, NODE, INTERNAL, HOST, ROUTE,

exposedPort

  

整数

 

int32

exposureInfos

  

PortConfigExposureInfo列表

  

21.3.7.22. StorageReadinessProbe

Expand
字段名称必填nullable类型描述格式

已定义

  

布尔值

  

21.3.7.23. StorageResources

Expand
字段名称必填nullable类型描述格式

cpuCoresRequest

  

浮点值

 

浮点值

cpuCoresLimit

  

浮点值

 

浮点值

memoryMbRequest

  

浮点值

 

浮点值

memoryMbLimit

  

浮点值

 

浮点值

21.3.7.24. StorageSecurityContext

Expand
字段名称必填nullable类型描述格式

privileged

  

布尔值

  

selinux

  

SecurityContextSELinux

  

dropCapabilities

  

字符串列表

  

addCapabilities

  

字符串列表

  

readOnlyRootFilesystem

  

布尔值

  

seccompProfile

  

SecurityContextSeccompProfile

  

allowPrivilegeEscalation

  

布尔值

  

21.3.7.25. StorageTaintEffect

Expand
Enum 值

UNKNOWN_TAINT_EFFECT

NO_SCHEDULE_TAINT_EFFECT

PREFER_NO_SCHEDULE_TAINT_EFFECT

NO_EXECUTE_TAINT_EFFECT

21.3.7.26. StorageToleration

Expand
字段名称必填nullable类型描述格式

key

  

字符串

  

operator

  

StorageTolerationOperator

 

TOLERATION_OPERATION_UNKNOWN, TOLERATION_OPERATOR_EXISTS, TOLERATION_OPERATOR_EQUAL,

value

  

字符串

  

taintEffect

  

StorageTaintEffect

 

UNKNOWN_TAINT_EFFECT, NO_SCHEDULE_TAINT_EFFECT, PREFER_NO_SCHEDULE_TAINT_EFFECT, NO_EXECUTE_TAINT_EFFECT,

21.3.7.27. StorageTolerationOperator

Expand
Enum 值

TOLERATION_OPERATION_UNKNOWN

TOLERATION_OPERATOR_EXISTS

TOLERATION_OPERATOR_EQUAL

21.3.7.28. StorageVolume

Expand
字段名称必填nullable类型描述格式

名称

  

字符串

  

source

  

字符串

  

目的地

  

字符串

  

readOnly

  

布尔值

  

type

  

字符串

  

mountPropagation

  

VolumeMountPropagation

 

NONE, HOST_TO_CONTAINER, MIX,

21.3.7.29. VolumeMountPropagation

Expand
Enum 值

NONE

HOST_TO_CONTAINER

双向

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat