接口功能介绍
获取当前用户下指定实例的详情信息。
接口定义
接口名称 | 获取实例详情 |
---|---|
承载协议 | HTTPS |
承载网络 | 外网 |
请求方式 | Get |
数据格式 | |
约束 | 无 |
测试环境接口URL | https://influxdb-global.ctapi-test.ctyun.cn/v1/console/openapi/instance/detail |
生产环境接口URL | https://influxdb-global.ctapi.ctyun.cn/v1/console/openapi/instance/detail |
请求参数
header参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
regionId | 是 | header | String | 当前实例所属资源池 |
query参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
spuInstId | 否 | query | String | 实例id |
响应结果
响应Body参数
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
code | Integer | 返回状态码 | |
message | String | 描述 | |
data | Object | 返回对象 | data |
表data
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
spuInstId | string | 产品实例id | |
prodInstName | string | 实例名称 | |
prodBillType | integer | 1:包周期计费,2:按需计费 | |
vpcName | String | vpc标识 | |
skuCode | string | 实例规格 | |
expTime | string | 到期时间 | |
state | integer | 0:实施中,1:运行中,2:异常,3:已停止,4:已释放,5:施工失败,6:已停服(包周期停,按需被动停),7:扩容中,8:实施中,9:已取消,10:已停服(按需主动停) | |
subnet | string | 子网 | |
securityGroup | string | 安全组 | |
maxWritePoint | integer | 最多写入点数 | |
currentWriteSpeed | integer | 当前写入速度 | |
storeSize | integer | 存储容量单位MB | |
usedStoreSize | integer | 已使用存储容量单位MB | |
engine | string | 引擎类型 | |
engineVersion | string | 引擎版本 | |
linkIp | string | 默认连接ip | |
linkIpv6 | string | 连接ip ipv6 | |
elasticIp | string | 弹性ip | |
prodInstDesc | string | 产品实例描述 | |
gmtCreate | string | 创建时间 |
请求示例
请求头header
"regionId","39h54mest675e11ea91fc9432qw12867"
请求query
spuInstId=15377b3d15414dbd8efe394e5e981h97
请求体Boby
无
响应示例
{
"data": {
"prodInstName": "test-inst",
"spuInstId": "15377b3d15414dbd8efe394e5e981h97",
"vpcName": "test-vpc",
"linkIp": "1.1.1.1",
"linkIpv6": null,
"subnet": "test-net",
"securityGroup": "test-security-group",
"elasticIp": null,
"prodInstDesc": null,
"state": 4,
"prodBillType": 1,
"skuCode": "ST-L1",
"gmtCreate": "2022-09-20 14:29:16",
"expTime": "2022-09-27 14:29:38",
"storeSize": 0,
"engine": "influx",
"engineVersion": "2.0.6",
"maxWritePoint": 0,
"currentWriteSpeed": null,
"usedStoreSize": null
},
"code": 0,
"message": "success"
}
状态码
状态码 | 描述 |
---|---|
0 | 请求成功 |