You need to enable JavaScript to run this app.
导航
ModifyInstanceAttributes - 修改实例基本信息
最近更新时间:2024.09.26 15:55:17首次发布时间:2023.03.30 19:59:25

调用 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
The specified parameter is not valid.

参数值无效。

403
OperationDenied.AccountNotAuthorized
You are not authorized to perform this operation.

您不具备相关权限 ,请授权或切换账号后重试。

403
OperationDenied.InvalidInstanceStatus
The operation is not valid for the current status of the instance.

当前实例状态不允许执行该操作。

404
InvalidInstanceId.NotFound
The specified Instance ID does not exist.

实例不存在。

500
InternalError
The request failed due to some unknown error, exception or failure.

内部错误,请稍后重试。