设置备注v3
更新时间 2026-08-10 19:34:49
最近更新时间: 2026-08-10 19:34:49
接口功能介绍
设置备注v3
接口约束
无
URI
POST /v3/commonSetting/setRemark
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| remark | 是 | String | 备注。租户备注,长度上限 50 个字符;传入空字符串时,备注会被设置为空。 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据结构体。 | returnObj |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
请求头header
无
请求体body
{
"remark":"备注"
}
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{ }
}
状态码
请参考 状态码
错误码
请参考 错误码