功能介绍:查询指定实例信息
GET https://[endpoint].ctapi.ctyun.cn/v1/instanceManageMgrServant/describeInstances
Content-Type:multipart/form-data
URI参数说明:
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
spuInstId | 90436960444 | String | 否 | 实例ID,支持模糊查询 |
spuInstName | String | 否 | 实例名 | |
pageIndex | 1 | Integer | 否 | 页码 |
pageSize | 10 | Integer | 否 | 每页大小 |
返回参数说明:
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
code | core.ok | String | 响应码描述 |
returnObj | Object | 响应对象 | |
returnObj.total | 2 | Integer | 数量 |
returnObj.pageIndex | 1 | Integer | 页码 |
returnObj.totalPage | 1 | Integer | 总页数 |
returnObj.pageSize | 10 | Integer | 每页大小 |
returnObj.rows | Object | 列表对象 | |
message | success | String | 响应信息 |
statusCode | 800 | Integer | 响应状态码 |
rows:
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
uid | 0 | Integer | 暂无描述 |
user | 1100020#9#dcs2-5581zzf | String | 实例标识 |
instanceName | dcs2-5581zzf | String | 实例名称 |
psw | String | 密码 | |
createdate | Date | 创建时间 | |
accessSets | accessSet_1100020_9_dcs2-5581zzf | String | 接入机集群 |
redisSets | redisSet_1100020_9_dcs2-5581zzf | String | redis集群 |
redisSubSet | Object | 暂无描述 | |
redisSubSet.userName | 1100020#9#dcs2-5581zzf | String | 实例标识 |
redisSubSet.name | sub0 | String | |
redisSubSet.accessSetName | accessSet_1100020_9_dcs2-5581zzf | String | 暂无描述 |
redisSubSet.redisSetNames | redisSet_1100020_9_dcs2-5581zzf | String | redis集群名 |
nodes | Object | 暂无描述 | |
title | String | 树形目录的名称 | |
resourceId | 466 | String | 资源ID |
vip | 10.50.208.233 | String | vip |
vipv6 | String | ipv6对应的vip | |
status | 0 | Integer | 有效 1-开通中 2-暂停 |
vipPort | 33100 | Integer | VIP端口 |
sslSwitch | String | ssl开关 | |
sslPort | String | ssl端口 | |
speedControl | String | 流速控制 | |
speedValue | 0 | Integer | 网络流速 |
prodInstId | 904369604443243520 | String | 实例ID |
type | 1 | Integer | 1-集群版 2-主从版 3-单机版 |
capacityInfo | String | 已用内存及配额 | |
payType | 0 | Integer | 付费类型,0-包年/包月,1-按周期 |
payTypeName | String | 付费类型 | |
errorMsg | String | 错误信息 | |
elasticIpBind | String | 是否绑定弹性公网ip | |
elasticIp | String | 弹性公网ip | |
elasticIpId | String | 弹性公网id | |
outerElasticIpId | String | 外部弹性公网id | |
whitelists | 192.168.3.11 | Object | 白名单 |
expiration | 0 | String | 过期时间 |
engineVersion | String | 引擎版本 1-Redis 2.8 | |
archType | Integer | 架构类型 1-集群版 | |
nodeType | Integer | 节点类型1-双副本 | |
securityGroup | String | 安全组 | |
netName | String | 专有网络 | |
subnet | String | 子网 | |
createTime | String | 创建时间 | |
expTime | String | 到期时间 | |
archTypeName | String | 架构类型 1-集群版 | |
nodeTypeName | String | 节点类型名 | |
engineVersionName | String | 引擎版本名 | |
tplName | String | 模板名称 | |
tplCode | String | 模板编码 | |
maintenanceTime | String | 维护时间 | |
openNoneAuth | boolean | 开放鉴权 |
请求示例:
GET https://[endpoint].ctapi.ctyun.cn/v1//instanceManageMgrServant/describeInstances?spuInstName=&spuInstId=&pageIndex=1&pageSize=10
返回示例:
{
"code": "core.ok",
"returnObj": {
"total": 2,
"pageIndex": 1,
"totalPage": 1,
"pageSize": 10,
"rows": [
{
"uid": 0,
"user": "1100020#9#dcs2-5581zzf",
"instanceName": "dcs2-5581zzf",
"psw": null,
"createdate": null,
"accessSets": "accessSet_1100020_9_dcs2-5581zzf",
"redisSets": "redisSet_1100020_9_dcs2-5581zzf",
"redisSubSet": [
{
"userName": "1100020#9#dcs2-5581zzf",
"name": "sub0",
"accessSetName": "accessSet_1100020_9_dcs2-5581zzf",
"redisSetNames": [
"redisSet_1100020_9_dcs2-5581zzf"
]
}
],
"nodes": null,
"title": null,
"resourceId": "466",
"vip": "10.50.208.233",
"vipv6": null,
"status": 0,
"vipPort": 33100,
"sslSwitch": null,
"sslPort": null,
"speedControl": null,
"speedValue": 0,
"prodInstId": "904369604443243520",
"type": 1,
"capacityInfo": null,
"payType": 0,
"payTypeName": null,
"errorMsg": null,
"elasticIpBind": null,
"elasticIp": null,
"elasticIpId": null,
"outerElasticIpId": null,
"whitelists": [
"192.168.3.11",
"192.168.3.12"
],
"expiration": "0",
"engineVersion": null,
"archType": null,
"nodeType": null,
"securityGroup": null,
"netName": null,
"subnet": null,
"createTime": null,
"expTime": null,
"archTypeName": null,
"nodeTypeName": null,
"engineVersionName": null,
"tplName": null,
"tplCode": null,
"maintenanceTime": null,
"openNoneAuth": null
},
{
"uid": 0,
"user": "monitor_hozms_50",
"instanceName": "monitor_hozms_50",
"psw": null,
"createdate": null,
"accessSets": "accessSet_monitor_hozms_50",
"redisSets": "redisSet_monitor_hozms_50",
"redisSubSet": [
{
"userName": "monitor_hozms_50",
"name": "sub0",
"accessSetName": "accessSet_monitor_hozms_50",
"redisSetNames": [
"redisSet_monitor_hozms_50"
]
}
],
"nodes": null,
"title": null,
"resourceId": "",
"vip": null,
"vipv6": null,
"status": 0,
"vipPort": 0,
"sslSwitch": null,
"sslPort": null,
"speedControl": null,
"speedValue": 0,
"prodInstId": null,
"type": 1,
"capacityInfo": null,
"payType": 0,
"payTypeName": null,
"errorMsg": null,
"elasticIpBind": null,
"elasticIp": null,
"elasticIpId": null,
"outerElasticIpId": null,
"whitelists": [],
"expiration": "0",
"engineVersion": null,
"archType": null,
"nodeType": null,
"securityGroup": null,
"netName": null,
"subnet": null,
"createTime": null,
"expTime": null,
"archTypeName": null,
"nodeTypeName": null,
"engineVersionName": null,
"tplName": null,
"tplCode": null,
"maintenanceTime": null,
"openNoneAuth": null
}
]
},
"message": "success",
"statusCode": 800
}