Query an Archive Server Credential

Retrieve the stored value of a credential field for an archive server.

Request URL

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

Request parameters

Parameter Required Type Description
auth_info_id Yes Integer The ID of the archive server.
Note: You can obtain the ID using the Query Archive Server List interface.
type Yes String The credential field to retrieve.

Valid value:

  • password: The password for the FTP or SFTP account.
  • username: The username for the FTP or SFTP account.
  • access_key_id: The access key ID for the S3-compatible storage account.
  • secret_access_key: The secret access key for the S3-compatible storage account.
  • tenant_id: The Microsoft Entra tenant ID.
  • client_id: The application (client) ID registered in Microsoft Entra ID.
  • client_secret: The client secret for the application registered in Microsoft Entra ID.

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.
password String The stored value of the requested credential field, encoded in Base64.

Example

Request example

GET /openapi/v1.0/archive_server/viewpassword?auth_info_id=9&type=username&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "password": "cGFzc3dvcmQ="
}