×

GET /v1/declarative-config/health

描述

参数

内容类型

  • application/json

响应

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

200

成功的响应。

V1GetDeclarativeConfigHealthsResponse

0

意外的错误响应。

GooglerpcStatus

示例

公共对象引用

GooglerpcStatus

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

code

整数

int32

message

字符串

details

ProtobufAny列表

ProtobufAny

Any包含任意序列化的protocol buffer消息以及描述序列化消息类型的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库提供的pack方法默认使用'type.googleapis.com/full.type.name'作为类型URL,unpack方法只使用类型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(或空方案)之外的方案可能会与特定于实现的语义一起使用。

StorageDeclarativeConfigHealth

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

id

字符串

name

字符串

status

StorageDeclarativeConfigHealthStatus

UNHEALTHY,HEALTHY,

errorMessage

字符串

resourceName

字符串

resourceType

StorageDeclarativeConfigHealthResourceType

CONFIG_MAP,ACCESS_SCOPE,PERMISSION_SET,ROLE,AUTH_PROVIDER,GROUP,NOTIFIER,

lastTimestamp

日期

设置当前状态的时间戳。

日期时间

StorageDeclarativeConfigHealthResourceType

枚举值

CONFIG_MAP

ACCESS_SCOPE

PERMISSION_SET

ROLE

AUTH_PROVIDER

GROUP

NOTIFIER

StorageDeclarativeConfigHealthStatus

枚举值

UNHEALTHY

HEALTHY

V1GetDeclarativeConfigHealthsResponse

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

healths

StorageDeclarativeConfigHealth 列表