文档

InquiryPriceRefundInstance - 退订实例询价

更新时间:
一键部署

InquiryPriceRefundInstance:调用本接口对需要退订的实例进行询价。

接口说明

  1. 请仔细核对退订资源的信息,并确认退订条款和退订金额,资源一经退订无法恢复。
  2. 退订只退还实付金额的部分,已使用的代金券不退还。
  3. 其他问题请参照:退订规则

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bss:RefundQueryRemainAmountRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ClientTokenstring

需要幂等场景必填。UUID 生成的字符串。此字段用于幂等,多次调用传入同样的值,会返回第一次的结果。

793F021C-B589-1225-82A9-99232AEBE494
ProductCodestring

退订场景必填,产品 code

ecs
InstanceIdstring

退订场景必填,实例 id

i-bp1etb69sqxgl4*******
ProductTypestring

退订场景必填,产品类型,无特殊说明传入“” 空字符串。

”“

返回参数

名称类型描述示例值
object

result

Messagestring

执行结果说明

success
RequestIdstring

执行链路追踪字符串,排查问题时,可以提供给平台。

UUID
Dataobject

data

HostIdstring

执行主机所在站点

cn
InstanceIdstring

实例 id

i-bp1etb69sqxgl4*******
Currencystring

币种

退款金额本币币种: CNY:人民币。 USD:美元。 JPY:日元。
RefundAmountdouble

金额

12.34
Codestring

响应码

200
Successboolean

success=true 代表调用执行完成。success=false 代表执行出现错误。

true

示例

正常返回示例

JSON格式

{
  "Message": "success",
  "RequestId": "UUID",
  "Data": {
    "HostId": "cn",
    "InstanceId": "i-bp1etb69sqxgl4*******",
    "Currency": "退款金额本币币种: CNY:人民币。 USD:美元。 JPY:日元。",
    "RefundAmount": 12.34
  },
  "Code": "200",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400ResourceNotExistsThe specific resource is not exists.-
400ResourceStatusErrorThe resource status error.-
400InvalidOwnerThe specified owner does not belong to caller.指定的所有者不属于调用方。
400InvalidParameterThe specified request contains invalid parameters.请求中包含无效参数。
400MissingParameterThe specified request lacks essential parameters.该请求缺少必要参数。
400NotApplicableThe specified API is not applicable for the user.此API不适用于调用方。
400NotAuthorizedThe user is not authorized for the specified API.此API未对该调用者进行授权。
400BindMirrorInstanceErrorCharged images that are related to ECS.-
400ExceedRefundQuotaErrorThe number of unsubscription times has reached the upper limit.-
400ExistUnPaidOrderErrorThe instance has an unsettled order.-
400ExistRefundingOrderErrorThe instance ID is invalid: the instance may have expired, been refunded, or been released.-
400NoRestValueErrorThe refund amount is 0.-
400AmbassadorOrderLimitErrorThe instance has an ambassador order that may raise risks.-
400ActivityForbiddenErrorPromotional orders do not support refunds.-
400ProductCheckErrorThe cloud service failed SPI preflight verification.-
400CommodityNotSupportedThe specified commodity is not supported.商品code无效
500InternalErrorAn error occurred in the internal server.-

访问错误中心查看更多错误码。

针对部分业务规则拦截返回的错误码的解释

  • ResourceNotExists:实例不存在
  • ResourceStatusError:实例状态不对
  • BindMirrorInstanceError:ecs 有关联的收费镜像
  • ExceedRefundQuotaError:退订次数超过 quota 配额上限
  • ExistUnPaidOrderError:实例下存在未支付订单
  • ExistRefundingOrderError:无效实例 ID(实例已到期或已退款或已释放)
  • NoRestValueError:退款金额为 0
  • AmbassadorOrderLimitError:实例下有云大使订单
  • ActivityForbiddenError:活动订单禁止退款
  • ProductCheckError:云产品规则预校验未通过
  • 本页导读 (0)
文档反馈