实例管理
1.分页查询实例列表
接口功能介绍
无
接口约束
无
URI
GET /cgw/v1/instance/list
Accept: application/json
路径参数
Query参数
名称 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNum | 否 | Integer | 页码,默认为1 | ||
pageSize | 否 | Integer | 每页记录数,默认为10 | ||
spuInstId | 否 | String | 实例ID | 7a2828074ef6e32e041a2ef124b19e63 | |
spuInstName | 否 | String | 实例名称 | ||
bizState | 否 | String | 实例状态 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124876543 |
请求体body参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Object | 返回数据 | PageInfo«SpuInstVO» | |
message | String | 异常描述 | success |
表 PageInfo«SpuInstVO»
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
endRow | Long | |||
hasNextPage | Boolean | |||
hasPreviousPage | Boolean | |||
isFirstPage | Boolean | |||
isLastPage | Boolean | |||
list | Array of Objects | SpuInstVO | ||
navigateFirstPage | Integer | |||
navigateLastPage | Integer | |||
navigatePages | Integer | |||
navigatepageNums | Array of Integer | |||
nextPage | Integer | 下一页 | 2 | |
pageNum | Integer | 页码 | 1 | |
pageSize | Integer | 每页条目数 | 10 | |
pages | Integer | 页数 | 2 | |
prePage | Integer | 前一页 | 1 | |
size | Integer | 总数 | 12 | |
startRow | Long |
表 SpuInstVO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
appCode | String | 实例产品编码 | msegw | |
billMode | String | 计费模式:1 包周期;2 按需;9 云桌面资源包抵扣;10 私有云 | 1 | |
billModeMean | String | 计费模式中文含义:1 包周期;2 按需;9 资源包抵扣;10 私有云(项目制) | 包周期 | |
bizState | String | 实例业务状态状态 | 1 | |
bizVip | String | 1 | ||
bizVipBindVmTypes | String | 1 | ||
createdBy | Long | 由谁创建 | 43657 | |
createdTime | String | 实例创建时间 | 2023-10-10 12:12:12 | |
expTime | String | 实例到期时间 | 2024-10-10 12:12:12 | |
isDelete | Boolean | |||
instNodeNum | String | 节点数量 | 1 | |
instanceStatus | String | 实例运行状态,normal:正常;abnormal:异常 | normal | |
labels | Array of Objects | 资源标签 | IamLabelItem | |
modifiedTime | String | 实例修改时间 | 2023-12-10 12:12:12 | |
prodInstName | String | 实例名称 | msegw-test | |
prodSrc | String | 工单来源 | 4 | |
regionCode | String | 资源池Code标识 | d8bbd132b53a11e9b0e40242ac110002 | |
regionId | Long | 资源池ID标识 | 2345 | |
regionName | String | 资源池名称 | beijing4 | |
seriesCode | String | 系列编码 | msegw.base | |
skuCode | String | 单品规格编码 | msegw.base.s1 | |
skuId | String | 单品规格ID标识 | 107201 | |
skuName | String | 产品规格名称,如基础版、高可用版 | 基础版 | |
spuCode | String | 产品规格编码 | MSEGW | |
spuId | String | 产品规格ID标识 | 107201 | |
spuInstId | String | 实例ID标识 | 7a2828074ef6e32e041a2ef124b19e63 | |
spuName | String | 产品名称 | 云原生网关 | |
tenantCode | String | 租户Code标识 | Ctyun714be2e13c1741191672809015 | |
tenantId | Long | 租户ID标识 | 1 | |
tenantName | String | 租户名称 | name | |
userId | Long | 用户ID | 43657 | |
versionNo | String | 版本号 | 1.2.1 | |
vip | String | VIP | 198.20.7.44 | |
vipV6 | String | |||
virtualRouterId | String | 1 | ||
vpcInfo | Object | VPC信息 | VpcInfo |
表 VpcInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
vpcCidr | String | VPC cidr | ||
vpcId | String | VPC ID | 1 | |
vpcName | String | VPC名称 | vpc | |
vpcUuid | String | VPC uuid | 7y6g5f074ef6e32e041a2ef124b19e63 |
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/instance/list?pageNum=1&pageSize=10&spuInstId=String&spuInstName=String&bizState=String
请求头header
{
"regionId": "1234567890"
}
请求体body
响应示例
{
"statusCode": 2000,
"message": "success",
"returnObj": {
"total": 2,
"list": [
{
"spuInstId": "77fca047899b625effafd83ff6e7a0f7",
"prodInstName": "mse-bxw0ow-dingj10",
"appCode": "msegw",
"versionNo": "2.8.4",
"tenantId": 3669,
"tenantCode": "Ctyunf4e236c2410d4c2e1672808882",
"spuCode": "MSEGW",
"spuId": "107201",
"spuName": "微服务云原生网关",
"skuCode": "msegw.base.s1",
"skuId": "107201",
"skuName": "基础版",
"regionCode": "d8bbd132b53a11e9b0e40242ac110002",
"regionName": "贵州测试资源池(云电脑云手机混合)",
"bizState": "1",
"createdTime": "2023-05-09 16:20:50",
"modifiedTime": "2023-05-09 16:20:50",
"expTime": "2027-07-31 00:00:00",
"userId": 16263,
"createdBy": 16263,
"seriesCode": "msegw.base",
"prodSrc": "2",
"instNodeNum": "1",
"msegwServerUrl": "192.168.0.7:27151",
"msegwServerMgrUrl": "198.20.8.57:27151",
"bizVipBindVmTypes": "1",
"bizVip": "1",
"vip": "192.168.0.66",
"virtualRouterId": "8",
"vipV6": ""
},
{
"spuInstId": "878da73f7dba36ff0ae80e004a4f28f9",
"prodInstName": "mse-1e6cfz",
"appCode": "msegw",
"versionNo": "2.8.4",
"tenantId": 3669,
"tenantCode": "Ctyunf4e236c2410d4c2e1672808882",
"spuCode": "MSEGW",
"spuId": "107201",
"spuName": "微服务云原生网关",
"skuCode": "msegw.base.s1",
"skuId": "107201",
"skuName": "基础版",
"regionCode": "d8bbd132b53a11e9b0e40242ac110002",
"regionName": "贵州测试资源池(云电脑云手机混合)",
"bizState": "1",
"createdTime": "2023-05-05 16:53:23",
"modifiedTime": "2023-05-05 16:53:23",
"expTime": "2027-07-31 00:00:00",
"userId": 16263,
"createdBy": 16263,
"seriesCode": "msegw.base",
"prodSrc": "2",
"instNodeNum": "1",
"msegwServerUrl": "192.168.0.190:27151",
"msegwServerMgrUrl": "198.20.0.223:27151",
"bizVipBindVmTypes": "1",
"bizVip": "1",
"vip": "192.168.0.56",
"virtualRouterId": "4",
"vipV6": ""
}
],
"pageNum": 1,
"pageSize": 10,
"size": 2,
"startRow": 0,
"endRow": 4,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。