API 標準および多言語対応の SDK
本製品 (SWAS-OPEN/2020-06-01) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
インスタンス
|
API |
タイトル |
説明 |
| CreateInstances | CreateInstances | サブスクリプション形式の Simple Application Server を作成します。 |
| StartInstance | StartInstance | Simple Application Server を起動します。 |
| StartInstances | StartInstances | シンプルアプリケーションサーバーを起動します。 |
| ListInstanceStatus | ListInstanceStatus | シンプルアプリケーションサーバーのステータスを照会します。 |
| StopInstance | StopInstance | シンプルアプリケーションサーバーを停止します。 |
| StopInstances | StopInstances | Simple Application Server を停止します。 |
| UpdateInstanceAttribute | UpdateInstanceAttribute | Simple Application Server の情報 (サーバー名、サーバーへのログインパスワードなど) を変更します。 |
| ListInstances | インスタンスの一覧表示。 | 指定されたリージョンの 1 つ以上のシンプルアプリケーションサーバーインスタンスの詳細を照会します。 |
| LoginInstance | LoginInstance | ワークベンチで簡易アプリケーションサーバーにログインします。 |
| DescribeInstanceVncUrl | DescribeInstanceVncUrl | シンプルアプリケーションサーバーの VNC 接続アドレスを照会します。 |
| ModifyInstanceVncPassword | ModifyInstanceVncPassword | シンプルアプリケーションサーバーの VNC パスワードを変更します。 |
| ListInstancePlansModification | ListInstancePlansModification | このトピックでは、指定された Simple Application Server インスタンスをスペックアップできるプランのリストについて説明します。 |
| ListInstancesTrafficPackages | ListInstancesTrafficPackages | Simple Application Server のデータ転送プランの詳細を問い合わせます。 |
| DescribeInstancePasswordsSetting | DescribeInstancePasswordsSetting | シンプルアプリケーションサーバーにパスワードが設定されているかを確認します。 |
| InstallCloudMonitorAgent | InstallCloudMonitorAgent | シンプルアプリケーションサーバーにクラウドモニターエージェントをインストールします。 |
| DescribeCloudMonitorAgentStatuses | DescribeCloudMonitorAgentStatuses | シンプルアプリケーションサーバー上の CloudMonitor エージェントのステータスを照会します。 |
| DescribeMonitorData | DescribeMonitorData | Simple Application Server の vCPU、メモリ、ディスク IOPS、トラフィックに関するモニタリング情報をクエリします。 |
| DescribeSecurityAgentStatus | DescribeSecurityAgentStatus | シンプルアプリケーションサーバー上の Security Center エージェントのステータスをクエリします。 |
| RebootInstance | RebootInstance | シンプルアプリケーションサーバーを再起動します。 |
| RebootInstances | RebootInstances | Simple Application Server を再起動します。 |
| UpgradeInstance | UpgradeInstance | Simple Application Server のプランをスペックアップします。 |
| RenewInstance | RenewInstance | Simple Application Server インスタンスを更新します。 |
| ResetSystem | ResetSystem | シンプルアプリケーションサーバーをリセットします。 |
キーペア
|
API |
タイトル |
説明 |
| CreateInstanceKeyPair | CreateInstanceKeyPair | シンプルアプリケーションサーバーのキーペアを作成します。 |
| CreateKeyPair | CreateKeyPair | Simple Application Server キーペアを作成します。 |
| UploadInstanceKeyPair | UploadInstanceKeyPair | シンプルアプリケーションサーバーのキーペアをインポートします。 |
| ImportKeyPair | ImportKeyPair | 既存のキーペアをインポートします。 |
| DescribeInstanceKeyPair | DescribeInstanceKeyPair | シンプルアプリケーションサーバーのキーペアに関する情報を照会します。 |
| ListKeyPairs | ListKeyPairs | 指定されたリージョン内のシンプルアプリケーションサーバーにバインドされている AccessKey ペアをクエリします。 |
| AttachKeyPair | AttachKeyPair | キーペアをシンプルアプリケーションサーバーにバインドします。 |
| DetachKeyPair | DetachKeyPair | シンプルアプリケーションサーバーからキーペアのバインドを解除します。 |
| DeleteInstanceKeyPair | DeleteInstanceKeyPair | シンプルアプリケーションサーバーのキーペアを削除します。 |
| DeleteKeyPairs | DeleteKeyPairs | Simple Application Server の SSH キーペアを削除します。 |
ファイアウォールテンプレート
|
API |
タイトル |
説明 |
| CreateFirewallTemplate | CreateFirewallTemplate | ファイアウォールテンプレートを作成します。 |
| DescribeFirewallTemplates | DescribeFirewallTemplates | ファイアウォールテンプレートの詳細を照会します。 |
| CreateFirewallTemplateRules | CreateFirewallTemplateRules | ビジネス要件に基づいて、ファイアウォールテンプレートにファイアウォールルールを追加します。 |
| ApplyFirewallTemplate | ApplyFirewallTemplate | ファイアウォールテンプレートを使用して、一度に複数のシンプルアプリケーションサーバーにファイアウォールルールを適用します。これにより、ファイアウォールルールの設定効率が向上します。 |
| ModifyFirewallTemplate | ModifyFirewallTemplate | ファイアウォールテンプレート内のファイアウォールルールを変更します。新しいファイアウォールルールをシンプルアプリケーションサーバーに適用できます。 |
| DescribeFirewallTemplateApplyResults | DescribeFirewallTemplateApplyResults | シンプルアプリケーションサーバーへのファイアウォールテンプレートの適用結果を照会します。 |
| DescribeFirewallTemplateRulesApplyResult | DescribeFirewallTemplateRulesApplyResult | ファイアウォールテンプレートルールをシンプルアプリケーションサーバーに適用した結果を照会します。 |
| DeleteFirewallTemplateRules | DeleteFirewallTemplateRules | 要件に基づいて、ファイアウォールテンプレートからファイアウォールルールを削除します。 |
| DeleteFirewallTemplates | DeleteFirewallTemplates | シンプルアプリケーションサーバーからファイアウォールテンプレートを削除します。 |
ファイアウォール
|
API |
タイトル |
説明 |
| DeleteFirewallRules | DeleteFirewallRules | Simple Application Server の複数のファイアウォールルールを削除します。 |
| CreateFirewallRule | CreateFirewallRule | シンプルアプリケーションサーバーのファイアウォールルールを作成します。 |
| CreateFirewallRules | CreateFirewallRules | シンプルアプリケーションサーバーのファイアウォールルールを一度に複数作成します。 |
| ListFirewallRules | ListFirewallRules | Simple Application Server のファイアウォールルールを照会します。 |
| ModifyFirewallRule | ModifyFirewallRule | シンプルアプリケーションサーバーのファイアウォールルールを変更します。 |
| EnableFirewallRule | EnableFirewallRule | シンプルアプリケーションサーバーのファイアウォールルールを有効にします。 |
| DisableFirewallRule | DisableFirewallRule | シンプルアプリケーションサーバーのファイアウォールルールを無効にします。 |
| DeleteFirewallRule | DeleteFirewallRule | Simple Application Server のファイアウォールルールを削除します。 |
スナップショット
|
API |
タイトル |
説明 |
| CreateSnapshot | CreateSnapshot | ディスクのスナップショットを作成します。 |
| ListSnapshots | ListSnapshots | 簡易アプリケーションサーバー用に作成されたスナップショットの情報を照会します。 |
| UpdateSnapshotAttribute | UpdateSnapshotAttribute | シンプルアプリケーションサーバーのスナップショットの備考を変更します。 |
| DeleteSnapshot | DeleteSnapshot | Simple Application Server のスナップショットを削除します。 |
| DeleteSnapshots | DeleteSnapshots | Simple Application Server のスナップショットを削除します。 |
ディスク
|
API |
タイトル |
説明 |
| UpdateDiskAttribute | UpdateDiskAttribute | シンプルアプリケーションサーバーにアタッチされているデータディスクの備考を変更します。 |
| ListDisks | ListDisks | 指定されたリージョン内のディスク情報をクエリします。 |
| ResetDisk | ResetDisk | スナップショットに基づいてディスクをロールバックします。 |
カスタムイメージ
|
API |
タイトル |
説明 |
| CreateCustomImage | CreateCustomImage | Simple Application Server のスナップショットに基づいてカスタムイメージを作成します。 |
| ListCustomImages | ListCustomImages | 指定されたリージョン内のカスタムイメージの情報を照会します。 |
| ModifyImageShareStatus | ModifyImageShareStatus | カスタムイメージを Elastic Compute Service (ECS) に共有または共有解除します。 |
| AddCustomImageShareAccount | AddCustomImageShareAccount | 同じリージョン内の他の Alibaba Cloud アカウントとカスタムイメージを共有し、複数の Simple Application Server に同じ環境構成を一度に迅速にデプロイすることで、デプロイメント効率を向上させます。 |
| ListCustomImageShareAccounts | ListCustomImageShareAccounts | 特定のリージョン内で Alibaba Cloud アカウント間で共有されているカスタムイメージの情報を照会します。 |
| RemoveCustomImageShareAccount | RemoveCustomImageShareAccount | Alibaba Cloud アカウント間で共有されているカスタムイメージの共有を解除します。 |
| DeleteCustomImage | DeleteCustomImage | カスタムイメージを削除します。 |
| DeleteCustomImages | DeleteCustomImages | カスタムイメージを削除します。 カスタムイメージが不要になった場合、この操作を呼び出してカスタムイメージを削除できます。 この操作を呼び出して、複数のカスタムイメージを同時に削除することもできます。 カスタムイメージを削除すると、そのカスタムイメージを基に作成されたシンプルアプリケーションサーバーをリセットするために、そのカスタムイメージを使用することはできなくなります。 |
コマンドアシスタント
|
API |
タイトル |
説明 |
| DescribeCloudAssistantAttributes | DescribeCloudAssistantAttributes | シンプルアプリケーションサーバーのコマンドアシスタント情報を照会します。 |
| UpdateCommandAttribute | UpdateCommandAttribute | コマンドのパラメーターを変更します。 |
| InvokeCommand | InvokeCommand | 1 つ以上のシンプルアプリケーションサーバーに対して、クラウドアシスタントのコマンドを実行します。 |
| DescribeCommands | DescribeCommands | 作成したコマンド、または Alibaba Cloud が提供する共通コマンドを照会します。 |
| DescribeCommandInvocations | DescribeCommandInvocations | クラウドアシスタントコマンドの実行と実行ステータスを照会します。 |
| DeleteCommand | DeleteCommand | コマンドアシスタントのコマンドを削除します。 |
| CreateCommand | CreateCommand | クラウドアシスタントのコマンドを作成します。 |
| StartTerminalSession | StartTerminalSession | Simple Application Server インスタンスにログインするためのセッションを開始します。 |
| InstallCloudAssistant | InstallCloudAssistant | シンプルアプリケーションサーバーにクラウドアシスタントクライアントをインストールします。 |
| DescribeCloudAssistantStatus | DescribeCloudAssistantStatus | 簡易アプリケーションサーバーにクラウドアシスタントクライアントがインストールされているかどうかを照会します。 |
| DescribeInvocationResult | DescribeInvocationResult | コマンドの実行結果を照会します。 |
| RunCommand | RunCommand | Simple Application Server 上でコマンドを実行します。 |
| DescribeInvocations | DescribeInvocations | コマンドの実行詳細を照会します。 |
タグ
|
API |
タイトル |
説明 |
| TagResources | TagResources | Simple Application Server、スナップショット、カスタムイメージ、コマンド、ファイアウォールルール、ディスクにタグを追加し、これらのリソースの表示と管理を容易にします。 |
| ListTagResources | ListTagResources | インスタンス、スナップショット、ディスク、イメージ、コマンド、ファイアウォールルールなどのシンプルなリソースに追加されたタグを照会します。 |
| UntagResources | UntagResources | インスタンス、スナップショット、ディスク、イメージ、コマンド、ファイアウォールルールなどの指定された軽量リソースからタグのバインドを解除し、削除します。 |
その他のリソース
|
API |
タイトル |
説明 |
| ListRegions | ListRegions | Simple Application Server (SWAS) がサポートされているすべてのリージョンをクエリします。 |
| ListImages | ListImages | 指定されたリージョン内のイメージ情報を照会します。 |
| ListPlans | プラン情報の照会。 | 指定されたリージョンのシンプルアプリケーションサーバーのすべてのプラン情報を照会します。 |
| DescribePrice | 料金を照会します。 | Simple Application Server プロダクトの料金情報を取得します。 |
| CreateOrder | CreateOrder | Simple Application Server の料金を取得します。 |