跳转到正文
皓量云擎文档
接口参考平台设置与数据备份

上传配置列表

GET /api/admin/v1/upload-targets,listUploadTargets 的请求参数和响应结构。

GET /api/admin/v1/upload-targets

项目内容
操作标识listUploadTargets
认证登录会话 Cookie

平台数据管理:要求 system.manage;包含全部租户数据,普通租户不可访问。写操作要求 Origin 和 CSRF。恢复采用离线流程,不覆盖运行中的业务库。

响应

HTTP 状态含义
200成功
400错误
401错误
403错误
404错误
409错误
502错误
503错误
200 · application/json 响应结构
字段类型必填说明与约束
dataUploadTarget[]是—
request_idstring是—
{
  "$ref": "#/$defs/UploadTargetListResponse",
  "$defs": {
    "UploadTargetListResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/UploadTarget"
          }
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "data",
        "request_id"
      ]
    },
    "UploadTarget": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "provider": {
          "type": "string",
          "enum": [
            "s3",
            "aliyun",
            "tencent",
            "qiniu",
            "ftp"
          ]
        },
        "settings": {
          "$ref": "#/$defs/UploadTargetSettings"
        },
        "enabled": {
          "type": "boolean"
        },
        "has_secret": {
          "type": "boolean"
        },
        "references": {
          "type": "integer"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "id",
        "name",
        "provider",
        "settings",
        "enabled",
        "has_secret",
        "references",
        "created_at",
        "updated_at"
      ]
    },
    "UploadTargetSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "endpoint": {
          "type": "string"
        },
        "bucket": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        },
        "access_key_id": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "path_style": {
          "type": "boolean"
        },
        "tls": {
          "type": "boolean"
        }
      },
      "required": [
        "endpoint",
        "bucket",
        "region",
        "prefix",
        "access_key_id",
        "username",
        "path_style",
        "tls"
      ]
    }
  }
}
400 / 401 / 403 / 404 / 409 / 502 / 503 · application/json 响应结构
{
  "$ref": "#/$defs/ErrorResponse",
  "$defs": {
    "ErrorResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "error": {
          "$ref": "#/$defs/ErrorDetail"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "error",
        "request_id"
      ]
    },
    "ErrorDetail": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "NOT_IMPLEMENTED",
            "NOT_FOUND",
            "AUTH_REQUIRED",
            "FORBIDDEN",
            "VALIDATION_FAILED",
            "CONFLICT",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR",
            "RATE_LIMITED"
          ]
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "code",
        "message",
        "retryable"
      ]
    }
  }
}

响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。

本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。

本页目录