查询远端备份服务器列表 - ListBackupHostsInfo
功能介绍
查询远端备份服务器列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/wtp/backup-hosts
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
is_run |
否 |
Boolean |
参数解释: 是否仅显示Agent在线的远端备份服务器 约束限制: 不涉及 取值范围:
默认取值: false |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_list |
Array of WtpBackupHostResponseInfo objects |
参数解释: 远端备份服务器列表 取值范围: 最小值0，最大值200 |
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0，最大值2147483647 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
backup_host_ip |
String |
参数解释: 备份服务器IP 取值范围: 字符长度0-256位 |
|
backup_host_port |
Integer |
参数解释: 备份服务器端口 取值范围: 最小值0，最大值65535 |
|
backup_dir |
String |
参数解释: 备份路径 取值范围: 字符长度0-256位 |
|
backup_host_status |
Integer |
参数解释: 备份状态 取值范围:
|
|
backup_host_name |
String |
参数解释: 远端备份服务器的服务器名称 取值范围: 字符长度0-256位 |
|
backup_host_id |
String |
参数解释: 远端备份服务器的服务器ID 取值范围: 字符长度0-256位 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"backup_host_ip" : "192.168.1.1",
"backup_host_port" : 8080,
"backup_dir" : "/back",
"backup_host_status" : 1,
"backup_host_name" : "backup_host_name",
"backup_host_id" : "96ae7317-b5c4-4bc8-aa90-eda53f23e99e"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
