查询网关实例列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageSize |
string |
否 |
每页记录数，取值范围如下：
默认值为 30。 |
30 |
| PageNumber |
string |
否 |
当前页码 |
1 |
| GwClusterId |
string |
否 |
网关实例 ID。 |
pg-xxxxxxxxxx |
| GwDescription |
string |
否 |
网关描述 |
test |
| RegionId |
string |
是 |
地域 ID。 |
cn-beijing |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
CED079B7-A408-41A1-BFF1-EC608E****** |
| PageNumber |
string |
查询页码，默认值为 1。 |
1 |
| PageRecordCount |
string |
当前页面记录数 |
30 |
| PageSize |
string |
每页记录数，取值范围如下：
默认值为 30。 |
30 |
| TotalRecordCount |
string |
总记录数。 |
1 |
| Items |
array<object> |
网关实例列表 |
|
|
object |
网关实例对象 |
||
| VpcId |
string |
专有网络 ID。 |
vpc-**************** |
| VSwitchId |
string |
交换机的 ID。 |
vsw-wz9u0v2yuskt1gth3uuju |
| PayType |
string |
付费类型。取值范围：
|
Postpaid |
| GwClusterId |
string |
网关实例 ID。 |
pg-xxxxxxx |
| GwDescription |
string |
网关描述 |
pg-xxxxxx |
| Status |
string |
应用状态，取值范围
|
ACTIVATION |
| RegionId |
string |
地域 ID。 |
cn-beijing |
| DbType |
string |
数据库类型。 |
polardb_mysql |
| CreateTime |
string |
创建时间。 |
2020-08-14T05:58:42Z |
| ModifyTime |
string |
最后修改时间。 |
2024-10-29T09:31:37Z |
| ExpireTime |
string |
集群到期时间。
|
2028-09-01T16:00:00Z |
| Expired |
boolean |
是否集群已过期。取值范围如下：
|
false |
示例
正常返回示例
JSON格式
{
"RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
"PageNumber": "1",
"PageRecordCount": "30",
"PageSize": "30",
"TotalRecordCount": "1",
"Items": [
{
"VpcId": "vpc-****************",
"VSwitchId": "vsw-wz9u0v2yuskt1gth3uuju",
"PayType": "Postpaid",
"GwClusterId": "pg-xxxxxxx",
"GwDescription": "pg-xxxxxx",
"Status": "ACTIVATION",
"RegionId": "cn-beijing",
"DbType": "polardb_mysql",
"CreateTime": "2020-08-14T05:58:42Z",
"ModifyTime": "2024-10-29T09:31:37Z",
"ExpireTime": "2028-09-01T16:00:00Z",
"Expired": false
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。