Update Instance Setting

PATCH /api/v1/instance/settings/{key}

InstanceService · InstanceService_UpdateInstanceSetting

基于协议生成的参考。授权与实例策略仍然生效。结构描述继承自 MIT 许可的应用接口定义；本站不会向真实服务执行示例。

修改数据前

完整设置替换：此 Rust 接口忽略 updateMask。应先读取当前设置、保留所需字段，再发送该设置键期望的完整载荷。小范围 PATCH 请求体可能重置被省略的非秘密字段。部署管理的设置拒绝写入，隐藏凭据的读取响应也不是提供方秘密的备份。

访问权限

需要实例管理员；普通已认证账号不能执行此操作。

实际可调用的设置路由

协议 HTTP 注解实际绑定 /api/v1/instance/settings/{KEY}，例如 /api/v1/instance/settings/GENERAL。下方 /api/v1/instance/{instance}/* 是生成的 OpenAPI 表达，不应按字面发送带星号的 URL。更新时 JSON 请求体为 InstanceSetting 对象，载荷必须匹配设置键，资源 name 由 URL 提供。

完整载荷替换

Rust 实现忽略 updateMask，并替换所选设置的完整载荷。因此，小请求体可能把省略的非秘密字段恢复默认值。应先读取当前设置、保留所需字段、应用目标修改，再发送该键的完整载荷。键与载荷必须匹配。部署管理的设置拒绝 API 写入。凭据保留规则随设置而异，隐藏秘密的读取响应不是秘密备份。

请求

Updates an instance setting.

PATCH/api/v1/instance/settings/{key}

生成的 OpenAPI 将此路径表达为 /api/v1/instance/{instance}/*. 实际调用请使用上方 Rust 路由；下载的接口定义保留原始内容。

协议声明的参数

下表中名为 instance 的生成路径参数属于协议元数据。实际调用上方路由时，应将 {key} 替换为 GENERAL 这样的设置键，不要发送字面星号。

名称 / 位置	类型 / 是否必需	描述
`instance` path	string 必需	The instance id.
`updateMask` query	string (field-mask) OpenAPI 未标记为必需	The list of fields to update.

请求体

必需

application/json · InstanceSetting

响应

200 · OK

application/json · InstanceSetting

default · Default error response

application/json · Status

完整操作定义

下方保留全部已声明约束、媒体类型和响应细节。结构引用链接到完整定义。

展开 JSON 定义

{
  "tags": [
    "InstanceService"
  ],
  "description": "Updates an instance setting.",
  "operationId": "InstanceService_UpdateInstanceSetting",
  "parameters": [
    {
      "name": "instance",
      "in": "path",
      "description": "The instance id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "updateMask",
      "in": "query",
      "description": "The list of fields to update.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/InstanceSetting"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/InstanceSetting"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}