实例管理
1.查询实例信息
接口功能介绍
无
接口约束
无
URI
GET /cgw/v1/instance/one
Accept: application/json
路径参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
spuInstId | 是 | String | 实例ID | 7a2828074ef6e32e041a2ef124b19e63 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124b19e63 |
请求体body参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Object | 返回数据 | SpuInstVO | |
message | String | 异常描述 | success |
表 SpuInstVO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
appCode | String | 实例产品编码 | msegw | |
azInfos | Array of Objects | 可用区信息 | AzInfo | |
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 | |
mirrorInfo | Object | 镜像信息 | MirrorInfo | |
modifiedTime | String | 实例修改时间 | 2023-12-10 12:12:12 | |
monitorHosts | Array of Objects | 节点信息 | MonitorHostVO | |
msegwServerMgrSslUrl | String | 管理网SSL连接地址 | 198.20.7.43:27154 | |
msegwServerMgrUrl | String | 管理网连接地址 | 198.20.7.43:27151 | |
msegwServerSslUrl | String | 内网SSL连接地址 | 192.168.13.45:27154 | |
msegwServerUrl | String | 内网连接地址 | 192.168.13.45:27151 | |
paasInstAttrs | Array of Objects | 产品属性 | PaasInstAttr | |
prodInstName | String | 实例名称 | msegw-test | |
prodSrc | String | 工单来源 | 4 | |
regionCode | String | 资源池Code标识 | d8bbd132b53a11e9b0e40242ac110002 | |
regionId | Long | 资源池ID标识 | 2345 | |
regionName | String | 资源池名称 | beijing4 | |
securityGroup | Object | 安全组信息 | SecurityGroup | |
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 | 产品名称 | 云原生网关 | |
subnetInfo | Object | 子网信息 | SubnetInfo | |
tenantCode | String | 租户Code标识 | Ctyun714be2e13c1741191672809015 | |
tenantId | Long | 租户ID标识 | 1 | |
tenantName | String | 租户名称 | name | |
traceAnalysis | Object | 链路追踪配置信息 | TraceAnalysis | |
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 |
表 AzInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
azId | String | 可用区ID | 1 | |
azName | String | 可用区名称 | az1 |
表 IamLabelItem
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
key | String | |||
labelId | String | |||
value | String |
表 MirrorInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
mirrorCategoryName | String | 镜像名称 | ||
mirrorId | String | 镜像ID标识 | 1 | |
mirrorUuid | String | 镜像uuid标识 | 7a2828074ef6e32e041a2ef1246tf45s |
表 MonitorHostVO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
ecsId | String | 主机编码 | ||
hostName | String | 主机名称 | ||
ip | String | VPC的ipv4地址 |
表 PaasInstAttr
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
actionType | String | 属性变更动作类型 | 1 | |
attrCode | String | 产品属性编码 | instanceNum | |
attrValue | String | 产品属性值 | 4 |
表 SecurityGroup
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
securityGroupId | String | 安全组 ID | 1 | |
securityGroupName | String | 安全组名称 | default | |
securityGroupUuid | String | 安全组 uuid | 7a282hg6f356e32e041a2ef124b19e63 |
表 SubnetInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
subnetId | String | 子网ID | 1 | |
subnetName | String | 子网名称 | default |
表 TraceAnalysis
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
openStatus | Boolean | 开启状态 | true | |
sampleRate | Double | 采样率 | 100 |
表 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/one?spuInstId=String
请求头header
{
"regionId": "1234567890"
}
请求体body
响应示例
{
"statusCode": 2000,
"message": "success",
"returnObj": {
"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",
"instanceStatus": "normal",
"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",
"msegwServerSslUrl": "192.168.0.190:27154",
"msegwServerMgrUrl": "198.20.0.223:27151",
"msegwServerMgrSslUrl": "198.20.0.223:27154",
"bizVipBindVmTypes": "1",
"bizVip": "1",
"vip": "192.168.0.56",
"virtualRouterId": "4",
"vipV6": "",
"vpcInfo": {
"vpcName": "vpc-cjh3",
"vpcId": "5928",
"vpcUuid": "1343c5f3-3d41-4240-997a-ad1896d26c74",
"vpcCidr": "192.168.0.0/16"
},
"securityGroup": {
"securityGroupId": "12708",
"securityGroupUuid": "021ec8fd-3d63-4db3-8155-f2b994c7787c",
"securityGroupName": "security_wq2"
},
"subnetInfo": {
"subnetId": "11910",
"subnetName": "subnet-me07"
},
"azInfos": [
{
"azId": "205",
"azName": "az-testteam"
}
],
"mirrorInfo": {
"mirrorUuid": "f0813640-951e-44fa-869a-1d46bd1284a8",
"mirrorId": "4690",
"mirrorCategoryName": "grpc_agent_v1_0404"
},
"traceAnalysis": {
"openStatus": true,
"sampleRate": 5
},
"paasInstAttrs": [
{
"attrCode": "subnetId",
"attrValue": "11910",
"actionType": "1"
},
{
"attrCode": "prodSrc",
"attrValue": "2",
"actionType": "1"
}
]
}
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。