接口功能介绍
设置某个schema的属性。
接口约束
请先订购DRDS实例。
URI
PUT /v2/property/alter-schema
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | DRDS产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
schemaName | 是 | String | schema名称 | bss_crm_test | |
propertyCode | 是 | String | 属性编码 | increment | |
propertyValue | 否 | String | 属性值。是否必填取决于属性的required,1表示必填。值类型参考valueType或默认值;值范围取决于propertyValueList,如果有的话;如果是非必填属性且属性值不传或传null,则会忽略该属性。 | 2000 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success |
请求示例
请求头header
无
请求体body
{
"prodInstId":"ccdde51ffa53496db2c97170580c22ec",
"schemaName":"bss_crm_test",
"propertyCode":"increment",
"propertyValue":"2000"
}
响应示例
{
"code": 0,
"message": "success"
}
状态码
请参考 状态码说明。