查询归档服务器列表

获取归档服务器列表。

请求 URL

GET {base_url}/{api_path}/archive_server/list?access_token={access_token}

请求参数

无请求参数。直接发送请求 URL 查询归档服务器列表。

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
data	Array<Archive_Server_Info>	归档服务器列表。

Archive_Server_Info


参数	类型	说明
id	Integer	归档服务器的唯一 ID。
name	String	归档服务器的名称。
server_type	String	归档服务器的类型。 `ftp`：FTP 服务器。 `sftp`：SFTP 服务器。 `amazon_s3`：S3 兼容对象存储。 `google_storage`：Google Cloud Storage。 `sharepoint`：Microsoft SharePoint。
protoc	String	FTP 服务器使用的协议。注：仅当 `server_type` 为 `ftp` 时，此字段才有值。
host	String	服务器地址。注：仅当 `server_type` 为 `ftp` 或 `sftp` 时，此字段才有值。
port	Integer	服务器端口。注：仅当 `server_type` 为 `ftp` 或 `sftp` 时，此字段才有值。
endpoint	String	S3 兼容存储的 endpoint。注：仅当 `server_type` 为 `amazon_s3` 时，此字段才有值。
region	String	S3 兼容存储所在的区域。注：仅当 `server_type` 为 `amazon_s3` 时，此字段才有值。
method	Integer	SFTP 服务器使用的身份验证方式。 `0`：未定义。 `1`：密码。 `2`：SSH 私钥。注：仅当 `server_type` 为 `sftp` 时，此字段才有值。
username	String	FTP 或 SFTP 账户的用户名。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。
password	String	FTP 或 SFTP 账户的密码。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。
ssh_private_key	String	用于 SFTP 身份验证的 SSH 私钥文件名。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。
access_key_id	String	S3 兼容存储账户的 Access Key ID。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。
secret_access_key	String	S3 兼容存储账户的 Secret Access Key。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。
tenant_id	String	Microsoft Entra 租户 ID。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。
client_id	String	在 Microsoft Entra ID 中注册的应用 (客户端) ID。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。
client_secret	String	在 Microsoft Entra ID 中注册的应用的客户端密钥。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。
private_key	String	用于 Google Cloud Storage 身份验证的私钥文件名。注：该参数始终返回空字符串。如需获取存储的值，请使用查询归档服务器的凭证接口。

示例

请求示例

GET /openapi/v1.0/archive_server/list?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "data": [
    {
      "id": 7,
      "name": "SharePoint-Server",
      "server_type": "sharepoint",
      "protoc": "",
      "private_key": "",
      "access_key_id": "",
      "secret_access_key": "",
      "host": "",
      "port": 0,
      "username": "",
      "password": "",
      "ssh_private_key": "",
      "method": 0,
      "endpoint": "",
      "region": "",
      "tenant_id": "",
      "client_id": "",
      "client_secret": ""
    },
    {
      "id": 9,
      "name": "FTP",
      "server_type": "ftp",
      "protoc": "ftp",
      "private_key": "",
      "access_key_id": "",
      "secret_access_key": "",
      "host": "121.41.122.51",
      "port": 21,
      "username": "",
      "password": "",
      "ssh_private_key": "",
      "method": 0,
      "endpoint": "",
      "region": "",
      "tenant_id": "",
      "client_id": "",
      "client_secret": ""
    }
  ]
}