该接口用于查看DBS备份网关列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dbs:DescribeBackupGatewayList |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Region |
string |
是 |
DBS 地域,取值:
|
cn-hangzhou |
| Identifier |
string |
否 |
备份网关唯一标识,支持多个查询,用英文逗号(,)分隔。 |
7213527653217 |
| PageSize |
integer |
否 |
每页的记录数,取值:
说明
默认为 30。 |
30 |
| PageNum |
integer |
否 |
页码,大于等于 0 且不超过 Integer 的最大值,默认值为:0。 |
1 |
| ClientToken |
string |
否 |
用于保证请求的幂等性,防止重复提交请求。 |
ETnLKlblzczshOTUbOCzxxxxxxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| PageNum |
integer |
页码。 |
1 |
| RequestId |
string |
请求 ID。 |
46361705-8531-492F-807E-A97E482DD4A1 |
| ErrCode |
string |
错误码。 |
Param.NotFound |
| Success |
boolean |
是否成功。 |
true |
| ErrMessage |
string |
错误信息。 |
The specified parameter %s value is not valid. |
| TotalPages |
integer |
总页数。 |
1 |
| TotalElements |
integer |
总备份网关数。 |
0 |
| PageSize |
integer |
每页的记录数。 |
30 |
| Items |
object |
||
| BackupGateway |
array<object> |
备份网关详情。 |
|
|
object |
|||
| DisplayName |
string |
备份网关显示名称。 |
test |
| BackupGatewayCreateTime |
integer |
备份网关创建时间,取值 1554560477000。 |
1554560477000 |
| BackupGatewayId |
string |
备份网关 ID。 |
2321313123 |
| Region |
string |
地域。 |
cn-hangzhou |
| Identifier |
string |
备份网关唯一标识。 |
sgdsajhdgu |
| SourceEndpointInternetIP |
string |
安装备份网关的主机公网 IP。 |
XX.XX.XX.XX |
| BackupGatewayStatus |
string |
备份网关状态,取值:
|
ONLINE |
| SourceEndpointIntranetIP |
string |
安装备份网关的主机私网 IP。 |
XX.XX.XX.XX |
| LastHeartbeatTime |
integer |
上次心跳汇报时间,取值:1554560477000。 |
1554560477000 |
| SourceEndpointHostname |
string |
安装备份网关的主机名称。 |
test |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"PageNum": 1,
"RequestId": "46361705-8531-492F-807E-A97E482DD4A1",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"TotalPages": 1,
"TotalElements": 0,
"PageSize": 30,
"Items": {
"BackupGateway": [
{
"DisplayName": "test",
"BackupGatewayCreateTime": 1554560477000,
"BackupGatewayId": "2321313123",
"Region": "cn-hangzhou",
"Identifier": "sgdsajhdgu",
"SourceEndpointInternetIP": "XX.XX.XX.XX",
"BackupGatewayStatus": "ONLINE",
"SourceEndpointIntranetIP": "XX.XX.XX.XX",
"LastHeartbeatTime": 1554560477000,
"SourceEndpointHostname": "test"
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions | 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。