Query Information of Multiple Archive Servers

Query the detailed information of multiple archive servers at the same time.

Request URL

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

Request parameters

Parameter Required Type Description
ids Yes String The unique ID(s) of archive servers.
Note:

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
data Array<Archive_Server_Info> The archive server information.
Archive_Server_Info
Parameter Type Description
id Integer The unique ID of the archive server.
name String The name of the archive server.
server_type String The type of the archive server.
  • ftp: FTP server.
  • sftp: SFTP server.
  • amazon_s3: S3-compatible object storage.
  • google_storage: Google Cloud Storage.
  • sharepoint: Microsoft SharePoint site.
protoc String The protocol used by the FTP server.
Note: This parameter is returned with a value only when server_type is ftp.
host String The server address.
Note: This parameter is returned with a value only when server_type is ftp or sftp.
port Integer The server port.
Note: This parameter is returned with a value only when server_type is ftp or sftp.
endpoint String The endpoint of the S3-compatible storage.
Note: This parameter is returned with a value only when server_type is amazon_s3.
region String The region of the S3-compatible storage.
Note: This parameter is returned with a value only when server_type is amazon_s3.
method Integer The authentication method used by the SFTP server.
  • 0: Undefined.
  • 1: Password.
  • 2: SSH private key.
Note: This field is returned with a value only when server_type is sftp.
username String The username for the FTP or SFTP account.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.
password String The password for the FTP or SFTP account.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.
ssh_private_key String The filename of the SSH private key used for SFTP authentication.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.
access_key_id String The access key ID for the S3-compatible storage account.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.
secret_access_key String The secret access key for the S3-compatible storage account.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.
tenant_id String The Microsoft Entra tenant ID.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.
client_id String The application (client) ID registered in Microsoft Entra ID.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.
client_secret String The client secret for the application registered in Microsoft Entra ID.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.
private_key String The filename of the private key used for Google Cloud Storage authentication.
Note: The parameter always returns an empty string. To retrieve the stored value, use the Query an Archive Server Credential interface.

Example

Request example

GET /openapi/v1.0/archive_server/query?ids=7,8,9&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1
Host: 192.168.5.150:8088

Response example

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": 8,
      "name": "Amazon-S3-Server",
      "server_type": "amazon_s3",
      "protoc": "",
      "private_key": "",
      "access_key_id": "",
      "secret_access_key": "",
      "host": "",
      "port": 0,
      "username": "",
      "password": "",
      "ssh_private_key": "",
      "method": 0,
      "endpoint": "https://s3.us-east-1.amazonaws.com",
      "region": "us-east-1",
      "tenant_id": "",
      "client_id": "",
      "client_secret": ""
    }
  ]
}