匹配键与载荷
instance/settings/GENERAL 使用 generalSetting;STORAGE 使用 storageSetting,NOTIFICATION 使用 notificationSetting,AI 使用 aiSetting,ACCESS 使用 accessSetting,MEMO_RELATED 使用 memoRelatedSetting,TAGS 使用 tagsSetting。请求选择一种载荷,而非这里展示的全部属性。UpdateInstanceSetting 替换该载荷并忽略 updateMask。不能从隐藏了凭据的响应中恢复秘密。
此结构在哪里使用
以下链接根据协议快照中的直接引用生成。认证、可写字段和运行行为应以调用操作为准;可复用资源结构本身并不是完整的写入请求。
- GETGet Instance Setting
/api/v1/instance/settings/{key} - PATCHUpdate Instance Setting
/api/v1/instance/settings/{key}
被以下组件结构引用:
结构与字段
object
An instance setting resource.
| 字段 | 类型 / 是否必需 | 描述 |
|---|---|---|
name | string | The name of the instance setting. Format: instance/settings/{setting} |
generalSetting | InstanceSetting_GeneralSetting | |
storageSetting | InstanceSetting_StorageSetting | |
memoRelatedSetting | InstanceSetting_MemoRelatedSetting | |
tagsSetting | InstanceSetting_TagsSetting | |
notificationSetting | InstanceSetting_NotificationSetting | |
aiSetting | InstanceSetting_AISetting | |
accessSetting | InstanceSetting_AccessSetting |
完整结构
约束与嵌套结构请以这份完整 JSON 定义为准。字段出现在这里,并不意味着每位调用者都能修改它。
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the instance setting.\n Format: instance/settings/{setting}"
},
"generalSetting": {
"$ref": "#/components/schemas/InstanceSetting_GeneralSetting"
},
"storageSetting": {
"$ref": "#/components/schemas/InstanceSetting_StorageSetting"
},
"memoRelatedSetting": {
"$ref": "#/components/schemas/InstanceSetting_MemoRelatedSetting"
},
"tagsSetting": {
"$ref": "#/components/schemas/InstanceSetting_TagsSetting"
},
"notificationSetting": {
"$ref": "#/components/schemas/InstanceSetting_NotificationSetting"
},
"aiSetting": {
"$ref": "#/components/schemas/InstanceSetting_AISetting"
},
"accessSetting": {
"$ref": "#/components/schemas/InstanceSetting_AccessSetting"
}
},
"description": "An instance setting resource."
}