查询 HaVip 列表
描述
查询 HA VIP 列表。支持分页,支持多个查询过滤器的组合。
说明:
关于查询过滤器:
过滤器用来增加查询的过滤条件。
查询最多可指定 5 个过滤器。多个过滤器之间的过滤效果为 and 逻辑关系,即:返回结果中只会返回符合所有过滤条件的结果。
当前Filter支持:
VpcId
VSwitchId
Status
HaVipId
HaVipAddress
其中,Status的可选值为Available | Associating | InUse | Unassociating | Deleted
一个过滤器中可以指定多个值,且之间为 or 逻辑关系。例如:
Filter.1.Type=Status,Filter.1.Value.1=InUse,Filter.1.Value.2=Available
此时,结果中会返回 Status 为 InUse 或者 Available 的对象。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 操作接口名,系统规定参数,取值:DescribeHaVips |
RegionId | String | 是 | HaVip 实例所在的地域 |
Filter.n.Key | String | 是 | 第 n 个过滤器的类型。 n 从 1 开始,不超过 5 支持的 Filter 类型有: VpcId | VSwitchId | Status | HaVipId | HaVipAddress |
Filter.n.Value.m | String | 是 | 第 n 个过滤器的第 m 个值。 n、m 从 1 开始,不超过 10 |
PageNumber | Integer | 否 | 实例状态列表的页码,起始值为 1,默认值为 1 |
PageSize | Integer | 否 | 分页查询时设置的每页行数,最大值 100 行,默认为 10 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
HaVips | HaVipSetType | HaVip 详情 HaVipItemType 的集合 |
TotalCount | Integer | 实例总个数 |
PageNumber | Integer | 实例列表的页码 |
PageSize | Integer | 输入时设置的每页行数 |
是公共返回参数,详见公共返回参数
错误码
错误代码 | 描述 | Http 状态码 | 语义 |
---|---|---|---|
InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 404 | 指定的 RegionId 不存在 |
MissingParameter | The input parameter "$ParammeterName" that is mandatory for processing this request is not supplied. | 400 | 缺少某个必选参数 |
RepeatedParameter.$ParammeterName | Specified parameter $ParammeterName is repeated. | 400 | 某个参数重复出现 |
NonsequenceParameter. {xxx.n.yyy.m} | Specified parameter is not a continuous sequence. | 400 | Filter 编号不连续或不从 1 开始;或 Filter 内 Value 的编号不连续或不从 1 开始。 |
InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | 400 | 使用了不存在的 Filter |
时间: 2024-09-27 12:42:32