このトピックでは、OpenAPI Explorerを使用してCloud Control APIをオンラインで呼び出し、クラウド リソースを管理する方法を説明します。Virtual Private Cloud (VPC) を例に、VPC リソースの作成、照会、更新、削除の各操作を順に説明します。また、Cloud Control APIが非同期でタスクを処理する場合のタスクステータスの照会方法についても説明します。
前提条件
操作をスムーズに進めるために、以下の準備を行ってください。
-
Alibaba Cloud アカウント (ルートアカウント) はリソースに対するすべての権限を持っているため、漏洩した場合、重大なリスクにつながります。RAM ユーザーの使用を推奨します。詳細については、「RAM ユーザーの作成」をご参照ください。
-
Cloud Control API を呼び出す前に、まず RAM ユーザーに、対応するリソースを操作する権限を付与し、次にAliyunCloudControlAPIFullAccess ポリシーを付与して、Cloud Control API の管理に必要なすべての権限を持たせるようにします。詳細については、「RAM ユーザー権限の管理」をご参照ください。
OpenAPI ExplorerでのCloud Control APIのオンライン呼び出し
このチュートリアルでは、Virtual Private Cloud (VPC) を例とします。VPC の製品コードはVPC、リソースタイプコードもVPCです。製品コードとリソースタイプコードを使用して、リソースタイプの詳細を照会できます。Cloud Control API をオンラインで呼び出すことにより、VPC リソースの作成、取得、更新、一覧表示、削除が可能です。
VPC リソースの作成
この操作では、VPC リソースを作成します。
-
RAM ユーザーとしてOpenAPI Explorerにログインします。VPC リソースの作成ページに移動したら、[regionId] を選択し、[body] リソースプロパティパラメーターを設定します。次に、[呼び出し開始] をクリックします。右側のサンプルコードセクションで、プログラミング言語を選択すると、システムが参照用のコードを自動生成します。
呼び出しを開始した後、呼び出し結果を確認します。
呼び出しでエラーが返された場合は、[診断] のログ情報、API ドキュメント、または「パブリックエラーコード」を参照して、問題を分析して解決してください。また、「お問い合わせ」いただくことも可能です。
呼び出しが成功した場合は、レスポンス内のリソース ID (resourceId) を記録してください。ステータスコード 200 は同期オペレーションを示し、リソース作成タスクが完了したことを意味します。ステータスコード 202 は非同期オペレーションを示し、返された taskId に基づいてタスクステータスをさらに照会する必要があります。
説明同期オペレーションと非同期オペレーションは、プログラムがタスク実行を処理する 2 つのモードです。違いは、同期オペレーションはタスクが完了してから戻るのに対し、非同期オペレーションはタスクの完了を待たずに戻る点です。
この例では、呼び出し結果としてステータスコード 202 が返されており、非同期オペレーションであることを示しています。taskId を使用してタスクステータスを照会する必要があります。taskId を記録し、[タスクの照会] をクリックして、タスク照会ページに移動します。
[taskId] を入力し、[呼び出し開始] をクリックします。呼び出し結果を確認します。呼び出しが成功し、タスクステータスが「Succeeded」の場合、VPC リソースが作成されたことを示します。
結果の検証:VPCコンソールで作成された VPC を確認します。
VPC リソースの取得
この操作では、VPC リソースの詳細を取得します。VPC リソースの取得ページで、[resourceId] を入力し、[regionId] を選択して、[呼び出し開始] をクリックします。呼び出し結果を確認します。呼び出しが成功すると、リソースの詳細が返されます。
VPC リソースの更新
この操作では、VPC リソースの情報を更新します。VPC リソースの更新ページで、[resourceId] を入力し、[regionId] を選択して、更新するパラメーター値を入力し、[呼び出し開始] をクリックします。呼び出し結果を確認します。更新を検証するには、VPCコンソールでリソース情報を確認するか、Cloud Control API を呼び出して検証します。
VPC リソースの一覧表示
この操作では、すべての VPC リソースの情報を一覧表示します。VPC リソースの一覧表示ページで、[regionId] を選択し、[呼び出し開始] をクリックします。呼び出し結果でリソース情報を確認します。
パラメーターの例は次のとおりです:
requestPath:
/api/v1/providers/Aliyun/products/VPC/resources/VPCregionId:
cn-beijing
VPC リソースの削除
この操作では、指定した VPC リソースを削除します。
削除操作は元に戻すことができません。実行には十分ご注意ください。VPC を削除する前に、テスト環境で削除プロセスを十分に検証し、すべてが正しいことを確認した上で、本番環境のリソースに対して操作を実行することを推奨します。
VPC リソースの削除ページで、[resourceId] を入力し、[regionId] を選択して、[呼び出し開始] をクリックし、呼び出し結果を確認します。
呼び出しが成功するとステータスコード 202 が返されます。これは、この呼び出しが非同期オペレーションであることを示します。
タスク照会ページで[taskId] を入力し、[呼び出し開始] をクリックします。呼び出し結果を確認します。タスクステータスが「Succeeded」の場合、VPC リソースが削除されたことを示します。
サンプルコード
コードリポジトリ: https://github.com/aliyun/cloud-control-api-demo
このリポジトリでは、リソースメタデータの照会とクラウド リソースの管理に役立つCloud Control APIのコードサンプルを提供しています。