接口功能介绍
分页查询实例列表。
接口约束
无
URI
GET /v2/instance/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNow | 否 | Integer | 当前页,若为空或小于1,默认是1 | 1 | |
pageSize | 否 | Integer | 页大小,若为空或小于1,默认是10 | 10 | |
name | 否 | String | 实例名称,模糊搜索,大小写不敏感 | drds-1 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Array of Objects | 返回对象,列表,若无该字段或该字段为null或者空列表,都代表返回对象为空。 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 内部实例id | ||
name | 是 | String | 实例名称 | drds-1 | |
status | 是 | String | 实例状态, enable: 运行中,disable: 已释放,pause: 暂停服务, expanding:扩容中,notice_opening:开通中 | enable | |
prodInstId | 是 | String | 产品实例id,涉及实例的接口一律使用产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
versionNo | 是 | String | 实例版本 | 2.7.8 | |
instanceType | 是 | String | 实例类型, 基础版、中级版、高级版 | 基础版 | |
instanceSpec | 是 | String | 实例规格 | 8C16G | |
vpcName | 是 | String | vpc名称 | vpc-1eaa | |
subnetName | 是 | String | 子网名称 | subnet-1eaa | |
securityGroupName | 是 | String | 安全组名称 | default | |
expTime | 是 | String | 到期时间 | 2023-09-22 16:01:10 | |
createdTime | 是 | Integer | 创建时间,毫秒时间戳 | 1662886321744 | |
createTime | 是 | String | 创建时间 | 2022-09-11 16:52:01 | |
realName | 否 | String | 用户显示名 | ||
userName | 否 | String | 用户名 | ||
billMode | 否 | String | 计费类型,1 包年/包月,2 按需计费 | 1 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code":0,
"message":"success",
"result":[
{
"id":"/dbproxy_cluster/dbproxy_cluster_0000000121",
"name":"drds-1",
"status":"enabled",
"prodInstId":"cb236d462b924ef7bfba5ecf1d61de2b",
"versionNo":"2.7.8_P1",
"realName":"liux68@chinatelecom.cn",
"userName":"558f4d2288354563a1093a4731bd44d8",
"instanceType":"基础版",
"instanceSpec":"8C16G",
"vpcName":"vpc-1eaa",
"subnetName":"subnet-1eaa",
"securityGroupName":"default",
"expTime":"2023-09-22 16:01:10",
"billMode":"1",
"createdTime":1662886321744,
"createTime":"2022-09-11 16:52:01"
}
]
}
状态码
请参考 状态码说明。