更新Topic描述信息
接口说明
更新 Topic 描述信息
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dhs:UpdateTopic |
update |
*Project
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectName |
string |
是 |
项目名称 |
test_project |
| TopicName |
string |
是 |
主题名称 |
test_topic |
| Lifecycle |
integer |
否 |
Topic 中数据的保留时间,单位为天,取值范围 1~7。不传则不更新该属性。 |
3 |
| Comment |
string |
否 |
备注信息。 |
test |
| RecordSchema |
string |
否 |
Topic 的 Schema 定义,为 JSON 字符串。用于在已有 Schema 基础上追加(append)新字段,不支持修改或删除已有字段。格式为{"fields":[{"name":"字段名","type":"字段类型"}]}。不传则不更新该属性。 |
{"fields":[{"name":"field1","type":"STRING"}]} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 id |
20260319152525d2a3770b00c232d4 |
| Success |
boolean |
是否成功 |
True |
示例
正常返回示例
JSON格式
{
"RequestId": "20260319152525d2a3770b00c232d4",
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | Error:%s. | 输入的参数不合法 |
| 400 | MissingParameter | Error:%s. | 缺少必须参数 |
| 500 | InternalServerError | Error:%s. | 服务端错误,服务端不可用或发生了预期外的错误 |
| 403 | NoPermission | Error:%s. | 您无权执行此操作。 |
| 403 | OperationDenied | Error:%s. | 操作被拒绝 |
| 404 | ResourceNotFound | Error:%s. | 资源不存在 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。