查询远端备份服务器信息 - ShowRemoteBackupHostInfo
功能介绍
查询远端备份服务器信息:查询远端备份服务器的相关信息,包含服务器名称、地址、端口号、备份路径、运行状态信息
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/wtp/{host_id}/backup-host
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
host_id |
是 |
String |
服务器id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
backup_addr |
String |
远端备份服务器的地址,包含IP和端口 |
|
backup_host_id |
String |
远端备份服务器的服务器ID |
|
backup_host_name |
String |
远端备份服务器的服务器名称 |
|
remote_backup |
Boolean |
参数解释 服务器是否开启远端备份 取值范围
|
请求示例
无
响应示例
状态码:200
请求已成功
{
"remote_backup" : true,
"backup_host_name" : "test",
"backup_host_id" : "96ae7317-b5c4-4bc8-aa90-eda53f23e99e",
"backup_addr" : "192.168.1.2:8080"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。