接口功能介绍
查询关联RDS属性列表。
接口约束
请先订购DRDS实例。
URI
GET /v2/rds-property/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | DRDS产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
groupName | 是 | String | 分组名称 | 默认分组 | |
rdsProdInstId | 是 | String | RDS-MySQL实例ID | 5446 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Array of Objects | 返回对象,列表,若无该字段或该字段为null或者空列表,都代表返回对象为空。 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
propertyId | 是 | Long | 属性id | 139 | |
catId | 是 | Long | 分类id | 1 | |
propertyCode | 是 | String | 属性编码 | maxCon | |
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": [
{
"propertyId": 200,
"catId": 8,
"propertyCode": "maxCon",
"propertyType": 1,
"propertyName": "最大连接数",
"memo": "最大连接数",
"inputType": 3,
"listOrder": 1,
"status": 1,
"createdTime": "2015-10-10T07:55:06.000+00:00",
"createdBy": 1,
"modifiedTime": "2017-09-28T08:57:16.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "3000",
"valueType": 0,
"realtime": 0,
"display": 1,
"groupId": 6,
"propertyValue": "3000"
},
{
"propertyId": 43,
"catId": 8,
"propertyCode": "maxIdle",
"propertyType": 1,
"propertyName": "最大空闲连接数个数",
"memo": "最大空闲连接数个数,空闲列表上最多有多个空闲链接",
"inputType": 3,
"listOrder": 2,
"status": 1,
"createdTime": "2015-10-10T07:54:26.000+00:00",
"createdBy": 1,
"modifiedTime": "2017-09-29T03:21:29.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "32",
"valueType": 0,
"validateFunc": "",
"realtime": 0,
"display": 1,
"groupId": 6,
"propertyValue": "32"
},
{
"propertyId": 50,
"catId": 8,
"propertyCode": "idleTimeout",
"propertyType": 1,
"propertyName": "空闲的超时时间(毫秒)",
"memo": "空闲的超时时间,超出这个时间的链接才会被清除",
"inputType": 3,
"listOrder": 3,
"status": 1,
"createdTime": "2016-11-22T07:10:09.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-11-22T07:10:09.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "1",
"valueType": 1,
"realtime": 0,
"display": 1,
"groupId": 6,
"propertyValue": "1"
},
{
"propertyId": 201,
"catId": 8,
"propertyCode": "connectTimeout",
"propertyType": 1,
"propertyName": "获取连接超时(毫秒)",
"memo": "获取连接的超时时间,单位毫秒。推荐值5000",
"inputType": 3,
"listOrder": 4,
"status": 1,
"createdTime": "2017-09-28T08:59:21.000+00:00",
"createdBy": 1,
"modifiedTime": "2017-09-28T08:59:21.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "5000",
"valueType": 0,
"realtime": 0,
"display": 1,
"groupId": 6,
"propertyValue": "5000"
},
{
"propertyId": 45,
"catId": 8,
"propertyCode": "balance",
"propertyType": 1,
"propertyName": "读写分离配置",
"memo": "负载均衡属性,目前的取值有3种:\n\nbalance=\"0\", 不开启读写分离机制,所有读操作都发送到当前可用的writeHost上。\n\nbalance=\"1\",全部的readHost 与stand by writeHost 参与select 语句的负载均衡,简单的说,当双主双从模式(M1->S1,M2->S2,并且M1 与M2 互为主备),正常情况下,M2,S1,S2 都参与select 语句的负载均衡。\n\nbalance=\"2\",所有读操作都随机的在writeHost、readhost上分发。",
"inputType": 1,
"listOrder": 5,
"status": 1,
"createdTime": "2015-10-10T07:55:42.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-11-22T07:10:45.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "0",
"valueType": 0,
"realtime": 0,
"display": 1,
"groupId": 6,
"propertyValue": "0",
"propertyValueList": [
{
"propertyValueId": 31,
"propertyValue": "0",
"listOrder": 1,
"propertyId": 45
},
{
"propertyValueId": 32,
"propertyValue": "1",
"listOrder": 2,
"propertyId": 45
},
{
"propertyValueId": 33,
"propertyValue": "2",
"listOrder": 3,
"propertyId": 45
}
]
},
{
"propertyId": 46,
"catId": 8,
"propertyCode": "writeType",
"propertyType": 1,
"propertyName": "writeType",
"memo": "负载均衡类型,目前的取值有3 种:\n\nwriteType=\"0\", 所有写操作发送到配置的第一个writeHost , 第一个挂了切到还生存的第二个writeHost。如果都挂了,那就悲剧了,起来哪个,写哪个,很有可能数据不一致;所以不要数据库恢复之后不要让dbproxy切回。\n\nwriteType=\"1\",所有写操作都随机的发送到配置的writeHost。\n\nwriteType=\"2\",没实现。",
"inputType": 1,
"listOrder": 6,
"status": 1,
"createdTime": "2015-10-10T07:59:05.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-11-22T07:10:56.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "0",
"valueType": 0,
"realtime": 0,
"display": 0,
"groupId": 6,
"propertyValue": "0",
"propertyValueList": [
{
"propertyValueId": 34,
"propertyValue": "0",
"listOrder": 1,
"propertyId": 46
},
{
"propertyValueId": 35,
"propertyValue": "1",
"listOrder": 2,
"propertyId": 46
},
{
"propertyValueId": 36,
"propertyValue": "2",
"listOrder": 3,
"propertyId": 46
}
]
},
{
"propertyId": 47,
"catId": 8,
"propertyCode": "dbType",
"propertyType": 1,
"propertyName": "后端连接的数据库类型",
"memo": "指定后端连接的数据库类型,目前支持二进制的mysql 协议,目前暂时支持mysql和MariaDB,后面会逐渐支持其他数据库。",
"inputType": 1,
"listOrder": 7,
"status": 1,
"createdTime": "2015-10-10T08:01:11.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-11-22T07:11:23.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "mysql",
"valueType": 0,
"realtime": 0,
"display": 1,
"groupId": 6,
"propertyValue": "mysql",
"propertyValueList": [
{
"propertyValueId": 37,
"propertyValue": "mysql",
"listOrder": 1,
"propertyId": 47
},
{
"propertyValueId": 38,
"propertyValue": "MariaDB",
"listOrder": 2,
"propertyId": 47
}
]
},
{
"propertyId": 48,
"catId": 8,
"propertyCode": "dbDriver",
"propertyType": 1,
"propertyName": "连接后端数据库使用的Driver",
"memo": "指定连接后端数据库使用的Driver,目前可选的值有native和JDBC。使用native 的话,因为这个值执行的是二进制的mysql 协议,所以可以使用mysql和maridb。其他类型的数据库则需要使用JDBC 驱动来支持。但是目前还暂时不支持。",
"inputType": 1,
"listOrder": 8,
"status": 1,
"createdTime": "2015-10-10T08:02:33.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-11-22T07:11:28.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "native",
"valueType": 0,
"realtime": 0,
"display": 1,
"groupId": 6,
"propertyValue": "native",
"propertyValueList": [
{
"propertyValueId": 39,
"propertyValue": "native",
"listOrder": 1,
"propertyId": 48
},
{
"propertyValueId": 40,
"propertyValue": "JDBC",
"listOrder": 2,
"propertyId": 48
}
]
},
{
"propertyId": 49,
"catId": 8,
"propertyCode": "heartbeatSQL",
"propertyType": 1,
"propertyName": "心跳检查的语句",
"memo": "用于和后端数据库进行心跳检查的语句。例如,MYSQL 可以使用select user()",
"inputType": 3,
"listOrder": 9,
"status": 1,
"createdTime": "2015-10-10T08:03:36.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-11-22T07:11:13.000+00:00",
"modifiedBy": 1,
"required": 0,
"defaultValue": "select user()",
"valueType": 0,
"realtime": 0,
"display": 1,
"groupId": 6,
"propertyValue": "select user()"
}
]
}
状态码
请参考 状态码说明。