查询归档服务器的凭证

获取归档服务器指定凭证字段存储的值。

请求 URL

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

请求参数

参数 是否必填 类型 说明
auth_info_id 是 Integer 归档服务器的 ID。
注： 可通过 查询归档服务器列表 接口获取该 ID。
type 是 String 要获取的凭证字段。

取值范围：

  • password：FTP 或 SFTP 账户的密码。
  • username：FTP 或 SFTP 账户的用户名。
  • access_key_id：S3 兼容存储账户的 Access Key ID。
  • secret_access_key：S3 兼容存储账户的 Secret Access Key。
  • tenant_id：Microsoft Entra 租户 ID。
  • client_id：在 Microsoft Entra ID 中注册的应用 (客户端) ID。
  • client_secret：在 Microsoft Entra ID 中注册的应用的客户端密钥。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
password String 指定凭证字段存储的值，采用 Base64 编码。

示例

请求示例

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

Host: yeastardocs.example.yeastarcloud.com

响应示例

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