接口功能介绍
查询schema属性列表。
接口约束
请先订购DRDS实例。请先订购和DRDS实例在一个资源池同一个VPC下的RDS-MySQL实例,并关联到DRDS实例。请先创建一个schema。
URI
GET /v2/property/list-schema
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | DRDS产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
schemaName | 是 | String | schema名称 | bss_crm_test | |
pageNow | 否 | Integer | 当前页,若为空或小于1,默认是1 | 1 | |
pageSize | 否 | Integer | 页大小,若为空或小于1,默认是10 | 10 | |
propertyName | 否 | String | 属性名,模糊搜索属性编码或属性名中包含该参数的属性 |
请求参数
请求头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 | 属性编码 | ||
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": 37,
"catId": 7,
"propertyCode": "sqlMaxLimit",
"propertyType": 1,
"propertyName": "sqlMaxLimit",
"propertyNameEn": "sqlMaxLimit",
"memo": "sql语句只涉及到一张表,并且该表是全局表或者where中没有主键条件的时候,该属性生效",
"memoEn": "The sql statement only involves a table, and the attribute is effective when the table is a global table or there is no primary key condition in where",
"inputType": 3,
"listOrder": 1,
"status": 1,
"createdTime": "2015-09-16T09:20:54.000+00:00",
"createdBy": 1,
"modifiedTime": "2015-10-12T10:17:19.000+00:00",
"modifiedBy": 1,
"required": 1,
"defaultValue": "1000",
"valueType": 1,
"realtime": 1,
"display": 1,
"groupId": 4,
"zkPropertyId": "/dbproxy_cluster/dbproxy_cluster_0000000372/schemas/schema_0000000509",
"groupCode": "schema",
"propertyValue": "1000"
},
{
"propertyId": 107,
"catId": 7,
"propertyCode": "isPermitComplexInnerTableSql",
"propertyType": 1,
"propertyName": "开启库内分表复杂sql",
"propertyNameEn": "Whether to enable the support of complex sql for inner table",
"memo": "是否开启join、union等sql中包含多个库内分表的支持,默认关闭",
"memoEn": "Whether to enable the support of join, union and multiple inner tables contained in sql: Defaults to closed",
"inputType": 1,
"listOrder": 1,
"status": 1,
"createdTime": "2016-02-16T02:40:34.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-02-24T09:30:21.000+00:00",
"modifiedBy": 1,
"required": 1,
"defaultValue": "false",
"valueType": 2,
"realtime": 1,
"display": 1,
"groupId": 4,
"zkPropertyId": "/dbproxy_cluster/dbproxy_cluster_0000000372/schemas/schema_0000000509",
"groupCode": "schema",
"propertyValue": "false",
"propertyValueList": [
{
"propertyValueId": 57,
"propertyValue": "true",
"listOrder": 1,
"propertyId": 107
},
{
"propertyValueId": 58,
"propertyValue": "false",
"listOrder": 2,
"propertyId": 107
}
]
},
{
"propertyId": 108,
"catId": 7,
"propertyCode": "maxNodeForRrs",
"propertyType": 1,
"propertyName": "开启库内分表虚拟连接",
"propertyNameEn": "Whether to enable the inner table virtual connection",
"memo": "是否开启库内分表虚拟连接,当开启该属性后,库内分表相关sql语句将由路由结果中原始连接转换为多个虚拟连接并行执行以提升sql的执行速度,\n默认为-1,不开启",
"memoEn": "Whether to enable the inner table virtual connection: When this attribute is enabled, related sql statements in the inner tables in the database will be converted from the original connection in the routing result to multiple virtual connections to be executed in parallel to improve the execution speed of sql.Defaults to -1, not enabled",
"inputType": 3,
"listOrder": 2,
"status": 1,
"createdTime": "2016-02-16T02:41:27.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-02-24T09:30:42.000+00:00",
"modifiedBy": 1,
"required": 1,
"defaultValue": "-1",
"valueType": 1,
"realtime": 1,
"display": 1,
"groupId": 4,
"zkPropertyId": "/dbproxy_cluster/dbproxy_cluster_0000000372/schemas/schema_0000000509",
"groupCode": "schema",
"propertyValue": "-1"
},
{
"propertyId": 109,
"catId": 7,
"propertyCode": "sqlCntPerNode",
"propertyType": 1,
"propertyName": "库内分表虚拟连接步长",
"propertyNameEn": "Step of inner table virtual connection",
"memo": "当开启库内分表虚拟连接后,通过该属性决定每个虚拟连接中划分的子sql数量,默认为3;当未开启虚拟连接时,该属性不生效",
"memoEn": "When the inner table virtual connection is enabled, the number of sub-sql divided in each virtual connection is determined by this attribute, and defaults to 3; when the virtual connection is not enabled, this attribute does not take effect",
"inputType": 3,
"listOrder": 3,
"status": 1,
"createdTime": "2016-02-16T02:42:06.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-02-25T01:27:56.000+00:00",
"modifiedBy": 1,
"required": 1,
"defaultValue": "3",
"valueType": 1,
"realtime": 1,
"display": 1,
"groupId": 4,
"zkPropertyId": "/dbproxy_cluster/dbproxy_cluster_0000000372/schemas/schema_0000000509",
"groupCode": "schema",
"propertyValue": "3"
},
{
"propertyId": 39,
"catId": 7,
"propertyCode": "increment",
"propertyType": 1,
"propertyName": "序列增量步长",
"propertyNameEn": "Sequence increment step length",
"memo": "序列增量步长",
"memoEn": "Sequence increment step length",
"inputType": 3,
"listOrder": 3,
"status": 1,
"createdTime": "2015-10-12T10:13:51.000+00:00",
"createdBy": 1,
"modifiedTime": "2016-03-01T08:58:25.000+00:00",
"modifiedBy": 1,
"required": 1,
"defaultValue": "1000",
"valueType": 1,
"realtime": 1,
"display": 1,
"groupId": 5,
"zkPropertyId": "/dbproxy_cluster/dbproxy_cluster_0000000372/schemas/schema_0000000509/sequence",
"groupCode": "sequence",
"propertyValue": "1000"
}
]
}
状态码
请参考 状态码说明。