主页
产品
Red Hat Advanced Cluster Security for Kubernetes
4.5
API 参考
54.3. GetSecret

54.3. GetSecret

GET /v1/secrets/{id}

GetSecret 返回其 ID 的 secret。

54.3.1. 描述
复制链接

54.3.2. 参数
复制链接

54.3.2.1. 路径参数
复制链接

Expand

Name	描述	必填	default	pattern
id		X	null

54.3.3. 返回类型
复制链接

StorageSecret

54.3.4. 内容类型
复制链接

application/json

54.3.5. 响应
复制链接

Expand

表 54.3. HTTP 响应代码
代码	消息	datatype
200	成功响应。	StorageSecret
0	意外错误响应。	RuntimeError

54.3.6. Samples
复制链接

54.3.7. 常规对象参考
复制链接

54.3.7.1. ImagePullSecretRegistry
复制链接

Expand

字段名称	必填	nullable	类型	描述	格式
名称			字符串
username			字符串

54.3.7.2. ProtobufAny
复制链接

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

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

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

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

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());
}

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.

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)
  ...

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

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 {
  ...
}

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"。

54.3.7.2.1. JSON 表示
复制链接

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

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

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>
}

{
  "@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"
}

{
  "@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`）。名称应采用规范形式（例如，未接受前面的 \".\"）。在实践中，团队通常会预编译到期望其在任意上下文中使用的所有类型的二进制代码。但是，对于使用方案 `http`、`https` 或无方案的 URL，可以选择设置一个类型服务器，将类型 URL 映射到消息定义，如下所示：* 如果没有提供方案，则假设 `https`。* URL 上的 HTTP GET 必须以二进制格式生成一个 [google.protobuf.Type][] 值，或者产生错误。* 应用程序允许根据 URL 缓存查找结果，或者预先编译到二进制文件以避免出现任何查找。因此，为了更改类型，二进制兼容性需要保留。（使用版本控制类型名称来管理中断的更改。）注意：这个功能目前在官方 protobuf 版本中可用，它不用于以 type.googleapis.com 开头的类型 URL。自 2023 年 5 月起，没有广泛使用的类型服务器实施，没有计划实施。`http` 之外的方案（或空方案）可以与实施特定语义一起使用。
value			byte[]	必须是上述指定类型的有效序列化协议缓冲。	BYTE

54.3.7.3. RuntimeError
复制链接

Expand

字段名称	类型	格式
错误	字符串
code	整数	int32
message	字符串
详情	ProtobufAny列表

54.3.7.4. StorageCert
复制链接

Expand

字段名称	类型	格式
subject	StorageCertName
Issuer	StorageCertName
sans	`字符串列表`
startDate	Date	date-time
endDate	Date	date-time
algorithm	字符串

54.3.7.5. StorageCertName
复制链接

Expand

字段名称	必填	nullable	类型	描述	格式
commonName			字符串
国家			字符串
机构			字符串
organizationUnit			字符串
地点			字符串
省			字符串
streetAddress			字符串
postalCode			字符串
名称			`字符串列表`

54.3.7.6. StorageImagePullSecret
复制链接

Expand

字段名称	必填	nullable	类型	描述	格式
registries			ImagePullSecretRegistry列表

54.3.7.7. StorageSecret
复制链接

Flat secret object. Any properties of an individual secret. (regardless of time, scope, or context) ////////////////////////////////////////

Flat secret object. Any properties of an individual secret. (regardless of time, scope, or context) ////////////////////////////////////////

Copy to Clipboard

Toggle word wrap

Expand

字段名称	类型	描述	格式
id	字符串
名称	字符串
clusterId	字符串
clusterName	字符串
namespace	字符串
type	字符串
labels	`字符串`映射
annotations	`字符串`映射
createdAt	Date		date-time
files	StorageSecretDataFile列表	有关 secret 的元数据。secret 不需要是一个文件，但可能是任意值。
关系	StorageSecretRelationship

54.3.7.8. StorageSecretContainerRelationship
复制链接

Secrets can be mounted in a path in a container. Next Tag: 3

Secrets can be mounted in a path in a container. Next Tag: 3

Copy to Clipboard

Toggle word wrap

Expand

字段名称	必填	nullable	类型	描述	格式
id			字符串	挂载 secret 的容器 ID。
path			字符串	path 是容器特定的挂载目录。

54.3.7.9. StorageSecretDataFile
复制链接

有关 secret 的元数据。为证书文件和 imagePullSecret 提供其他信息，但"文件"也可能代表一些任意值。

Expand

字段名称	类型	格式
名称	字符串
type	StorageSecretType	UNDETERMINED, PUBLIC_CERTIFICATE, CERTIFICATE_REQUEST, PRIVACY_ENHANCED_MESSAGE, OPENSSH_PRIVATE_KEY, PGP_PRIVATE_KEY, EC_PRIVATE_KEY, RSA_PRIVATE_KEY, DSA_PRIVATE_KEY, CERT_PRIVATE_KEY, ENCRYPTED_PRIVATE_KEY, IMAGE_PULL_SECRET,
cert	StorageCert
imagePullSecret	StorageImagePullSecret

54.3.7.10. StorageSecretDeploymentRelationship
复制链接

Secrets can be used by a deployment. Next Tag: 3

Secrets can be used by a deployment. Next Tag: 3

Copy to Clipboard

Toggle word wrap

Expand

字段名称	必填	nullable	类型	描述	格式
id			字符串	使用容器中的 secret 部署 ID。
名称			字符串	部署的名称。

54.3.7.11. StorageSecretRelationship
复制链接

The combined relationships that belong to the secret. Next Tag: 6

The combined relationships that belong to the secret. Next Tag: 6

Copy to Clipboard

Toggle word wrap

Expand

字段名称	类型	描述
id	字符串
containerRelationships	StorageSecretContainerRelationship列表
deploymentRelationships	StorageSecretDeploymentRelationship列表	要关系的部署 ID。

54.3.7.12. StorageSecretType
复制链接

Expand

Enum 值
未确定
PUBLIC_CERTIFICATE
CERTIFICATE_REQUEST
PRIVACY_ENHANCED_MESSAGE
OPENSSH_PRIVATE_KEY
PGP_PRIVATE_KEY
EC_PRIVATE_KEY
RSA_PRIVATE_KEY
DSA_PRIVATE_KEY
CERT_PRIVATE_KEY
ENCRYPTED_PRIVATE_KEY
IMAGE_PULL_SECRET

54.3. GetSecret

54.3.1. 描述
复制链接

54.3.2. 参数
复制链接

54.3.2.1. 路径参数
复制链接

54.3.3. 返回类型
复制链接

54.3.4. 内容类型
复制链接

54.3.5. 响应
复制链接

54.3.6. Samples
复制链接

54.3.7. 常规对象参考
复制链接

54.3.7.1. ImagePullSecretRegistry
复制链接

54.3.7.2. ProtobufAny
复制链接

54.3.7.2.1. JSON 表示
复制链接

54.3.7.3. RuntimeError
复制链接

54.3.7.4. StorageCert
复制链接

54.3.7.5. StorageCertName
复制链接

54.3.7.6. StorageImagePullSecret
复制链接

54.3.7.7. StorageSecret
复制链接

54.3.7.8. StorageSecretContainerRelationship
复制链接

54.3.7.9. StorageSecretDataFile
复制链接

54.3.7.10. StorageSecretDeploymentRelationship
复制链接

54.3.7.11. StorageSecretRelationship
复制链接

54.3.7.12. StorageSecretType
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

54.3. GetSecret

54.3.1. 描述复制链接链接已复制到粘贴板!

54.3.2. 参数复制链接链接已复制到粘贴板!

54.3.2.1. 路径参数复制链接链接已复制到粘贴板!

54.3.3. 返回类型复制链接链接已复制到粘贴板!

54.3.4. 内容类型复制链接链接已复制到粘贴板!

54.3.5. 响应复制链接链接已复制到粘贴板!

54.3.6. Samples复制链接链接已复制到粘贴板!

54.3.7. 常规对象参考复制链接链接已复制到粘贴板!

54.3.7.1. ImagePullSecretRegistry复制链接链接已复制到粘贴板!

54.3.7.2. ProtobufAny复制链接链接已复制到粘贴板!

54.3.7.2.1. JSON 表示复制链接链接已复制到粘贴板!

54.3.7.3. RuntimeError复制链接链接已复制到粘贴板!

54.3.7.4. StorageCert复制链接链接已复制到粘贴板!

54.3.7.5. StorageCertName复制链接链接已复制到粘贴板!

54.3.7.6. StorageImagePullSecret复制链接链接已复制到粘贴板!

54.3.7.7. StorageSecret复制链接链接已复制到粘贴板!

54.3.7.8. StorageSecretContainerRelationship复制链接链接已复制到粘贴板!

54.3.7.9. StorageSecretDataFile复制链接链接已复制到粘贴板!

54.3.7.10. StorageSecretDeploymentRelationship复制链接链接已复制到粘贴板!

54.3.7.11. StorageSecretRelationship复制链接链接已复制到粘贴板!

54.3.7.12. StorageSecretType复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

54.3.1. 描述
复制链接

54.3.2. 参数
复制链接

54.3.2.1. 路径参数
复制链接

54.3.3. 返回类型
复制链接

54.3.4. 内容类型
复制链接

54.3.5. 响应
复制链接

54.3.6. Samples
复制链接

54.3.7. 常规对象参考
复制链接

54.3.7.1. ImagePullSecretRegistry
复制链接

54.3.7.2. ProtobufAny
复制链接

54.3.7.2.1. JSON 表示
复制链接

54.3.7.3. RuntimeError
复制链接

54.3.7.4. StorageCert
复制链接

54.3.7.5. StorageCertName
复制链接

54.3.7.6. StorageImagePullSecret
复制链接

54.3.7.7. StorageSecret
复制链接

54.3.7.8. StorageSecretContainerRelationship
复制链接

54.3.7.9. StorageSecretDataFile
复制链接

54.3.7.10. StorageSecretDeploymentRelationship
复制链接

54.3.7.11. StorageSecretRelationship
复制链接

54.3.7.12. StorageSecretType
复制链接