RefundInstance：調(diào)用本接口退訂不再需要的實(shí)例。
接口說明
- 退訂只退還實(shí)付金額的部分，已使用的代金券不退還。
- 請(qǐng)仔細(xì)核對(duì)退訂資源的信息，并確認(rèn)退訂條款和退訂金額，資源一經(jīng)退訂無法恢復(fù)。
- 其他問題請(qǐng)參照：退訂規(guī)則
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| bss:RefundBatchRemainRefund | update | *全部資源 * |
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 需要冪等場景必填。UUID 生成的字符串。此字段用于冪等，多次調(diào)用傳入同樣的值，會(huì)返回第一次的結(jié)果。調(diào)用后如果返回了結(jié)果，可以解析到退款訂單編號(hào)，代表調(diào)用成功。 | 793F021C-B589-1225-82A9-99232AEBE494 |
| ImmediatelyRelease | string | 否 | 退訂場景必填。1：標(biāo)識(shí)立即釋放。0：標(biāo)識(shí)先停機(jī)，根據(jù)停機(jī)策略停機(jī)。僅部分商品支持。默認(rèn)都是立即釋放。 | 1 |
| ProductCode | string | 否 | 退訂場景必填，產(chǎn)品 code。如果調(diào)用后錯(cuò)誤碼提示產(chǎn)品不支持，可提交工單申請(qǐng)?jiān)飘a(chǎn)品允許開通此功能。 | ecs |
| InstanceId | string | 否 | 退訂場景必填，實(shí)例 id，非自定義名稱。 | i-bp1etb69sqxgl4******* |
| ProductType | string | 否 | 退訂場景必填，產(chǎn)品類型，無特殊說明傳入空字符串。在調(diào)試工具上，無需手動(dòng)輸入，鼠標(biāo)放到輸入框上，會(huì)彈出"輸入空字符串"的按鈕，點(diǎn)擊此按鈕即可。通過代碼發(fā)起退訂時(shí)，傳入英文字符下的空字符串 ""。 | 空字符串 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"Message": "success",
"RequestId": "UUID",
"Data": {
"HostId": "cn",
"OrderId": 0
},
"Code": "ResourceNotExists",
"Success": false
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | ResourceNotExists | The specific resource is not exists. | - |
| 400 | ResourceStatusError | The resource status error. | - |
| 400 | InvalidOwner | The specified owner does not belong to caller. | 指定的所有者不屬于調(diào)用方。 |
| 400 | InvalidParameter | The specified request contains invalid parameters. | 請(qǐng)求中包含無效參數(shù)。 |
| 400 | MissingParameter | The specified request lacks essential parameters. | 該請(qǐng)求缺少必要參數(shù)。 |
| 400 | NotApplicable | The specified API is not applicable for the user. | 此API不適用于調(diào)用方。 |
| 400 | NotAuthorized | The user is not authorized for the specified API. | 此API未對(duì)該調(diào)用者進(jìn)行授權(quán)。 |
| 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. | 商品code無效 |
| 500 | InternalError | An error occurred in the internal server. | 系統(tǒng)異常，請(qǐng)重試 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|
針對(duì)部分業(yè)務(wù)規(guī)則攔截返回的錯(cuò)誤碼的解釋
- ResourceNotExists：實(shí)例不存在
- ResourceStatusError：實(shí)例狀態(tài)不對(duì)
- BindMirrorInstanceError：ecs 有關(guān)聯(lián)的收費(fèi)鏡像
- ExceedRefundQuotaError：退訂次數(shù)超過 quota 配額上限
- ExistUnPaidOrderError：實(shí)例下存在未支付訂單
- ExistRefundingOrderError：無效實(shí)例 ID(實(shí)例已到期或已退款或已釋放)
- NoRestValueError：退款金額為 0
- AmbassadorOrderLimitError：實(shí)例下有云大使訂單
- ActivityForbiddenError：活動(dòng)訂單禁止退款
- ProductCheckError：云產(chǎn)品規(guī)則預(yù)校驗(yàn)未通過