26.2. BatchUpdate
POST /v1/groupsbatch
26.2.1. 描述 复制链接链接已复制到粘贴板!
26.2.2. 参数 复制链接链接已复制到粘贴板!
26.2.2.1. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 正文(body) | X |
26.2.3. 返回类型 复制链接链接已复制到粘贴板!
对象
26.2.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
26.2.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |
26.2.6. Samples 复制链接链接已复制到粘贴板!
26.2.7. 常规对象参考 复制链接链接已复制到粘贴板!
26.2.7.1. ProtobufAny 复制链接链接已复制到粘贴板!
any 包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 C++ 中解包信息。
示例 2:打包并解压缩 Java 消息。
Example 3: Pack and unpack a message in Python.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
Example 4: Pack and unpack a message in Go
默认情况下,protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中的完全限定类型名称,如 "foo.bar.com/x/x/y.z"。
26.2.7.1.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;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
如果嵌入式消息类型是知名且具有自定义 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"
}
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| typeUrl | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 | |||
| value | byte[] | 必须是上述指定类型的有效序列化协议缓冲。 | BYTE |
26.2.7.2. RuntimeError 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 错误 | 字符串 | ||||
| code | 整数 | int32 | |||
| message | 字符串 | ||||
| 详情 |
26.2.7.3. StorageGroup 复制链接链接已复制到粘贴板!
组是组属性:角色映射.
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| props | |||||
| roleName | 字符串 | 这是应用到此组中用户的角色名称。 |
26.2.7.4. StorageGroupProperties 复制链接链接已复制到粘贴板!
GroupProperties 定义组的属性。当用户属性匹配时,组将应用到用户。例如: - 如果 GroupProperties 只有一个 auth_provider_id,那么该组将应用到使用该 auth 提供者登录的所有用户。- 如果 GroupProperties 则具有 claim 键,那么它将应用到具有该身份验证供应商和声明密钥的所有用户。注意:更改为 GroupProperties 可能需要更改 v1.DeleteGroupRequest。
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | 组属性和组的唯一标识符。 | |||
| 遍历 | |||||
| authProviderId | 字符串 | ||||
| key | 字符串 | ||||
| value | 字符串 |
26.2.7.5. StorageTraits 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
| 可见性 | 可见、隐藏、 | ||||
| origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
26.2.7.6. TraitsMutabilityMode 复制链接链接已复制到粘贴板!
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
| Enum 值 |
|---|
| ALLOW_MUTATE |
| ALLOW_MUTATE_FORCED |
26.2.7.7. TraitsOrigin 复制链接链接已复制到粘贴板!
origin 指定对象的起源。对象可以有四个不同的来源: - IMPERATIVE:对象是通过 API 创建的。默认情况下会假设这个对象。- DEFAULT:对象是默认对象,如默认角色、访问范围等。- DECLARATIVE:对象通过声明性配置创建。- DECLARATIVE_ORPHANED:对象通过声明性配置创建,然后成功删除(例如,它被声明配置引用)创建。- DECLARATIVE_ORPHANED:对象通过声明性配置创建,然后取消删除(例如,它被另一个对象引用),它基于原始对象,应用到对象。不允许使用 DECLARATIVE 原始对象通过 API 修改,只能通过声明性配置进行修改。另外,它们可能无法引用带有 IMPERATIVE 原始卷的对象。不允许使用 DEFAULT origin 的对象通过 API 或声明性配置进行修改。它们可以被所有其他对象引用。允许通过 API 修改具有 IMPERATIVE 来源的对象,而不是通过声明性配置进行修改。它们可能会引用所有其他对象。不允许使用 DECLARATIVE_ORPHANED 原始对象通过 API 或声明性配置进行修改。如果资源在声明配置中重新定义,则 DECLARATIVE_ORPHANED 资源可能会再次变为 DECLARATIVE。使用此源的对象将在不再被其他资源引用后立即从系统中清理。它们可以被所有其他对象引用。
| Enum 值 |
|---|
| IMPERATIVE |
| DEFAULT |
| DECLARATIVE |
| DECLARATIVE_ORPHANED |
26.2.7.8. TraitsVisibility 复制链接链接已复制到粘贴板!
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
| Enum 值 |
|---|
| VISIBLE |
| HIDDEN |
26.2.7.9. V1GroupBatchUpdateRequest 复制链接链接已复制到粘贴板!
GroupBatchUpdateRequest is an in transaction batch update to the groups present. Next Available Tag: 3
GroupBatchUpdateRequest is an in transaction batch update to the groups present. Next Available Tag: 3
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| previousGroups | 以前的组是预期存在于存储中的组。如果 previous_groups 中但不是 required_groups,则对 previous_groups 和 required_groups: 1 中的 GroupProperties 执行 diff,它将被删除。2)如果在 previous_groups 和 required_groups 中,则会更新它。3)如果不在 previous_groups 中,而是在 required_groups 中,则会添加。 | ||||
| requiredGroups | 必需的组是我们希望将前一个组分成的组。 | ||||
| force | 布尔值 |