DeregisterManagedInstance - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

DeregisterManagedInstance を呼び出してホストインスタンスの登録を解除します。インスタンスの登録が解除されると、クラウドアシスタントを使用してコマンドやファイルをインスタンスに送信できなくなります。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DeregisterManagedInstance

update

*Instance。

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。サポートされているリージョンは次のとおりです。中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (ウランチャブ)、中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (河源)、中国 (広州)、中国 (成都)、中国 (香港)、シンガポール、日本 (東京)、米国 (シリコンバレー)、米国 (バージニア)。 DescribeRegions を呼び出して、リージョン ID などの情報を取得できます。	cn-hangzhou
InstanceId	string	必須	ホストインスタンスの ID。	mi-hz01axdfas****
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。ClientToken 値には ASCII 文字のみを使用でき、長さは 64 文字以下にする必要があります。詳細については、「べき等性を確保する方法」を参照してください。	123e4567-e89b-12d3-a456-426655440000

レスポンスフィールド

フィールド	型	説明	例
	object
Instance	object	ホストインスタンスの情報。
ActivationId	string	アクティベーションコードの ID。	4ECEEE12-56F1-4FBC-9AB1-890F7494****
AgentVersion	string	クラウドアシスタントエージェントのバージョン番号。	2.2.0.102
Hostname	string	ホストインスタンスのホスト名。	test-Hostname
InstanceId	string	ホストインスタンスの ID。	mi-hz01axdfas****
InstanceName	string	ホストインスタンス名。	test-InstanceName-001
InternetIp	string	ホストインスタンスのパブリック IP アドレス。	47.8..
IntranetIp	string	ホストインスタンスの内部 IP アドレス。	10.0..
InvocationCount	integer	ホストインスタンスでクラウドアシスタントタスクが実行された回数。	2
LastInvokedTime	string	最後のクラウドアシスタントタスクが実行された時間。時間は協定世界時 (UTC) の ISO 8601 初期化で表示されます。	2021-01-20T09:00:40Z
MachineId	string	ホストインスタンスのマシンコード。	e03231b37ab14e53b5795ad625fc****
OsType	string	ホストインスタンスのオペレーティングシステム。	linux
OsVersion	string	オペレーティングシステムのバージョン。	Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64
RegistrationTime	string	ホストインスタンスが登録された時間。時間は協定世界時 (UTC) の ISO 8601 初期化で表示されます。	2021-01-20T08:57:56Z
ResourceGroupId	string	ホストインスタンスが属するリソースグループの ID。	rg-123******
RequestId	string	リクエスト ID	4ECEEE12-56F1-4FBC-9AB1-890F74942176

例

成功レスポンス

JSONJSON

{
  "Instance": {
    "ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F7494****",
    "AgentVersion": "2.2.0.102",
    "Hostname": "test-Hostname",
    "InstanceId": "mi-hz01axdfas****",
    "InstanceName": "test-InstanceName-001",
    "InternetIp": "47.8.**.**",
    "IntranetIp": "10.0.**.**",
    "InvocationCount": 2,
    "LastInvokedTime": "2021-01-20T09:00:40Z",
    "MachineId": "e03231b37ab14e53b5795ad625fc****",
    "OsType": "linux",
    "OsVersion": "Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64",
    "RegistrationTime": "2021-01-20T08:57:56Z",
    "ResourceGroupId": "rg-123******"
  },
  "RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F74942176"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定されたリージョンでは API 呼び出しがサポートされていません。RegionId パラメーター値が正しいかどうかを確認してください。
400	InvalidClientToken.Malformed	The specified parameter clientToken is not valid.	指定された冪等パラメーターは無効です。
500	InternalError.Dispatch	An error occurred when you dispatched the request.	リクエストの送信中にエラーが発生しました。後でもう一度お試しください。
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	操作は許可されていません。
403	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.	リクエストパラメーターが、同じ ClientToken を持つリクエストと一致しません。
403	IdempotentProcessing	The previous idempotent request(s) is still processing.	直前の冪等リクエストはまだ処理中です。しばらくしてからもう一度お試しください。
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	指定された RegionId は存在しません。このリージョンでプロダクトが利用可能かどうかを確認してください。
404	InvalidInstance.NotFound	The specified instance id does not exist.	指定されたインスタンスが存在しません。

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

変更履歴

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