查看订单配置

最近更新时间: 2026-10-10 00:09:36

1. 接口描述

接口请求域名： ckafka.api3.fincloud.tencent.com。

DescribeOrderConfig

默认接口请求频率限制：100次/秒。

接口更新时间：2024-10-14 16:21:04。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeOrderConfig
Version	是	否	String	公共参数，本接口取值：2019-08-19
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceType	是	否	String	实例规格，不同规格类型代表实例不同的配置组合（吞吐量、磁盘）。具体取值可调用接口GetCkafkaTypeConfigs获取最新规格表。示例值： profession
Period	否	否	Int64	实例时长，单位：月，最小值1，最大值为36 示例值： 1
InstanceNum	否	否	Int64	购买实例数量。取值范围：[1，20] 示例值： 1
InquireFlag	否	否	Int64	询价标记：不填或者 0 默认为新够买询价 1为续费示例值： 0
ZoneId	否	否	Int64	区域ID 示例值： 100001
Bandwidth	是	否	Int64	购买带宽规格，单位：MB 示例值： 40
DiskSize	否	否	Int64	购买磁盘规格，默认为带宽对应的最小值，单位：GB 示例值： 600
DiskType	否	否	String	购买磁盘类型，默认为CLOUD_TCS 示例值： SSD
MessageRetention	否	否	Int64	消息保留时间，默认为72，单位：小时示例值： 72
Topic	否	否	Int64	购买Topic规格，默认为带宽对应的最小值，单位：个示例值： 100
Partition	否	否	Int64	购买Partition规格，默认为带宽对应的最小值，单位：个示例值： 1000
BrokerVersion	否	否	String	购买实例版本示例值： 1.1.1
CategoryAction	否	否	String	标记：purchase新购，renew续费，modify升配示例值： purchase
BillType	否	否	String	标准版S2计费类型示例值： 1
PublicNetworkChargeType	否	否	String	公网带宽计费类型（预付费按带宽结算(包年带宽):BANDWIDTH_PREPAID、带宽按小时后付费(按小时带宽):BANDWIDTH_POSTPAID_BY_HOUR 示例值： BANDWIDTH_PREPAID
PublicNetworkMonthly	否	否	Int64	公网带宽示例值： 1
ResourceId	否	否	String	实例ID 示例值：无

3. 输出参数

参数名称	类型	描述
Result	BillingOrderConfig	出参示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
FailedOperation	操作失败。

5. 示例

示例1 查看订单配置

输入示例

https://ckafka.api3.fincloud.tencent.com/?Action=DescribeOrderConfig
&InstanceType=profession
&Bandwidth=40
&<Common Parameters>

输出示例

{
  "Response": {
    "Result": {
      "Inquiry": "{\"Price\":{\"DiscountPrice\":0.00}}",
      "OrderConfig": "{\"instanceType\":\"profession\",\"bandwidth\":40}",
      "CategoryId": 0
    },
    "RequestId": "2ea4433d-1cd4-43cb-9f8a-1d4f0e5f4a42"
  }
}