接口功能介绍
获取当前用户开出的所有实例。
URL
接口名称 | 获取实例列表 |
---|---|
承载协议 | HTTPS |
承载网络 | 外网 |
请求方式 | Get |
数据格式 | |
约束 | 无 |
测试环境接口URL | https://influxdb-global.ctapi-test.ctyun.cn/v1/console/openapi/instance/list |
生产环境接口URL | https://influxdb-global.ctapi.ctyun.cn/v1/console/openapi/instance/list |
请求参数
header参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
regionId | 是 | header | String | 当前实例所属资源池 |
query参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
pageNum | 否 | query | String | 当前页 |
pageSize | 否 | query | String | 单页记录条数 |
响应结果
响应Body参数
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
code | Integer | 返回状态码 | |
message | String | 描述 | |
data | Object | 返回对象 | data |
表data
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
total | integer | 查询实例总数 | |
pageRecords | object[] | 当前页实例列表 | pageRecords |
表pageRecords
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
spuInstId | string | 产品实例id | |
prodInstName | string | 实例名称 | |
masterResourceId | String | 资源Id | |
prodBillType | number | 1:包周期计费,2:按需计费 | |
expTime | string | 到期时间 | |
state | number | 0:实施中,1:运行中,2:异常,3:已停止,4:已释放,5:施工失败,6:已停服(包周期停,按需被动停),7:扩容中,8:实施中,9:已取消,10:已停服(按需主动停) | |
storeSize | integer | 存储容量单位MB | |
skuCode | string | 实例规格 | |
engine | string | 引擎类型 | |
engineVersion | string | 引擎版本 | |
gmtCreate | string | 创建时间 | |
prodInstDesc | string | 描述信息 |
请求示例
请求头header
"regionId","39h54mest675e11ea91fc9432qw12867"
请求体Boby
无
请求query
pageSize=1
pageNum=10
响应示例
{
"data": {
"total": 1,
"pageRecords": [
{
"prodInstName": "test-inst",
"spuInstId": "15377b3d15414dbd8efe394e5e981h97",
"masterResourceId": "c8a05fb89b464fec82f314f0c17e32e7",
"engine": "influx",
"engineVersion": "2.0.6",
"state": 4,
"prodBillType": 1,
"storeSize": 51200,
"skuCode": "STL-1",
"gmtCreate": "2022-09-20 14:29:16",
"expTime": "2022-09-27 14:29:38",
"prodInstDesc": null
}]
},
"code": 0,
"message": "success"
}
状态码
状态码 | 描述 |
---|---|
0 | 请求成功 |