文档API 参考

Rust · 0.1.0

InstanceSetting_StorageSetting

应用协议结构。字段名称及继承的描述保留原始语言。

此结构在哪里使用

以下链接根据协议快照中的直接引用生成。认证、可写字段和运行行为应以调用操作为准;可复用资源结构本身并不是完整的写入请求。

被以下组件结构引用:

结构与字段

object

Storage configuration settings for instance attachments.

字段类型 / 是否必需描述
storageTypestring (enum)
STORAGE_TYPE_UNSPECIFIED · DATABASE · LOCAL · S3
Legacy compatibility field. New clients use default_storage_id.
filepathTemplatestringThe template of file path. e.g. assets/{timestamp}_{filename}
uploadSizeLimitMbstringThe max upload size in megabytes.
s3ConfigallOf
StorageSetting_S3Config
Legacy compatibility field. New clients use storages.
storagesarray<InstanceSetting_Storage>Configured storage instances, including inactive instances referenced by attachments.
defaultStorageIdstringStorage used for new attachments.

完整结构

约束与嵌套结构请以这份完整 JSON 定义为准。字段出现在这里,并不意味着每位调用者都能修改它。

{
  "type": "object",
  "properties": {
    "storageType": {
      "enum": [
        "STORAGE_TYPE_UNSPECIFIED",
        "DATABASE",
        "LOCAL",
        "S3"
      ],
      "type": "string",
      "description": "Legacy compatibility field. New clients use default_storage_id.",
      "format": "enum"
    },
    "filepathTemplate": {
      "type": "string",
      "description": "The template of file path.\n e.g. assets/{timestamp}_{filename}"
    },
    "uploadSizeLimitMb": {
      "type": "string",
      "description": "The max upload size in megabytes."
    },
    "s3Config": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StorageSetting_S3Config"
        }
      ],
      "description": "Legacy compatibility field. New clients use storages."
    },
    "storages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InstanceSetting_Storage"
      },
      "description": "Configured storage instances, including inactive instances referenced by attachments."
    },
    "defaultStorageId": {
      "type": "string",
      "description": "Storage used for new attachments."
    }
  },
  "description": "Storage configuration settings for instance attachments."
}