この操作を実行することで、ECS インスタンスの情報 (パスワード、名前、説明、ホスト名、ユーザーデータなど) を変更することができます。 バースト可能なインスタンス (t5) の場合は、実行モードも変更可能です。

説明

本インターフェイスを呼び出す際は次の点に留意してください。

  • インスタンスが 起動中 (Starting) の状態の場合、パスワードをリセットすることはできません。
  • ECS インスタンスの Security Control が有効化されている場合、OperationLocksは"LockReason" : "security"でタグすることはできません。
  • パスワードのリセット後、コンソールからインスタンスを再起動するか、または RebootInstance を呼び出して変更内容を検証します。 インスタンス内で再起動の操作をしても変更内容の検証はされません。
  • インスタンスが停止 (Stopped) の状態で、且つ、ユーザーデータ の要件を満たしている場合はユーザーデータの変更が可能です。

デバッグ

API Explorer でデバッグを実行できます。 API Explorer で各種操作を行い API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成などができます。

リクエストパラメーター

名前 データ型 必須 例 説明
InstanceId String Yes i-instance1

インスタンスの ID。

Action String No ModifyInstanceAttribute

実行する操作です。 値を ModifyInstanceVpcAttribute に設定します。

CreditSpecification String No Standard

バースト可能なインスタンスの実行モード (t5)。 有効値：

既定値 : NULL。
DeletionProtection Boolean No false

インスタンスのリリース保護の属性。 ECS コンソールでインスタンスのリリースが可能か、または DeleteInstance 操作でインスタンスのリリースが可能かを示します。

既定値 : NULL。

注 この属性は従量課金のインスタンスに適用可能です。 手動のリリース操作をブロックする際に使用できます。システムによる自動リリース操作はブロックできません。
Description String No InstanceAttribute

インスタンスの説明です。 長さは 2 ～ 256 文字である必要があります。 先頭文字列を http:// または https:// にすることはできません。

既定値 : NULL。

HostName String No LocalHost

インスタンスのホスト名

  • 文頭および文末をピリオド (.) やハイフン (-) にすることはできません。 ピリオド (.) やハイフン (-) は2 つ以上連続して使用することはできません。
  • Windows の場合：ホスト名にピリオド (.) は使用できません。また、数字のみの使用はできません。 長さは 2～15 文字である必要があります。大文字、小文字、数字、ハイフン (-) が使用可能です。
  • その他のオペレーティングシステムの場合：ホスト名はピリオド (.) で区切ることができます。 長さは 2～64 文字である必要があります。大文字、小文字、数字、ハイフン (-) が使用可能です。
InstanceName String No EcsInstance

インスタンスの名前。 長さは 2 ～128 文字である必要があります。 先頭は文字である必要があります。 先頭文字列を http:// または https:// にすることはできません。 大文字、小文字、数字、コロン (:) 、アンダースコア (_)、ハイフン (-) が使用可能です。

OwnerAccount String No ECSforCloud@Alibaba.com

RAM ユーザーのログインネーム。

パスワード String No EcsV587!

インスタンスのパスワード。

注 Password が指定されている場合は、パスワードを機密に管理するために HTTPS プロトコルでリクエストを送信することを推奨します。

長さは 8～30 文字である必要があります。大文字、小文字、数字、特殊文字が使用可能です。 Windows の場合、パスワードをスラッシュ (/) で始めることはできません。 以下の記号が使用可能です。 


