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