文档中心>消息队列 Pulsar 版

修改RocketMQ专享实例配置

最近更新时间:2024-03-12 01:53:40

我的收藏

1. 接口描述

接口请求域名: tdmq.tencentcloudapi.com 。

本API用于修改RocketMQ专享实例配置,可以支持实例规格、节点数和存储的升配和实例规格的降配。本API发起订单并成功支付后进入实例配置变更的流程,可通过DescribeRocketMQVipInstances查询实例是否已变更完成。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyRocketMQInstanceSpec。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 专享实例ID
示例值:rocketmq-xxxx
Specification String 实例规格,
rocket-vip-basic-1 基础型
rocket-vip-basic-2 标准型
rocket-vip-basic-3 高阶Ⅰ型
rocket-vip-basic-4 高阶Ⅱ型
示例值:rocket-vip-basic-1
NodeCount Integer 节点数量
示例值:2
StorageSize Integer 存储空间,GB为单位
示例值:1000

3. 输出参数

参数名称 类型 描述
OrderId String 订单号
注意:此字段可能返回 null,表示取不到有效值。
示例值:20121212312322
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改RocketMQ专享实例规格

对实例进行升降配

输入示例

POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRocketMQInstanceSpec
<公共请求参数>

{
    "InstanceId": "abc",
    "Specification": "abc",
    "NodeCount": 1,
    "StorageSize": 1
}

输出示例

{
    "Response": {
        "OrderId": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.CallTrade 调用交易服务发生异常。
FailedOperation.InstanceNotReady 实例尚未就绪,请稍后再试。
InvalidParameterValue.AtLeastOne 至少需要提供一个参数。
ResourceNotFound.Instance 实例不存在。
UnsupportedOperation.InstanceDowngrade 该实例不支持降配操作。