×

GET /v1/secrets/{id}

GetSecret 根据其 ID 返回密钥。

描述

参数

路径参数

名称 描述 必填 默认值 模式

id

返回类型

内容类型

  • application/json

响应

表 1. HTTP 响应代码
代码 消息 数据类型

200

成功的响应。

StorageSecret

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

字段名称 必填 可空 类型 描述 格式

code

整数

int32

message

字符串

details

ProtobufAny 列表

ImagePullSecretRegistry

字段名称 必填 可空 类型 描述 格式

name

字符串

username

字符串

ProtobufAny

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

Protobuf 库提供实用函数或 Any 类型的附加生成方法来支持打包/解包 Any 值。

示例 1:在 C++ 中打包和解包消息。

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

示例 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());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

Protobuf 库提供的打包方法默认使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中最后一个 '/' 后面的完全限定类型名称,例如 "foo.bar.com/x/y.z" 将产生类型名称 "y.z"。

JSON 表示

Any 值的 JSON 表示使用反序列化的嵌入式消息的常规表示,并添加一个包含类型 URL 的附加字段 @type。示例

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

如果嵌入式消息类型是众所周知的并且具有自定义 JSON 表示,则该表示将被嵌入,并添加一个字段 value,该字段除了 @type 字段外还包含自定义 JSON。示例(对于消息 [google.protobuf.Duration][])

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
字段名称 必填 可空 类型 描述 格式

@type

字符串

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

StorageCert

字段名称 必填 可空 类型 描述 格式

主题

StorageCertName

颁发者

StorageCertName

替代名称 (SANs)

string 列表

起始日期

日期

日期时间

结束日期

日期

日期时间

算法

字符串

StorageCertName

字段名称 必填 可空 类型 描述 格式

公用名称

字符串

国家

字符串

组织

字符串

组织单位

字符串

地区

字符串

省份

字符串

街道地址

字符串

邮政编码

字符串

名称

string 列表

StorageImagePullSecret

字段名称 必填 可空 类型 描述 格式

注册表

ImagePullSecretRegistry 列表

StorageSecret

Flat secret object. Any properties of an individual secret. (regardless of time, scope, or context) ////////////////////////////////////////
字段名称 必填 可空 类型 描述 格式

id

字符串

name

字符串

集群 ID

字符串

集群名称

字符串

命名空间

字符串

类型

字符串

标签

string 映射

注释

string 映射

创建时间

日期

日期时间

文件

StorageSecretDataFile 列表

关于密钥的元数据。密钥不必是文件,而可以是任意值。

关系

StorageSecretRelationship

StorageSecretContainerRelationship

Secrets can be mounted in a path in a container. Next Tag: 3
字段名称 必填 可空 类型 描述 格式

id

字符串

挂载密钥的容器的 ID。

路径

字符串

路径是容器特定的挂载目录。

StorageSecretDataFile

关于密钥的元数据。对于证书文件和 imagePullSecret 提供了其他信息,但“文件”也可能表示某些任意值。

字段名称 必填 可空 类型 描述 格式

name

字符串

类型

StorageSecretType

未确定,公共证书,证书请求,隐私增强消息,OpenSSH 私钥,PGP 私钥,EC 私钥,RSA 私钥,DSA 私钥,CERT 私钥,加密私钥,镜像拉取密钥,

证书

StorageCert

镜像拉取密钥

StorageImagePullSecret

StorageSecretDeploymentRelationship

Secrets can be used by a deployment. Next Tag: 3
字段名称 必填 可空 类型 描述 格式

id

字符串

在容器内使用密钥的部署的 ID。

name

字符串

部署的名称。

StorageSecretRelationship

The combined relationships that belong to the secret. Next Tag: 6
字段名称 必填 可空 类型 描述 格式

id

字符串

容器关系

StorageSecretContainerRelationship 列表

部署关系

StorageSecretDeploymentRelationship 列表

部署 ID 到关系。

StorageSecretType

枚举值

未确定

公共证书

证书请求

隐私增强消息

OpenSSH 私钥

PGP 私钥

EC 私钥

RSA 私钥

DSA 私钥

CERT 私钥

加密私钥

镜像拉取密钥