全部產品
Search

搜尋本產品

    Expenses and Costs：RefundInstance - 退訂執行個體

    文件中心

    Expenses and Costs：RefundInstance - 退訂執行個體

    更新時間：Aug 20, 2025

    調用本介面退訂不再需要的執行個體。

    介面說明

    1. 退訂只退還實付金額的部分，已使用的代金券不退還。

    2. 請仔細核對退訂資源的資訊，並確認退訂條款和退訂金額，資源一經退訂無法恢複。

    3. 該介面僅支援直銷客戶調用，分銷客戶無法使用。

    4. 其他問題請參照：國際站退訂規則說明

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    bss:RefundBatchRemainRefund

    update

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ClientToken

    string

    否

    需要等冪情境必填。UUID 產生的字串。此欄位用於等冪，多次調用傳入同樣的值，會返回第一次的結果。調用後如果返回了結果，可以解析到退款訂單編號，代表調用成功。

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

    string

    否

    退訂情境必填。1：標識立即釋放。0：標識先停機，根據停機策略停機。僅部分商品支援。預設都是立即釋放。

    1
    ProductCode

    string

    否

    退訂情境必填，產品 code。如果調用後錯誤碼提示產品不支援，可提交工單申請雲產品允許開通此功能。

    ecs
    InstanceId

    string

    否

    退訂情境必填，執行個體 id，非自訂名稱。

    i-bp1etb69sqxgl4*******
    ProductType

    string

    否

    退訂情境必填，產品類型，無特殊說明傳入Null 字元串。在調試工具上，無需手動輸入，滑鼠放到輸入框上，會彈出"輸入Null 字元串"的按鈕，點擊此按鈕即可。通過代碼發起退訂時，傳入英文字元下的Null 字元串 ""。

    Null 字元串

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    result

    Message

    string

    執行結果說明

    success
    RequestId

    string

    執行鏈路追蹤字串，排查問題時，可以提供給平台。

    UUID
    Data

    object

    data

    HostId

    string

    執行主機所在網站

    cn
    OrderId

    integer

    退訂成功的情況下，返回退款訂單 id

    2100000000***
    Code

    string

    響應碼

    ResourceNotExists
    Success

    boolean

    success=true 代表調用執行完成。success=false 代表執行出現錯誤。

    false

    樣本

    正常返回樣本

    JSON格式

    {
  "Message": "success",
  "RequestId": "UUID",
  "Data": {
    "HostId": "cn",
    "OrderId": 0
  },
  "Code": "ResourceNotExists",
  "Success": false
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ResourceNotExists The specific resource is not exists.
    400 ResourceStatusError The resource status error.
    400 InvalidOwner The specified owner does not belong to caller.
    400 InvalidParameter The specified request contains invalid parameters.
    400 MissingParameter The specified request lacks essential parameters.
    400 NotApplicable The specified API is not applicable for the user.
    400 NotAuthorized The user is not authorized for the specified API.
    400 BindMirrorInstanceError Charged images that are related to ECS.
    400 ExceedRefundQuotaError The number of unsubscription times has reached the upper limit.
    400 ExistUnPaidOrderError The instance has an unsettled order.
    400 ExistRefundingOrderError The instance ID is invalid: the instance may have expired, been refunded, or been released.
    400 NoRestValueError The refund amount is 0.
    400 AmbassadorOrderLimitError The instance has an ambassador order that may raise risks.
    400 ActivityForbiddenError Promotional orders do not support refunds.
    400 ProductCheckError The cloud service failed SPI preflight verification.
    400 CommodityNotSupported The specified commodity is not supported.
    500 InternalError An error occurred in the internal server. 系統異常，請重試

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。