接口功能介绍
查询某个节点的详情。
接口约束
请先订购DRDS实例。
URI
GET /v2/node/query
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | DRDS产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
nodeId | 是 | String | 节点id | /dbproxy_cluster/dbproxy_cluster_0000000372/nodes/node_0000000459 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Objects | 返回对象。若无该字段或该字段为null,都代表返回对象为空 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 节点id | ||
name | 是 | String | 节点名称 | ||
host | 否 | String | 主机编码 | ||
deployPath | 否 | String | 部署路径 | ||
serverPort | 是 | String | 端口 | ||
versionNo | 是 | String | 版本号 | ||
hostInstId | 否 | String | 主机id | ||
hostName | 否 | String | 主机名称 | ||
ip | 是 | String | ip地址 | ||
pubTime | 否 | String | 发布时间 | ||
versionNum | 否 | String | 版本 | ||
groupId | 是 | String | 所属分组的分组id | ||
groupName | 是 | String | 所属分组的分组名 | ||
properties | 否 | Array of Objects | 节点属性列表 | property | |
status | 是 | Integer | 节点状态,0:运行中,1:已停止,-1:未知。 请通过节点状态接口获取节点运行状态,本接口不实时查询节点状态因此只返回-1。 | ||
instanceStatus | 否 | String | 实例状态 | ||
xms | 否 | String | 最小堆内存 | ||
xmx | 否 | String | 最大堆内存 | ||
maxPermSize | 否 | String | 最大永久代内存 | ||
maxDirectMemorySize | 否 | String | 最大直接内存 | ||
clusterName | 是 | String | 实例名称 |
表 property
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
propertyId | 是 | Long | 属性id | 139 | |
catId | 是 | Long | 分类id | 1 | |
propertyCode | 是 | String | 属性编码 | enableMetricMonitor | |
propertyType | 是 | Integer | 属性类型,0-全部分类 1-应用属性 2-实例属性 3-分组属性 | 3 | |
propertyName | 是 | String | 属性名称 | ||
propertyNameEn | 否 | String | 英文属性名称 | ||
memo | 是 | String | 属性描述 | ||
memoEn | 否 | String | 英文属性描述 | ||
inputType | 是 | Integer | 输入类型,(1:select,2:checkbox,3:text,4:textarea) | ||
listOrder | 是 | Integer | 排序序号 | ||
status | 是 | Integer | 状态,0-无效 1-有效 | ||
createdTime | 是 | String | 创建时间 | ||
createdBy | 否 | Long | 创建者id | ||
modifiedTime | 否 | String | 修改时间 | ||
modifiedBy | 否 | Long | 修改者id | ||
required | 是 | Integer | 是否必填,0:否,1:必填 | ||
defaultValue | 否 | String | 默认值 | ||
valueType | 是 | Integer | 属性值类型,0:字符类型,1:数字类型,2:布尔类型,3:日期类型 | ||
realtime | 是 | Integer | 是否支持在线加载(是否即时生效),0:否,1:是 | ||
display | 是 | Integer | 是否显示,0:否,1:是 | ||
groupId | 是 | Long | 属性分组id | ||
zkPropertyId | 是 | String | zk属性id | ||
groupCode | 是 | String | 分组编码 | ||
propertyValue | 否 | String | 属性值 | ||
propertyValueList | 否 | Array of Objects | 属性值可选值范围 | PropertyValue |
表 PropertyValue
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
propertyValueId | 是 | Integer | 属性值id | ||
propertyValue | 是 | Integer | 属性值 | ||
listOrder | 是 | Integer | 排序序号 | ||
propertyId | 是 | Integer | 所属的属性id |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code": 0,
"message": "success",
"result": {
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/nodes/node_0000000459",
"name": "node1",
"host": "host_0000000373",
"deployPath": "/home/udal/DBProxy",
"serverPort": "8866",
"versionNo": "2.7.8_P1",
"hostInstId": "4e0dac1c-9696-4990-8268-99a7db7fe0c0",
"hostName": "dbproxyHost1",
"ip": "192.168.0.174",
"pubTime": "2022-09-29T02:16:28.000+00:00",
"versionNum": "2.7.8_P1",
"groupId": "group_0000000429",
"groupName": "默认分组",
"properties": [
{
"propertyId": 114,
"catId": 1,
"propertyCode": "latchLimit",
"propertyType": 2,
"propertyName": "前端连接数限制",
"memo": "控制前端最大连接数,默认值800",
"inputType": 3,
"listOrder": 25,
"status": 1,
"createdTime": "2016-03-21T09:54:20.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-04-11T09:50:56.000+00:00",
"modifiedBy": 1,
"required": 1,
"defaultValue": "800",
"valueType": 1,
"realtime": 1,
"display": 1,
"groupId": 1,
"zkPropertyId": "/dbproxy_cluster/dbproxy_cluster_0000000372/nodes/node_0000000459/properties",
"propertyValue": "8000",
"propertyValueList": []
}
],
"status": -1,
"instanceStatus": "enabled",
"xms": "4G",
"xmx": "4G",
"maxPermSize": "256M",
"maxDirectMemorySize": "4G",
"clusterName": "Drds-cc84"
}
}
状态码
请参考 状态码说明。