查询包年/包月资源的续订金额
功能介绍
客户在自建平台按照条件查询包年/包月资源续订时候的续订金额。
- 调用接口时，如果某个主资源有对应的从资源，系统会将主资源和从资源一起计算续订金额，主资源的从资源信息可以通过调用查询客户包年/包月资源列表接口获取。
- 注意：如ECS主机挂载新购的云硬盘，但此硬盘不是该ECS主资源的从资源，主从资源信息必须以调用查询客户包年/包月资源列表接口获取的信息为准。
接口约束
该接口只允许使用客户AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/bills/ratings/period-resources/renew-rate
请求消息
请求参数
|
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
|
resource_ids |
是 |
List<String> |
[1-10] |
资源ID列表。 只支持传入主资源ID，最多10个资源ID。 哪些资源是主资源请根据“查询客户包年/包月资源列表”接口响应参数中的“is_main_resource”来标识。 |
|
period_type |
是 |
Integer |
[2|3] |
周期类型：
|
|
period_num |
是 |
Integer |
[1-11] |
周期数目：
|
|
include_relative_resources |
否 |
Boolean |
- |
是否包含关联资源一起续费询价。
此参数不携带或携带值为空串时，默认值为“false"。 |
POST https://bss.myhuaweicloud.com/v2/bills/ratings/period-resources/renew-rate HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "resource_ids": ["230221_169ee********9d5b8af6a38f099abea"], "period_type": 2, "period_num": 1, "include_relative_resources": false }
响应消息
响应参数
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
error_code |
String |
最大长度：20 |
状态码。 具体请参见状态码。 |
|
error_msg |
String |
最大长度：1000 |
错误描述信息。 |
|
currency |
String |
最大长度：20 |
币种。 CNY：人民币。 值为空代表人民币。 |
|
renew_inquiry_results |
List<RenewInquiryResultInfo> |
-- |
主资源（包含从资源）询价结果。具体请参见表1 |
|
official_website_rating_result |
OfficialWebsiteRatingResult Object |
-- |
主资源（包含从资源）的官网价格查询结果，具体参见表2。 |
|
optional_discount_rating_results |
List<OptionalDiscountRatingResult> |
-- |
存在可选折扣优惠时返回折扣优惠维度询价结果，每个折扣优惠一组询价结果，具体参见表3 OptionalDiscountRatingResult。 |
|
fail_resource_infos |
List<FailResourceInfo> |
-- |
失败的资源信息列表。具体请参见表FailResourceInfo。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源ID。
说明：
请求携带“include_relative_resources”字段，会返回关联资源的主资源ID。 |
|
amount |
String |
主资源（包含从资源）续订金额。单位为元。
说明：
请求携带“include_relative_resources”字段，会返回关联资源的主资源的续订金额。 |
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
official_website_amount |
String |
最大长度：64 |
官网价格。单位为元。 |
|
installment_official_website_amount |
String |
最大长度：64 |
分期金额的官网价。单位为元。
说明：
暂只支持IES产品。 |
|
installment_period_type |
Integer |
- |
分期付款的周期类型。
说明：
暂只支持IES产品。 |
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
discount_id |
String |
最大长度：64 |
折扣优惠ID。 |
|
amount |
String |
最大长度：64 |
总额，即最终优惠后的金额。单位为元。 amount= official_website_amount - discount_amount。 |
|
official_website_amount |
String |
最大长度：64 |
官网价。单位为元。 |
|
discount_amount |
String |
最大长度：64 |
可选折扣优惠额，如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额。单位为元。 |
|
discount_type |
Integer |
最大长度：32 |
折扣优惠类型。 |
|
discount_name |
String |
最大长度：256 |
折扣名称。 |
|
best_offer |
Integer |
- |
是否为最优折扣。 |
|
installment_official_website_amount |
String |
最大长度：64 |
分期金额的官网价。单位为元。
说明：
暂只支持IES产品。 |
|
installment_official_discount_amount |
String |
最大长度：64 |
分期金额的折扣价。单位为元。
说明：
暂只支持IES产品。 |
|
installment_amount |
String |
最大长度：64 |
分期金额的成交价。单位为元。
说明：
|
|
installment_period_type |
Integer |
- |
分期付款的周期类型。
说明：
暂只支持IES产品。 |
表 FailResourceInfo
状态码：200
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"currency": "CNY",
"renew_inquiry_results": [{
"resource_id": "230221_169ee********9d5b8af6a38f099abea",
"amount": "800.0"
}],
"official_website_rating_result": {
"official_website_amount": "800.0",
"installment_official_website_amount": null,
"installment_period_type": null
},
"optional_discount_rating_results": [],
"fail_resource_infos": []
}
状态码
- 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
- 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。
|
HTTP状态码 |
错误码 |
描述 |
|---|---|---|
|
200 |
CBC.30050007 |
资源非主资源，不允许续费询价。 |
|
200 |
CBC.30050008 |
资源不存在对应的的周期类型或周期数。 |
|
200 |
CBC.30050009 |
资源已过期删除或不存在。 |
|
200 |
CBC.30050010 |
当前操作的资源中，有资源包含在您的待支付的订单，不能进行当前操作。 |
|
200 |
CBC.30050011 |
资源正在退订或者变更。 |
|
200 |
CBC.30050013 |
该产品不支持续费。 |
|
400 |
CBC.0100 |
参数错误。 |
|
400 |
CBC.99006006 |
找不到您询价的产品。 |
|
400 |
CBC.99006024 |
查询产品信息失败。 |
|
400 |
CBC.99006016 |
查询优惠券信息失败。 |
|
400 |
CBC.99006017 |
查询客户信息失败。 |
|
400 |
CBC.99006050 |
使用量单位错误。 |
|
400 |
CBC.99006055 |
询价结果超过金额最大限制。 |
|
400 |
CBC.99006066 |
查询计费信息失败。 |
|
400 |
CBC.99006073 |
项目不存在。 |
|
400 |
CBC.30050012 |
存在重复的资源ID。 |
|
403 |
CBC.0151 |
访问拒绝。 |
|
403 |
CBC.0154 |
token非法/过期。 |
|
500 |
CBC.0999 |
其他错误。 |
