查看DBS备份网关列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeBackupGatewayList |
系统规定参数,取值:DescribeBackupGatewayList。 |
Region | String | 是 | cn-hangzhou |
DBS地域,取值:
|
Identifier | String | 否 | 7213527653217 |
备份网关唯一标识,支持多个查询,逗号分隔。 |
PageSize | Integer | 否 | 30 |
每页的记录数,取值:
说明 默认为30。
|
PageNum | Integer | 否 | 1 |
页码,大于等于0且不超过Integer的最大值,默认值为:0。 |
RegionId | String | 否 | cn-hangzhou |
地域ID,您可以调用DescribeRegions查询。 |
ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxxxx |
用于保证请求的幂等性,防止重复提交请求。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrCode | String | Param.NotFound |
错误码。 |
ErrMessage | String | The specified parameter %s value is not valid. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
Items | Array of BackupGateway |
备份网关详情。 |
|
BackupGateway | |||
BackupGatewayCreateTime | Long | 1554560477000 |
备份网关创建时间,取值1554560477000。 |
BackupGatewayId | String | 2321313123 |
备份网关ID。 |
BackupGatewayStatus | String | ONLINE |
备份网关状态,取值:
|
DisplayName | String | test |
备份网关显示名称。 |
Identifier | String | sgdsajhdgu |
备份网关唯一标识。 |
LastHeartbeatTime | Long | 1554560477000 |
上次心跳汇报时间,取值:1554560477000。 |
Region | String | cn-hangzhou |
地域。 |
SourceEndpointHostname | String | test |
安装备份网关的主机名称。 |
SourceEndpointInternetIP | String | XX.XX.XX.XX |
安装备份网关的主机公网IP。 |
SourceEndpointIntranetIP | String | XX.XX.XX.XX |
安装备份网关的主机私网IP。 |
PageNum | Integer | 1 |
页码。 |
PageSize | Integer | 30 |
每页的记录数。 |
RequestId | String | 46361705-8531-492F-807E-A97E482DD4A1 |
请求ID。 |
Success | Boolean | true |
是否成功。 |
TotalElements | Integer | 0 |
总备份网关数。 |
TotalPages | Integer | 1 |
总页数。 |
示例
请求示例
http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DescribeBackupGatewayList
&Region=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<PageSize>30</PageSize>
<RequestId>46361705-8531-492F-807E-A97E482DD4A1</RequestId>
<PageNum>0</PageNum>
<HttpStatusCode>200</HttpStatusCode>
<TotalElements>0</TotalElements>
<Items/>
<TotalPages>0</TotalPages>
<Success>true</Success>
JSON
格式
{
"PageSize": 30,
"RequestId": "46361705-8531-492F-807E-A97E482DD4A1",
"PageNum": 0,
"HttpStatusCode": 200,
"TotalElements": 0,
"Items": "",
"TotalPages": 0,
"Success": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交