RefundInstance API によるインスタンスサブスクリプションのキャンセル - 课后管理

不要になったインスタンスのサブスクリプションをキャンセルするには、この操作を呼び出します。

操作説明

返金は、お支払いいただいた金額のみが対象となります。使用済みのクーポンは返金されません。
サブスクリプションをキャンセルする前に、リソース情報を確認し、返金の条件と金額を確認してください。サブスクリプションがキャンセルされると、リソースは回復できません。
この操作は、リセラーではなく、直接のお客様のみが呼び出すことができます。
詳細については、「国際サイトの返金ルール」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

bss:RefundBatchRemainRefund

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ClientToken	string	任意	クライアントが生成した汎用一意識別子（UUID）。リクエストのべき等性を確保するために使用されます。同じ ClientToken で複数の呼び出しを行った場合、システムは最初の呼び出しの結果を返します。呼び出しが成功すると、返金注文 ID が返されます。	793F021C-B589-1225-82A9-99232AEBE494
ImmediatelyRelease	string	任意	このパラメーターは、サブスクリプションの解除に必要です。有効な値：1：インスタンスはすぐにリリースされます。0：インスタンスは、停止ポリシーに従って最初に停止されます。この機能は一部のプロダクトでのみサポートされています。デフォルトでは、インスタンスはすぐにリリースされます。	1
ProductCode	string	任意	プロダクトコード。このパラメーターは、サブスクリプションの解除に必要です。エラーコードでプロダクトがサポートされていないことが示された場合は、チケットを送信してこの機能を有効にするようリクエストしてください。	ecs
InstanceId	string	任意	インスタンス ID 。これはカスタム名ではありません。このパラメーターは、サブスクリプションの解除に必要です。	i-bp1etb69sqxgl4*******
ProductType	string	任意	プロダクトタイプ。このパラメーターは、サブスクリプションの解除に必要です。特に指定のない限り、空の文字列を渡します。 API Explorer では、入力ボックスにマウスポインターを移動し、表示される [ボタン] をクリックすると、空の文字列が自動的に入力されます。コードからこの操作を呼び出すときは、空の文字列 "" を渡します。	”“

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	レスポンスオブジェクト。
Message	string	実行結果の説明。	success
RequestId	string	リクエスト ID 。トラブルシューティングのために、この ID をテクニカルサポートに提供できます。	UUID
Data	object	返されたデータ。
HostId	string	ホストが配置されているサイト。	cn
OrderId	integer	返金注文の ID 。このパラメーターは、サブスクリプションの解除が成功した場合にのみ返されます。	2100000000***
Code	string	レスポンスコード。	ResourceNotExists
Success	boolean	操作が成功したかどうかを示します。 `true`：操作は成功しました。 `false`：操作は失敗しました。	false

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。