调用 ModifyInstanceAttributes 接口修改对应实例名称、描述等实例信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyInstanceAttributes | 要执行的操作,取值:ModifyInstanceAttributes。 |
Version | String | 是 | 2022-05-01 | API的版本,取值:2022-05-01。 |
InstanceName | String | 否 | myinstance | 实例名称。 |
InstanceDescription | String | 否 | New instance | 实例描述。 |
InstanceId | String | 是 | kafka-cnngqkfgdudt**** | 实例 ID。 |
本接口无特有的返回参数。更多信息请见返回结构。
POST /?Action=ModifyInstanceAttributes&Version=2022-05-01 HTTP/1.1 Content-Type: application/json Host: kafka.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=******** { "InstanceId": "kafka-cnng5ysg5vv9****", "InstanceName": "DTS-all", "InstanceDescription": "DTS-all" }
{ "ResponseMetadata": { "RequestId": "202302271847143C6FF96F30A58C7F0FE4", "Action": "ModifyInstanceAttributes", "Version": "2022-05-01", "Service": "Kafka", "Region": "cn-beijing" }, "Result": null }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | InvalidParameter | 参数值无效。 |
403 | OperationDenied.AccountNotAuthorized | 您不具备相关权限 ,请授权或切换账号后重试。 |
403 | OperationDenied.InvalidInstanceStatus | 当前实例状态不允许执行该操作。 |
404 | InvalidInstanceId.NotFound | 实例不存在。 |
500 | InternalError | 内部错误,请稍后重试。 |