该接口用于更新集合对象的名称和注释。
接口说明
目前只支持更新名称(name)、注释(comment)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| QualifiedName |
string |
是 |
集合的唯一标识 |
album.396397 |
| Name |
string |
否 |
名称 |
myCollectionName |
| Comment |
string |
否 |
集合备注 长度限制:1-64 字符 |
this is a comment |
更新的时候 Name 、Comment 二者至少要提供一个。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结构 |
||
| RequestId |
string |
请求的 ID。用于定位日志,排查问题。 |
0000-ABCD-E**** |
| Status |
boolean |
更新结果: true: 成功 false: 失败 |
true |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| ErrorMessage |
string |
错误信息。 |
The specified product does not exist. |
| ErrorCode |
string |
错误码。 |
9999 |
| Success |
boolean |
调用是否成功。取值如下:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "0000-ABCD-E****",
"Status": true,
"HttpStatusCode": 200,
"ErrorMessage": "The specified product does not exist.",
"ErrorCode": "9999",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。
该文章对您有帮助吗?