ECS で使用可能な API 操作については、下表をご参照ください。
インスタンス
操作 | 説明 |
---|---|
RunInstances | 1 つまたは複数の従量課金またはサブスクリプション ECS インスタンスを作成します。 |
CreateInstance | ECS インスタンスを作成します。 |
DescribeInstances | 1 つまたは複数の ECS インスタンスの詳細を照会します。 |
StartInstance | ECS インスタンスを起動します。 |
RebootInstance | ECS インスタンスを再起動します。 |
StopInstance | ECS インスタンスを停止します。 |
DeleteInstance | 有効期限が切れる、従量課金のインスタンスまたはサブスクリプションの ECS インスタンスをリリースします。 |
AttachInstanceRamRole | 1 つまたは複数の ECS インスタンスに RAM ロールをアタッチします。 いつでも各 ECS インスタンスには RAM ロールを 1 件のみアタッチすることができます。 インスタンスに RAM ロールがすでにアタッチされている場合は、同じインスタンスに別の RAM ロールをアタッチすることはできないため、エラーコードが返されます。 |
DetachInstanceRamRole | 1 つまたは複数の ECS インスタンスから RAM ロールをデタッチします。 |
DescribeInstanceStatus | 複数の ECS インスタンスの状態を取得します。 |
RenewInstance | サブスクリプション ECS インスタンスを更新します。 |
ReactivateInstances | 料金滞納で停止状態になっているか、または有効期限が切れた従量課金 ECS インスタンスを再起動します。 |
RedeployInstance | インスタンスがイベント通知を受信した際に ECS インスタンスを再デプロイします。 |
DescribeInstanceVncUrl | ECS インスタンスの Web 管理端末の URL を照会します。 |
DescribeUserData | ECS インスタンスのユーザーデータを照会します。 |
DescribeInstanceAutoRenewAttribute | 1 つまたは複数のサブスクリプション ECS インスタンスの自動更新ステータスを照会します。 |
DescribeInstanceRamRole | 1 つまたは複数の ECS インスタンスにアタッチされている RAM ロールを照会します。 |
DescribeSpotPriceHistory | プリエンプティブインスタンスの過去 30 日間の料金履歴を照会します。 |
DescribeInstanceTypeFamilies | ECS が提供するインスタンスタイプファミリーを照会します。 |
DescribeInstanceTypes | ECS が提供するインスタンスタイプリストを照会します。 |
ModifyInstanceVpcAttribute | ECS インスタンスの VPC 属性を変更します。 |
ModifyInstanceAttribute | ECS インスタンスの情報 (パスワード、名前、説明、ホスト名、ユーザーデータなど) を変更します。 バースト可能なインスタンス (t5) の場合は、実行モードも変更可能です。 |
ModifyInstanceVncPasswd | ECS インスタンスの Web 管理端末パスワードを変更します。 |
ModifyInstanceAutoReleaseTime | 従量課金の ECS インスタンスの自動リリース時間を設定またはキャンセルします。 インスタンスは有効期限が切れると自動的にリリースされるため、自動リリース時間を設定する際はご注意ください。 |
ModifyInstanceAutoRenewAttribute | 1 つまたは複数のサブスクリプション ECS インスタンスを自動更新ステータスに設定します。 インスタンスの有効期限が切れた際のメンテナンスに要するワークロード低減のため、サブスクリプション ECS インスタンスの自動更新を設定することができます。 |
ModifyInstanceChargeType | 1 つまたは複数の ECS インスタンスの課金方法を変更します。 従量課金とサブスクリプション間で課金方法を切り替えたり、インスタンスにアタッチされているすべての従量課金データディスクをサブスクリプションディスクに変更することもできます。 |
ModifyInstanceSpec | 従量課金の ESC インスタンスのパブリック帯域幅またはインスタンスタイプを変更します。 |
ModifyPrepayInstanceSpec | サブスクリプション ECS インスタンスのタイプを変更します。 新しいインスタンスタイプは、インスタンスの全ライフサイクルに対して有効になります。 |
起動テンプレート
操作 | 説明 |
---|---|
CreateLaunchTemplate | ECS インスタンス起動テンプレート (略:起動テンプレート) を作成します。 インスタンス起動テンプレートを使用すると、インスタンス作成時に多数のパラメーターをその都度設定する必要がなくなります。 |
CreateLaunchTemplateVersion | 指定された ECS インスタンス起動テンプレートの新しいバージョンを作成します。 |
DeleteLaunchTemplate | ECS インスタンス起動テンプレートを削除します。 |
DeleteLaunchTemplateVersion | ECS インスタンス起動テンプレートの 1 つのバージョンを削除します。 この操作では、ECS インスタンス起動テンプレートのデフォルトバージョンは削除されません。 デフォルトバージョンを削除するには、DeleteLaunchTemplate を実行する必要があります。 |
DescribeLaunchTemplates | 1 つまたは複数の ECS インスタンス起動テンプレートを照会します。 |
DescribeLaunchTemplateVersions | 1 つまたは複数の ECS インスタンス起動テンプレートバージョンを照会します。 |
ModifyLaunchTemplateDefaultVersion | ECS インスタンス起動テンプレートのデフォルトバージョンを変更します。 ECS インスタンスの作成 (RunInstances) 時にテンプレートのバージョン番号の指定がない場合、デフォルトのバージョンが使用されます。 |
自動事前設定グループ
操作 | 説明 |
---|---|
CreateAutoProvisioningGroup | 自動事前設定グループを作成します。 |
ModifyAutoProvisioningGroup | 自動事前設定グループの設定を変更します。 |
DeleteAutoProvisioningGroup | 自動事前設定グループを削除します。 |
DescribeAutoProvisioningGroups | 自動事前設定グループを照会します。 |
DescribeAutoProvisioningGroupInstances | 自動事前設定グループの ECS インスタンスを照会します。 |
DescribeAutoProvisioningGroupHistory | 自動事前設定グループのスケジューリングタスクを照会します。 |
ディスク
操作 | 説明 |
---|---|
CreateDisk | 従量課金またはサブスクリプションのデータディスクを作成します。 ベーシックディスク、ウルトラディスク、SSD ディスク、または ESSD ディスクを作成できます。 |
DeleteDisk | 従量課金のデータディスクをリリースします。 ベーシックディスク、ウルトラディスク、または SSD ディスクをリリースすることができます。 |
DescribeDisk | 作成したディスクを照会します。 |
AttachDisk | データディスクを ECS インスタンスにアタッチします。 |
DetachDisk | ECS インスタンスから従量課金ディスクをデタッチします。 ベーシックディスク、ウルトラディスク、または SSD ディスクをデタッチすることができます。 |
ModifyDiskChargeType | ECS インスタンスにアタッチされている、最大 16 個のディスクの課金方法を変更します。 |
ModifyDiskAttribute | ディスクの属性を変更します。 |
ReplaceSystemDisk | ECS インスタンスのシステムディスクまたはオペレーティングシステムを置き換えます。 |
ReInitDisk | ディスクを初期状態にリセットします。 |
ResetDisk | 履歴ディスクスナップショットの 1 つを使用して、指定のディスク状態へディスクをロールバックします。 |
ResizeDisk | クラウドディスクのサイズを変更します。 システムディスクとデータディスクの両方のサイズを変更できます。 |
ModifyDiskSpec | ESSD ディスクのパフォーマンスレベルをアップグレードします。 |
リザーブドインスタンス
操作 | 説明 |
---|---|
PurchaseReservedInstancesOffering | 従量課金の ECS インスタンスの CPU およびメモリ使用料の支払いのためのリザーブドインスタンスを購入します。 |
DescribeReservedInstances | 購入したリザーブドインスタンスを照会します。 |
ModifyReservedInstances | リザーブドインスタンスを変更します。 |
イメージ
操作 | 説明 |
---|---|
ExportImage | カスタムイメージと同じリージョンの OSS バケットにカスタムイメージをエクスポートします。 |
CreateImage | カスタムイメージを作成します。 作成されたイメージを使用して、ECS インスタンスの作成 (RunInstances)、システムディスクの置き換え (ReplaceSystemDisk) ができます。 |
ImportImage | ローカルに保存されているイメージファイルを Alibaba Cloud ECS にインポートします。 該当イメージは、対応するリージョンにカスタムイメージとして表示されます。 |
CopyImage | ひとつのリージョンから別のリージョンへカスタムイメージをコピーします。 コピーされたイメージを使用して、ECS インスタンスの作成 (RunInstances)、別リージョンのシステムディスクの置き換え (ReplaceSystemDisk) ができます。 |
CancelCopyImage | 進行中の CopyImage 操作をキャンセルします。 |
DescribeImages | 利用可能なイメージリソースを照会します。 |
DeleteImage | 指定されたカスタムイメージを削除します。 |
DescribeImageSharePermission | カスタムイメージの共有先のアカウントを照会します。 レスポンスは複数のページ上に表示可能です。 デフォルトでは、各ページにエントリが 10 件ずつ表示されます。 |
ModifyImageAttribute | カスタムイメージの名前および説明を変更します。 |
ModifyImageSharePermission | カスタムイメージの共有先のアカウントを管理します。 カスタムイメージを別の Alibaba Cloud アカウントへ共有後、これらのアカウントでは、共有イメージを使用して ECS インスタンスの作成 (RunInstances)、システムディスクの置き換え (ReplaceSystemDisk) ができます。 |
DescribeImageSupportInstanceTypes | 指定のイメージが対応するインスタンスタイプを照会します。 |
スナップショット
操作 | 説明 |
---|---|
CreateSnapshot | 指定したディスクデバイスのスナップショットを作成します。 |
CreateAutoSnapshotPolicy | 自動スナップショットポリシーを作成します。 自動スナップショットポリシーを作成後、ApplyAutoSnapshotPolicy を呼び出して同ポリシーを任意のディスクに適用することができます。 必要な場合は、ModifyAutoSnapshotPolicyEx を呼び出して既存の自動スナップショットポリシーを変更することができます。 |
ApplyAutoSnapshotPolicy | 1 つまたは複数のディスクに自動スナップショットポリシーを適用します。 自動スナップショットポリシーが既に存在するディスクに自動スナップショットポリシーを適用すると、ディスクでは新しいポリシーが有効になり、元のポリシーが置き換えられます。 |
DeleteSnapshot | スナップショットを削除します。 この操作では、作成中のスナップショットを削除することもできます。 |
CancelAutoSnapshotPolicy | 1 つまたは複数のディスクの自動スナップショットポリシーを取り消します。 |
DeleteAutoSnapshotPolicy | 自動スナップショットポリシーを削除します。 自動スナップショットポリシーを削除すると、以前同ポリシーが適用されていたディスクには以降適用されなくなります。 |
DescribeAutoSnapshotPolicyEX | 作成した自動スナップショットポリシーを照会します。 |
DescribeSnapshots | ECS インスタンスまたはディスクのすべてのスナップショットを照会します。 InstanceId、DiskId、SnapshotIds などのリクエストパラメーターはフィルター条件として機能し、パラメーター間には論理 AND 関係が存在します。 |
DescribeSnapshotLinks | 1 つまたは複数のディスクのスナップショットリンクを照会します。 スナップショットチェーンは、ディスクのすべてのスナップショットのチェーンであり、ディスクはスナップショットのチェーンに対応します。 スナップショットチェーン ID はディスク ID と同じになります。 |
ModifyAutoSnapshotPolicyEx | 自動スナップショットポリシーを変更します。 自動スナップショットポリシーを変更すると、新しいポリシーが適用対象のディスクにすぐに適用されます。 |
DescribeSnapshotsUsage | リージョンに保存されているスナップショットの数と合計サイズを照会します。 現在のリージョンにある各ディスクのスナップショット使用情報を表示する場合は、DescribeSnapshotLinks を呼び出してスナップショットチェーン情報を照会することを推奨します。 |
DescribeSnapshotPackage | Alibaba Cloud リージョン内で購入したストレージプランを照会します。 これらのストレージプランはスナップショットの格納に使用できます。 |
セキュリティグループ
操作 | 説明 |
---|---|
ModifySecurityGroupEgressRule | セキュリティグループのアウトバウンドルールを変更します。 AuthorizeSecurityGroup を呼び出して、セキュリティグループルールを追加することができます。 |
CreateSecurityGroup | セキュリティグループを作成します。 デフォルトでは、セキュリティグループ内のインスタンスのみにアクセス許可が付与されています。 インターネットからのリクエストまたは別のセキュリティグループのインスタンスからのリクエストを許可する場合は、 AuthorizeSecurityGroup を呼び出し、該当のインスタンスまたはグループにアクセス許可を付与してください。 |
AuthorizeSecurityGroup | セキュリティグループにインバウンドルールを追加します。 別のデバイスからセキュリティグループ内の ECS インスタンスへのインバウンドトラフィックを許可またはブロックします。 |
AuthorizeSecurityGroupEgress | セキュリティグループにアウトバウンドルールを追加します。 セキュリティグループ内の ECS インスタンスから別のデバイスへのアウトバウンドトラフィックを許可またはブロックします。 |
RevokeSecurityGroup | セキュリティグループからインバウンドルールを削除します。 |
RevokeSecurityGroupEgress | セキュリティグループからアウトバウンドルールを削除します。 |
JoinSecurityGroup | 指定したセキュリティグループに ECS インスタンスを追加します。 |
LeaveSecurityGroup | 指定したセキュリティグループから ECS インスタンスを削除します。 |
DeleteSecurityGroup | セキュリティグループを削除します。 セキュリティグループを削除する前に、セキュリティグループに ECS インスタンスが存在しないこと、およびセキュリティグループが別のセキュリティグループによって引用されていないことを確認してください。 これらが満たされていない場合、DeleteSecurityGroup リクエストは失敗します。 |
DescribeSecurityGroupAttribute | セキュリティーグループの詳細を照会します。 |
DescribeSecurityGroups | セキュリティグループに関する基本情報 (セキュリティグループ ID 、説明など) を照会します。 セキュリティグループはセキュリティグループ ID の降順で表示されます。 |
DescribeSecurityGroupReferences | 指定したセキュリティグループが別のセキュリティグループから権限を付与されているかを照会します。 |
ModifySecurityGroupAttribute | セキュリティグループの属性 (セキュリティグループ名や説明など) を変更します。 |
ModifySecurityGroupPolicy | セキュリティグループのアクセス制御ポリシーを変更します。 |
ModifySecurityGroupRule | セキュリティグループのインバウンドルールを変更します。 AuthorizeSecurityGroup を呼び出して、セキュリティグループルールを追加できます。 |
デプロイメントセット
操作 | 説明 |
---|---|
CreateDeploymentSet | 指定されたリージョンにデプロイメントセットを作成します。 |
ModifyInstanceDeployment | ECS インスタンスを同じリージョン内の DDH に移行します。 |
ModifyDeploymentSetAttribute | デプロイメントセットの名前と説明を変更します。 |
DeleteDeploymentSet | デプロイメントセットを削除します。 |
DescribeDeploymentSets | 1 つまたは複数のデプロイメントセットの属性を照会します。 |
SSH キーペア
操作 | 説明 |
---|---|
CreateKeyPair | SSH キーペアを作成します。 システムは公開鍵を格納し、暗号化されていない秘密鍵を返します。 秘密鍵は PEM を使用してエンコードされ、PKCS#8 形式になります。 ユーザー自身が秘密鍵を保存し、機密性を確保する必要があります。 |
ImportKeyPair | 他のキーペアジェネレーターで作成された RSA で暗号化されたキーペアの公開鍵をインポートします。 公開鍵をインポート後、ユーザーは秘密鍵を各自保存し、機密性を確保する必要があります。 |
AttachKeyPair | 1 つまたは複数の Linux インスタンスに SSH キーペアをアタッチします。 |
DetachKeyPair | 1 つまたは複数の Linux インスタンスから SSH キーペアをデタッチします。 |
DeleteKeyPairs | 1 つまたは複数の SSH キーペアを削除します。 削除された SSH キーペアのエントリはデータベースから削除されます。 ただし、SSH キーペアがアタッチされているインスタンスは、引き続き SSH キーペアを使用することができます。 |
DescribeKeyPairs | 1 つまたは複数の SSH キーペアを照会します。 |
ネットワーク構成
操作 | 説明 |
---|---|
AllocatePublicIpAddress | ECS インスタンスにパブリック IP アドレスを割り当てます。 |
ConvertNatPublicIpToEip | VPC タイプの ECS インスタンスのパブリック IP アドレスを EIP に変換します。 |
AttachClassicLinkVpc | クラシックネットワークタイプのインスタンスと VPC の間に ClassicLink を確立し、内部ネットワーク経由でインスタンスと VPC のリソース間の通信を可能にします。 詳細については、VPC ユーザーガイドの ClassicLink の概要をご参照ください。 |
DetachClassicLinkVpc | クラシックネットワークタイプのインスタンスと VPC の間の ClassicLink を削除します。 詳細については、VPC ユーザーガイドの ClassicLink の概要をご参照ください。 ClassicLink が削除後は、クラシックネットワークタイプのインスタンスと VPC の通信はできなくなります。 |
DescribeBandwidthLimitation | 利用可能な帯域幅リソースを照会します。 |
DescribeClassicLinkInstances | VPC で ClassicLink を確立した 1 つまたは複数のクラシックネットワークタイプのインスタンスを照会します。 |
ModifyInstanceNetworkSpec | ECS インスタンスの帯域幅の設定を変更します。 ECS インスタンスのネットワーク仕様がご希望のニーズを満たせない場合、その帯域幅の設定を変更してネットワークパフォーマンスを改善させることが可能です。 |
ENI
操作 | 説明 |
---|---|
CreateNetworkInterface | ENI を作成します。 |
AttachNetworkInterface | ENI を VPC タイプのインスタンスにアタッチします。 |
AssignPrivateIpAddresses | 1 つまたは複数のセカンダリプライベート IP アドレスを ENI に割り当てます。 具体的には、ENI が属する VSwitch の CIDR ブロック内のプライベート IP アドレス、またはECS がそれらを自動的に割り当てるプライベート IP アドレスの数を指定できます。 |
UnassignPrivateIpAddresses | ENI から 1 つまたは複数のセカンダリプライベート IP アドレスを削除します。 |
DetachNetworkInterface | ECS インスタンスから ENI をデタッチします。 |
DeleteNetworkInterface | ENI を削除します。 |
DescribeNetworkInterfaces | 利用可能な ENI を照会します。 |
ModifyNetworkInterfaceAttribute | ENI の属性を変更します。 ENI の名前、説明、セキュリティグループを変更することができます。 |
システムイベント
操作 | 説明 |
---|---|
DescribeInstancesFullStatus | 1 つまたは複数の ECS インスタンスのすべてのステータス情報を照会します。 すべてのステータス情報は、インスタンスステータスとインスタンスイベントステータスから成ります。 インスタンスステータスは、インスタンスのライフサイクルを通したステータスを指し、 インスタンスイベントステータスは、メンテナンスイベントのヘルスステータスを指します。 詳細については、ECS インスタンスのライフサイクル、およびシステムイベントをご参照ください。 |
DescribeInstanceHistoryEvents | 指定された ECS インスタンスのシステムイベントを照会します。 先週のシステムイベントを照会することができます。 InstanceEventCycleStatus パラメーターを指定して、Scheduled または Executing 状態のシステムイベントを照会できます。 |
DescribeDisksFullStatus | 1 つまたは複数のディスクのすべてのステータス情報を照会します。 |
CancelSimulatedSystemEvents | 1 件または複数の Scheduled または Executing ステータスのシミュレートされたシステムイベントをキャンセルします。 シミュレートされたシステムイベントのキャンセル後、シミュレートされたイベントは Canceled の状態になります。 |
CreateSimulatedSystemEvents | 1 つまたは複数の ECS インスタンスに対してシミュレートされたシステムイベントの実行スケジュールを作成します。 シミュレートされたシステムイベントは実際のシステムでは実行されません。また、シミュレーションは ECS インスタンスに影響しません。 |
運用管理とモニタリング
操作 | 説明 |
---|---|
DescribeEniMonitorData | 特定期間のセカンダリ ENI のトラフィック情報を照会します。 |
DescribeDiskMonitorData | 特定期間中の指定されたディスクの使用情報を照会します。 ディスクの読み取り IOPS、書き込み IOPS、読み取り帯域幅 (Byte/s)、書き込み帯域幅 (Byte/s)、読み取りレイテンシ (ms)、書き込みレイテンシ (ms)を照会できます。 情報の一部が欠如している可能性があります。 ディスクが In Use の状態でないなど、システムが関連情報を取得できない場合です。 |
DescribeInstanceMonitorData | ECS インスタンスのすべてのモニタリングデータを照会します。 ECS インスタンスの CPU の使用、インバウンドデータトラフィック、アウトバウンドデータトラフィック、ネットワークトラフィック、平均帯域幅を照会できます。 情報の一部が欠如している可能性があります。 ディスクが Stopped の状態であるなど、システムが関連情報を取得できない場合です。 |
GetInstanceScreenshot | ECS インスタンスのスクリーンショット情報を取得します。 |
GetInstanceConsoleOutput | ECS インスタンスのコマンドライン出力を取得します。 リターン出力は Base64 でエンコードされています。 |
クラウドアシスタント
操作 | 説明 |
---|---|
CreateCommand | Cloud Assistant コマンドを作成します。 |
InstallCloudAssistant | 1 つまたは複数の ECS インスタンスにクラウドアシスタントをインストールします。 |
InvokeCommand | 1 つまたは複数の ECS インスタンスのクラウドアシスタントコマンドをトリガーします。 |
StopInvocation | 1 つまたは複数の ECS インスタンスの実行中のクラウドアシスタントコマンドのプロセスを停止します。 |
DeleteCommand | Cloud Assistant コマンドを削除します。 |
DescribeCloudAssistantStatus | 1 つまたは複数のインスタンスにクラウドアシスタントクライアントがインストールされているか確認します。 |
DescribeCommands | 作成したクラウドアシスタントコマンドを照会します。 Action と RegionId パラメーターのみを指定すると、利用可能なコマンドがすべて表示されます。 |
DescribeInvocations | 呼び出し情報およびクラウドアシスタントコマンドを照会します。 |
DescribeInvocationResults | クラウドアシスタントのコマンドの呼び出し結果、または指定された ECS インスタンスの実際の出力を照会します。 |
タグ
操作 | 説明 |
---|---|
TagResources | 指定された ECS リソースにタグをアタッチします。 |
ListTagResources | 1 つまたは複数の ECS リソースにアタッチされているタグを照会します。 |
UntagResources | 指定された ECS リソースからタグをデタッチおよび削除します。 |
リージョン
操作 | 説明 |
---|---|
DescribeRegions | 利用可能な Alibaba Cloud リージョンを照会します。 |
DescribeZones | 指定されたリージョンで利用可能なゾーンを照会します。 |
DescribeResourcesModification | ECS インスタンスタイプまたはシステムディスクをアップグレードまたはダウングレードする際に特定のゾーンで利用可能なリソースのリストを照会します。 |
DescribeAvailableResource | 特定のゾーンで利用可能なリソースを照会します。 たとえば、ECS インスタンスの作成 (RunInstances) やインスタンスタイプの変更 (ModifyInstanceSpec) を実行する前に、特定のゾーンで利用可能なリソースを参照することができます。 |
その他の操作
操作 | 説明 |
---|---|
CancelTask | 進行中のタスクをキャンセルします。 次の非同期タスクをキャンセルできます: イメージのインポート (ImportImage)、イメージのエクスポート (ExportImage)。 |
DescribeTasks | 1 つまたは複数の非同期タスクの進行状況を照会します。 |
DescribeTaskAttribute | 指定された非同期リクエストの詳細を照会します 。 次の非同期タスクを照会できます: イメージのインポート (ImportImage)、イメージのエクスポート (ExportImage)。 |
DescribeAccountAttributes | リージョンに作成できる ECS リソースの最大数を照会します。 具体的には、このインターフェイスで次の内容を照会できます:セキュリティグループの最大数、ENI、従量課金 インスタンスの vCPU、プリエンプティブインスタンスの vCPU、専用ホスト (DDH)、ローカルネットワークのタイプ、アカウントの実名認証の有無など。 |