括弧 (())、チルダ (~)、感嘆符 (!)、アットマーク (@)、シャープ記号 (#)、ドル記号 ($)、パーセント記号 (%)、キャレット (^) 、アンパサンド (&)  、アスタリスク (*) 、ハイフン ( - ) 、アンダースコア (_) 、プラス記号 (+) 、 等号 (=) 、垂直バー (|) 、中括弧 ({}) 、大括弧 ([]) 、コロン (:) 、セミコロン (;) 、シャープアクセント ( '>) 、山括弧 (<>) 、コンマ (,) 、ピリオド (.) 、疑問符 (?) 、スラッシュ (/) 、アクセント記号 (') 。
Recyclable Boolean No false

インスタンスがリサイクル可能かを示します。

UserData String No echo hello ecs!

インスタンスのユーザーデータ。 ユーザーデータは Base64 でエンコードされています。 UserData のサイズは 16 KB 未満である必要があります。 ユーザーデータはプレーンテキストモードでインポートされるため、パスワードやキーなどの機密情報のインポートは推奨しません。 機密情報が必要な場合は、インポートする前に暗号化して Base64 でエンコードすることを推奨します。 同じ方法で復号化を実行します。

レスポンスパラメーター

名前 データ型 例 説明
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエスト ID。 API 操作の結果にかかわらず、各 API リクエストに対してシステムから固有の RequestId が返されます。

例

リクエストの例


https://ecs.aliyuncs.com/?Action=ModifyInstanceAttribute
/？ &InstanceId=i-instance1
&Action=ModifyInstanceAttribute
&CreditSpecification=Standard
&DeletionProtection = false
&Description = InstanceAttribute
&HostName = LocalHost
&InstanceName = EcsInstance
&Password=EcsV587!
&Recyclable=
&UserData=echo hello ecs!
&<Common request parameters>

通常のレスポンスの例

XML 形式 

<ModifyInstanceAttributeResponse>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId> 
</ModifyInstanceAttributeResponse>

JSON 形式 

{
	"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 InvalidHostName.Malformed 指定されたパラメーター "HostName" は無効です。 指定された HostName の形式が無効の場合に表示されるエラーメッセージ。
403 IncorrectInstanceStatus リソースの現行ステータスでは、この操作を実行できません。 リソースの現行ステータスでは該当の操作がサポートされていない場合に表示されるエラーメッセージ。
404 InvalidSecurityGroupId.NotFound 指定された SecurityGroupId は存在しません。 指定された SecurityGroupId がアカウントに存在しない場合に表示されるエラーメッセージ。 SecurityGroupId が正しいか確認してください。
403 OperationDenied 指定された SecurityGroup のインスタンス数が上限に達しています。 指定されたセキュリティグループ内のインスタンスの最大数に達した場合に表示されるエラーメッセージ。
403 OperationDenied リソースの現行ステータスでは、この操作を実行できません。 リソースの現行ステータスでは該当の操作がサポートされていない場合に表示されるエラーメッセージ。
403 InvalidUserData.Forbidden-US パラメーター "UserData" を入力する権限が付与されていません。権限 "UserData" を申請してください。 UserData を設定する権限がない場合に表示されるエラーメッセージ。 先に権限を申請してください。
400 InvalidUserData.NotSupported 指定されたパラメーター "UserData" は、vpc および I/O 最適化インスタンスのみをサポートしています。 指定された UserData が VPC タイプまたは最適化インスタンスのみでサポートされている場合に表示されるエラーメッセージ。
400 InvalidUserData.NotSupported 指定されたパラメーター "UserData" は、vpc および I/O 最適化インスタンスのみをサポートします。 指定された UserData が VPC タイプまたは最適化インスタンスのみでサポートされている場合に表示されるエラーメッセージ。
400 InvalidParameter.RecycleBin リサイクル可能なプロパティを設定する権限がありません。 該当の操作を実行する権限が付与されていない場合に表示されるエラーメッセージ。
400 InvalidParameter.CreditSpecification 指定された CreditSpecification はこのリージョンではサポートされていません。 指定された CreditSpecification がこのリージョンでサポートされていない場合に表示されるエラーメッセージ。
400 InvalidInstanceStatus.CreditSpecRestricted リソースの現行ステータスでは、この操作を実行できません。 リソースの現行ステータスでは該当の操作がサポートされていない場合に表示されるエラーメッセージ。
400 InvalidInstanceStatus.NotRunning リソースの現在のステータスは無効です。インスタンスが実行中のみこの操作を実行できます。 リソースの現在のステータスが無効な場合に表示されるエラーメッセージ。

エラーコードの表示