ECS インスタンスのパスワード、インスタンス名、ホスト名、セキュリティグループ、MTU、インスタンスユーザーデータなどの一部のプロパティを変更します。
操作説明
セキュリティロック済みのインスタンスに対してこの操作を呼び出せません。詳細については、「リソースセキュリティロックが API 呼び出しに及ぼす影響」を参照してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:ModifyInstanceAttribute |
update |
*Instance。
SecurityGroup。
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID |
i-bp67acfmxazb4ph**** |
| Password |
string |
任意 |
インスタンスのパスワード。パスワードの長さは 8~30 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含む必要があります。サポートされている特殊文字は次のとおりです: ()`~!@#$%^&*-_+=|{}[]:;'<>,.?/。Windows インスタンスの場合、パスワードの先頭をスラッシュ (/) にすることはできません。次の点に注意してください。
説明
Password パラメーターを指定する場合は、パスワードの漏洩を防ぐために HTTPS を使用してリクエストを送信してください。 |
Test123456&$ |
| HostName |
string |
任意 |
オペレーティングシステムのホスト名。次の点に注意してください。
ホスト名には、オペレーティングシステムごとに次の制限があります。
|
testHostName |
| InstanceName |
string |
任意 |
インスタンスの名前。名前の長さは 2~128 文字です。先頭は文字にする必要があり、http:// または https:// で開始することはできません。名前には数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。 |
testInstanceName |
| Description |
string |
任意 |
インスタンスの説明。説明の長さは 2~256 文字で、http:// または https:// で開始することはできません。 |
testInstanceDescription |
| UserData |
string |
任意 |
インスタンスユーザーデータ。データを渡す前に Base64 エンコードすることを推奨します。次の点に注意してください。
説明
Base64 エンコーディング前の生データは 32 KB を超えることはできません。パスワードやプライベートキーなどの機密情報をプレーンテキストで渡さないでください。機密情報を渡す必要がある場合は、情報を暗号化し、Base64 エンコードしてから、インスタンス内で同じ方法で復号してください。 |
ZWNobyBoZWxsbyBlY3Mh |
| Recyclable |
boolean |
任意 |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
true |
| CreditSpecification |
string |
任意 |
バースト可能インスタンスの実行モード。有効な値:
バースト可能インスタンスの実行モードの詳細については、「バースト可能インスタンスの概要」を参照してください。 |
Standard |
| DeletionProtection |
boolean |
任意 |
インスタンスの削除保護属性。コンソールから、または DeleteInstance 操作を呼び出してインスタンスをリリースできるかどうかを指定します。 説明
この属性は、従量課金インスタンスにのみ適用されます。手動解放のみを防ぐことができ、システムによるリリースは防げません。 |
false |
| NetworkInterfaceQueueNumber |
integer |
任意 |
プライマリ ENI のキュー数。次の点に注意してください。
|
8 |
| SecurityGroupIds |
array |
任意 |
インスタンスが再割り当てされるセキュリティグループの ID。次の点に注意してください。
説明
変更は、変更後すぐにインスタンスに有効になりますが、わずかな遅延が発生する可能性があります。 |
sg-bp15ed6xe1yxeycg7o**** |
|
string |
任意 |
セキュリティグループの ID。 |
sg-bp15ed6xe1yxeycg7o**** |
|
| RemoteConnectionOptions |
object |
任意 |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
|
| Password |
string |
任意 |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
hide |
| Type |
string |
任意 |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
hide |
| EnableJumboFrame |
boolean |
任意 |
インスタンス MTU のジャンボフレーム機能を有効にするかどうかを指定します。有効な値:
次の点に注意してください。
|
false |
| CpuOptions.Core |
integer |
任意 |
CPU コア数。このパラメーターはカスタム値をサポートしておらず、デフォルト値のみ使用できます。 |
2 |
| CpuOptions.ThreadsPerCore |
integer |
任意 |
CPU コアあたりのスレッド数。ECS インスタンスの vCPU 数 = CpuOptions.Core の値 × CpuOptions.ThreadsPerCore の値。
|
2 |
| CpuOptions.TopologyType |
string |
任意 |
インスタンスの CPU トポロジータイプ。有効な値:
デフォルト値: none。 次の点に注意してください。
説明
このパラメーターをサポートするインスタンスファミリーは一部のみです。サポートされているインスタンスファミリーの詳細については、「CPU トポロジー構造の表示と変更」を参照してください。 |
DiscreteCoreToHTMapping |
| PrivateDnsNameOptions |
object |
任意 |
インスタンスの非公開ドメイン名構成。 非公開ドメイン名解決の詳細については、「ECS 非公開ドメイン名解決」を参照してください。 |
|
| EnableInstanceIdDnsARecord |
boolean |
任意 |
インスタンス ID ベースのドメイン名から IPv4 アドレスへの DNS A レコード解決を有効にするかどうかを指定します。有効な値:
デフォルト値: false。 |
false |
| EnableInstanceIdDnsAAAARecord |
boolean |
任意 |
インスタンス ID ベースのドメイン名から IPv6 アドレスへの DNS AAAA レコード解決を有効にするかどうかを指定します。有効な値:
デフォルト値: false。 |
false |
| EnableIpDnsARecord |
boolean |
任意 |
IP ベースのドメイン名から IPv4 アドレスへの DNS A レコード解決を有効にするかどうかを指定します。有効な値:
デフォルト値: false。 |
false |
| EnableIpDnsPtrRecord |
boolean |
任意 |
IPv4 アドレスから IP ベースのドメイン名への逆引き DNS PTR レコード解決を有効にするかどうかを指定します。有効な値:
デフォルト値: false。 |
false |
| HostnameType |
string |
任意 |
ホスト名タイプ。有効な値:
デフォルト値: Custom。 |
Custom |
| CpuOptions |
object |
任意 |
CPU オプション。 |
|
| NestedVirtualization |
string |
任意 |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 列挙値:
|
enabled |
| EnableNetworkEncryption |
boolean |
任意 |
VPC ネットワークトラフィックの暗号化を有効にするかどうかを指定します。有効な値:
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidInstanceName.Malformed | The specified parameter "InstanceName" is not valid. | 指定されたインスタンス名の形式は無効です。名前は 2~128 文字で、英字または漢字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。また、http:// または https:// で始めることはできません。 |
| 400 | InvalidDescription.Malformed | The specified parameter "Description" is not valid. | 指定されたリソースの説明の形式が無効です。説明は 2 ~ 256 文字で、http:// または https:// で始めることはできません。 |
| 400 | InvalidRemoteConnectionOptions.Password | The remote connection password is invalid. | |
| 400 | InvalidRemoteConnectionOptions.Type | The remote connection type is invalid. | |
| 400 | InstanceType.ValueNotSupported | The instance type not supported. | |
| 400 | OSType.ValueNotSupported | The OS type is not supported. | |
| 400 | InvalidHostPassword.Malformed | The specified parameter "Password" is not valid. | |
| 400 | InvalidHostName.Malformed | The specified parameter "HostName" is not valid. | 指定された HostName パラメーターは無効です。 |
| 400 | InvalidPassword.Malformed | The specified parameter "Password" is not valid. | 指定された Password パラメーターは無効です。 |
| 400 | InvalidUserData.SizeExceeded | The specified parameter "UserData" exceeds the size. | |
| 400 | InvalidUserData.NotSupported | TThe specified parameter "UserData" only support the vpc and IoOptimized Instance. | |
| 400 | ImageNotSupportCloudInit | The specified image does not support cloud-init. | 指定されたイメージは CloudInit をサポートしていません。 |
| 400 | ChargeTypeViolation | Pay-As-You-Go instances do not support this operation. | |
| 400 | InvalidParameter.RecycleBin | You do not have permission to set recyclable properties. | この操作を実行する権限がありません。 |
| 400 | InvalidParameter.CreditSpecification | The specified CreditSpecification is not supported in this region. | 指定されたバースト可能インスタンスの実行中モードは、このリージョンではサポートされていません。 |
| 400 | InvalidInstanceStatus.CreditSpecRestricted | The current status of the resource does not support this operation. | 現在のリソースの状態では、この操作はサポートされていません。 |
| 400 | InvalidInstanceStatus.NotRunning | The current status of the resource is invalid, you can only do this operation when instance is running. | 現在のインスタンスステータスでは、この操作はサポートされていません。インスタンスステータスが Running のときにこの操作を実行してください。 |
| 400 | InvalidNetworkType.NotSupported | The classic networkType does not support to modify security group | |
| 400 | InvalidOperation.EniCountExceeded | =The maximum number of eni in a enterprise security group is exceeded. | |
| 400 | JoinedGroupLimitExceed | %s | 指定されたリソースが参加できるセキュリティグループの最大数に達しました。詳細については、エラーメッセージ内の %s プレースホルダーの実際の返却結果を参照してください。 |
| 400 | InvalidParameter | The specified parameter is not valid. | 現在のリクエストパラメーターが無効です。もう一度お試しください。 |
| 400 | InvalidOperation.InvalidEcsState | %s | 現在のクラウドサービスのサービスステータスでは、この操作は許可されていません。 |
| 400 | InvalidParam.NotSupportJumboFrame | Not support jumbo frame. | |
| 400 | InvalidOperation.InstanceStatusNotSupport | The instance status is not support modify mtu config. | |
| 400 | InvalidOperation.InstanceStatusUnsupported | The specified instance status does not support modification of cpu topology type. | 現在のインスタンスステータスでは、CPU トポロジータイプの変更はサポートされていません。 |
| 400 | InvalidParameter.CpuOptionsTopologyType | The specified parameter CpuOptions.TopologyType: %s is not valid. | 指定された CPU トポロジータイプの値は無効です。 |
| 400 | InvalidInstanceType.NotSupportCpuOptionsTopologyType | The specified instance type does not support CpuOptions.TopologyType: %s. | 現在のインスタンスタイプでは、指定された CPU トポロジータイプはサポートされていません。 |
| 400 | InvalidAdditionalInfoPvdConfig.SizeExceeded | The specified parameter AdditionalInfo.PvdConfig exceeds the size. | |
| 400 | InvalidInstanceType.NotSupportHighDensityMode | The specified instance type does not support the use of the high density mode. | 現在のインスタンスタイプでは、高密度ディスクモードはサポートされていません。 |
| 400 | InvalidStatus.StoppedRequired | The current state of the resource does not support this operation, it can only be operated in a stopped state. | リソースの現在の状態では、この操作はサポートされていません。リソースは Stopped 状態である必要があります。 |
| 400 | InvalidParameter.CpuOptionsTurboMode | The specified parameter TurboMode is not valid. | 指定された周波数モードパラメーターが無効です。 |
| 400 | InvalidInstanceType.EnableNVSUnsupported | The specified instance type does not support EnableNVS. | 指定されたインスタンスタイプでは、NVS 機能の有効化はサポートされていません。 |
| 400 | InvalidInstanceType.EnableVISSTUnsupported | The specified instance type does not support EnableVISST. | 指定されたインスタンスタイプでは、VISST 機能の有効化はサポートされていません。 |
| 400 | InvalidInstanceType.EnableVRDTUnsupported | The specified instance type does not support EnableVRDT. | 指定されたインスタンスタイプでは、VRDT 機能の有効化はサポートされていません。 |
| 400 | InvalidInstanceType.SingleCoreMaxModeUnsupported | The specified instance type does not support TurboMode: "SINGLE CORE MAX". | 指定されたインスタンスタイプでは、シングルコア最大値ターボ周波数モードの有効化はサポートされていません。 |
| 400 | InvalidInstanceType.GpuOptionsConfidentialComputingUnsupported | The specified instance type does not support the confidential computing mode. | |
| 400 | InvalidParameter.GpuOptionsConfidentialComputing | The specified parameter confidential computing mode is not valid. | インスタンスの GPU で暗号化するコンピューティングモードの列挙値は無効です。 |
| 400 | InvalidParameterAuthorized.GpuOptionsConfidentialComputing | The specified parameter confidential computing mode is unauthorized. | インスタンスに対して指定された GPU で暗号化するコンピューティングモードのパラメーター値は許可されていません。 |
| 400 | InvalidParameter.CpuOptionsNestedVirtualization | The specified parameter CpuOptions.NestedVirtualization: %s is not valid. | |
| 400 | InvalidInstanceType.NotSupportCpuOptionsNestedVirtualization | The specified instance type does not support CpuOptions.NestedVirtualization: %s. | 現在のインスタンスタイプでは、指定された入れ子になった仮想化機能はサポートされていません。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | |
| 403 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | ディスクがアタッチされているインスタンスは、セキュリティ上の理由によりロック済みです。 |
| 403 | OperationDenied | The instance amount in the specified SecurityGroup reach its limit. | 指定されたスナップショットではデータボリュームの作成が許可されていません。 |
| 403 | InvalidUserData.Forbidden | User not authorized to input the parameter "UserData"please apply for permission "UserData" | |
| 403 | InvalidUserData.Base64FormatInvalid | The specified UserData is not valid | 指定された UserData は無効です。 |
| 403 | InvalidChargeType.ValueNotSupported | Deletion protection is only valid for postPaid instance, not for prePaid or spot instance. | インスタンスの支払い方法では、指定された操作はサポートされていません。 |
| 403 | InvalidUser.Unauthorized | The user is not authorized | 現在のアカウントには、必須の権限がありません。 |
| 403 | EnterpriseGroupLimited.MutliGroupType | The specified instance can not join multi SecurityGroup types. | 指定されたインスタンスを、カスタムセキュリティグループと高度なセキュリティグループの両方に同時に追加することはできません。DescribeSecurityGroups を呼び出して、指定されたセキュリティグループのタイプを照会できます。 |
| 403 | SecurityGroupInstanceLimitExceed | %s | セキュリティグループ内のインスタンスの最大値に達しました。 |
| 403 | InstanceNotInSecurityGroup | The instance not in the group. | |
| 403 | InvalidOperation.InvalidRegion | %s | |
| 403 | InvalidOperation.ResourceManagedByCloudProduct | %s | クラウドサービスのマネージドセキュリティグループは変更操作をサポートしていません。 |
| 403 | InvalidParameter.InvalidEniQueueNumber | %s | Elastic Network Interface (ENI) キューの数が正しくありません。詳細については、エラーメッセージ内の %s プレースホルダーの実際の返却結果を参照してください。 |
| 403 | InvalidOperation.MaxEniQueueNumberExceeded | %s | Elastic Network Interface (ENI) キューの数が上限を超えています。詳細については、エラーメッセージ内の %s プレースホルダーの実際の返却結果を参照してください。 |
| 403 | InvalidOperation.ExceedInstanceTypeQueueNumber | %s | Elastic Network Interface (ENI) キューの合計数が上限を超えています。詳細については、エラーメッセージ内の %s プレースホルダーの実際の返却結果を参照してください。 |
| 403 | InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode | %s | 指定されたインスタンスのインスタンスタイプは、RDMA モードの ENI をサポートしていません。 |
| 403 | InvalidParameter.InvalidQueuePairNumber | %s | |
| 403 | InvalidOperation.MaxEniQueuePairNumberExceed | %s | |
| 403 | InvalidOperation.EniQueuePairNumberOverflow | %s | |
| 403 | AclLimitExceed | %s | ENI またはインスタンスのセキュリティグループルールの数がクォータを超えています。 |
| 403 | InvalidInstanceType.CpuOptionsThreadsPerCoreUnsupported | The current instance type does not support setting or modifying the CpuOptions.ThreadsPerCore parameter. | 現在のインスタンスタイプでは、CpuOptions.ThreadsPerCore パラメーターの設定または変更はサポートされていません。 |
| 403 | InvalidParameter.CpuOptionsCore | The specified parameter CpuOptions.Core is not valid. | CpuOptions.Core パラメーターは無効です。 |
| 403 | InvalidParameter.CpuOptionsThreadsPerCore | The specified parameter CpuOptions.ThreadsPerCore is not valid. | CpuOptions.ThreadsPerCore パラメーターは無効です。 |
| 403 | InvalidOperation.UserNotSupportNetworkEncryption | User not support network encryption. | 現在のユーザーはネットワークトラフィックを暗号化するパラメーターの指定をサポートしていません。 |
| 403 | InvalidOperation.InstanceTypeNotSupportNetworkEncryption | The specified instance type does not support network encryption. | 指定されたインスタンスタイプは VPC トラフィックを暗号化することをサポートしていません。 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定されたインスタンスが存在しません。インスタンス ID が正しいかどうかを確認してください。 |
| 404 | InvalidSecurityGroupId.NotFound | The specified SecurityGroupId does not exist. | 指定されたセキュリティグループはアカウント配下に存在しません。セキュリティグループ ID が正しいかどうかを確認してください。 |
| 404 | Credit.NotFound | The specified credit information does not exist. | 指定されたバースト可能インスタンスの CPU クレジット情報が存在しません。 |
| 404 | InvalidInstanceStatus.NeedRestart | The current status of the resource is invalid, you can only do this operation after instance is restarted. | |
| 404 | InvalidParameter.SecurityGroupIdRepeated | The specified security group ids has repeated. | 指定されたセキュリティグループはすでに追加されています。SecurityGroupIds パラメーター値が正しいかどうかを確認してください。 |
| 404 | InvalidSecurityGroupType.NotSupportClassic | The specified SecurityGroupIds have classic group type. | 指定されたセキュリティグループのネットワークタイプはクラシックネットワークです。SecurityGroupIds パラメーター値が正しいかどうかを確認してください。 |
| 404 | InvalidSecurityGroupVpc.NotBelongToOneVpc | The specified SecurityGroupIds are belong to different vpc. | 指定されたセキュリティグループ ID は異なる VPC に属しています。SecurityGroupIds パラメーター値が正しいかどうかを確認してください。DescribeSecurityGroups を呼び出して、指定されたセキュリティグループが属する VPC をクエリできます。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。