套餐管理:订购
更新时间 2025-10-24 11:00:29
最近更新时间: 2025-10-24 11:00:29
接口功能介绍
调用此接口可订购套餐包。
接口约束
参见请求参数说明。
URI
POST /v4/monitor/order/place
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| autoPay | 否 | Boolean | 本参数表示是否自动支付,默认值false,取值范围: true:自动支付。 false:不是自动支付。 根据以上范围取值。 | true | |
| payVoucherPrice | 否 | String | 支付代金券金额,默认值0,格式为:两位小数,不能为负数,支付代金券金额只适用于预付费客户自动支付,若代金券支付金额传0或者空字符串,不使用代金券支付 | 50.00 | |
| isOnDemand | 是 | Boolean | 是否按需 | true | |
| autoRenewStatus | 否 | Integer | 此参数表示是否开启自动续订,默认值0,取值范围: 0:关闭自动续订。 1:开启自动续订。 根据以上范围取值。 | 1 | |
| orders | 是 | Array of Objects | 订单信息 | order | |
| 表 order |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| instanceCnt | 是 | Integer | 实例数量,取值范围:1-50。 根据以上范围取值。 | 10 | |
| cycleCnt | 是 | Integer | 订购时长,取值范围: 1:资源类型resourceType为SMSP时。 6:资源类型resourceType为VOIP时。 根据以上范围取值。 | 1 | |
| cycleType | 是 | Integer | 此参数表示订购周期,取值范围: 6:两年(资源类型resourceType为SMSP时)。 3:月(资源类型resourceType为VOIP时)。 根据以上范围取值。 | 6 | |
| items | 是 | Array of Objects | 订单项信息 | item | |
| 表 item |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| master | 是 | Boolean | 是否为主资源 | true | |
| resourceType | 是 | String | 此参数表示资源类型,取值范围: SMSP:短信通知套餐包。 VOIP:语音通知套餐包。 根据以上范围取值。 | SMSP | |
| serviceTag | 是 | String | 此参数表示服务平台, 取值范围: CM:云监控。 根据以上范围取值。 | CM | |
| itemValue | 是 | Integer | 此参数表示订单项值。 资源类型resourceType为SMSP时的取值范围, 1000, 2000, 5000, 10000, 20000, 50000, 100000。 资源类型resourceType为VOIP时的取值范围: 500, 1000, 2000, 5000, 10000。 根据以上范围取值。 | 10000 | |
| itemConfig | 是 | Object | 订单项配置信息 | itemConfig | |
| 表 itemConfig |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bundleSize | 是 | Integer | 此参数表示规格数,与itemValue值需一致,取值范围: 500:500条。 1000:1000条。 2000:2000条。 5000:5000条。 10000:10000条。 20000:20000条。 50000:50000条。 100000:100000条。 根据以上范围取值。 | 10000 | |
| validityPeriod | 是 | Integer | 此参数表示有效期, 取值范围: 2:2年(资源类型resourceType为SMSP时)。 6:6个月(资源类型resourceType为VOIP时)。 根据以上范围取值。 | 2 | |
| version | 是 | String | 版本号,固定值:v1。 | v1 | |
| type | 是 | String | 属性值,固定值:standard。 | standard |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
| errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
| message | String | 失败时的错误描述,一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述,适配中英文 | 成功 | |
| description | String | 失败时的错误描述,适配中英文 | 成功 | |
| error | String | 错误码,请求成功时,不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数,参考returnObj对象结构 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| newOrderID | String | 订单ID | 1b86e7cebc0b446f97db2b75598d5187 | |
| newOrderNo | String | 订单号 | 20241108151204881770 | |
| totalPrice | Integer | 总价 | 30000 | |
| orderDetailUrl | String | 付款链接 | https://wwwtest.ctyun.cn:21443/order/order_detail/481bbe3148ac4de98255d458507d4404&lang=zh-cn | |
| submitted | Boolean | 是否提交 | true | |
| errorMessage | String | 错误消息 |
枚举参数
无
请求示例
请求url
/v4/monitor/order/place
请求头header
无
请求体body
{
"autoPay": true,
"payVoucherPrice": "",
"isOnDemand": false,
"autoRenewStatus": 0,
"orders": [
{
"instanceCnt": 50,
"cycleCnt": 1,
"cycleType": 6,
"items": [
{
"master": true,
"resourceType": "SMSP",
"serviceTag": "CM",
"itemValue": 10000,
"itemConfig": {
"bundleSize": 10000,
"validityPeriod": 2,
"version": "v1",
"type": "standard"
}
}
]
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"newOrderNo": "20241112153401938817",
"totalPrice": 25000,
"errorMessage": "",
"submitted": true,
"orderDetailUrl": "https://wwwtest.ctyun.cn:21443/console/expense/order/detail?orderId=eec12ea273dc4947bb60e1ab085d0502&lang=zh-cn",
"newOrderID": "eec12ea273dc4947bb60e1ab085d0502"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码