サービスカタログは、視覚的な操作のためのコンソールと、OpenAPI エクスプローラーや Alibaba Cloud SDK など、API 操作を呼び出すための複数のメソッドを提供します。 サービスカタログを使用して開発効率を向上させるには、ビジネス要件に基づいて適切な API 操作と統合方法を使用することをお勧めします。
OpenAPI エクスプローラーの概要
Alibaba Cloud は、開発者がさまざまな Alibaba Cloud サービスの API 操作を迅速かつ効率的に理解して使用できるように、OpenAPI エクスプローラーを提供しています。 OpenAPI エクスプローラーは、インテリジェント検索、ドキュメント、オンラインデバッグ、SDK ダウンロード、サンプルコード、エラー診断、呼び出し統計など、API 操作に関連する複数の機能を提供します。 OpenAPI エクスプローラーでは、Alibaba Cloud サービスの API 操作を呼び出し、API リクエストとレスポンスを表示できます。 さらに、OpenAPI エクスプローラーは、対応する SDK サンプルコードを自動的に生成し、Alibaba Cloud サービスの利用を容易にします。 詳細については、「API とは」をご参照ください。
バージョン
OpenAPI エクスプローラーは、バージョン番号を使用してクラウドサービス API 操作のメジャーバージョンを管理します。 たとえば、サービスカタログは 2021-09-01 バージョンの API をサポートしています。 2021-09-01 は、API が最後に更新された日付ではなく、API のバージョン番号です。 各バージョンで最新の API データが提供されます。
API バージョン | 説明 |
推奨バージョン。 |
オンラインデバッグ
OpenAPI エクスプローラーでサービスカタログの API 操作を呼び出すことができます。 サービスカタログの API 操作を呼び出す前に、API バージョン、エンドポイント、統合方法など、API に関する情報を理解する必要があります。
オンラインデバッグページ
サービスカタログの API 操作は、オンラインデバッグ ページ で呼び出すことができます。
エンドポイント
遅延を 줄이기 위해、リソースが存在するリージョンに基づいてエンドポイントを選択できます。 たとえば、サービスカタログが中国 (杭州) リージョンに存在する場合、パブリックエンドポイントは servicecatalog.cn-hangzhou.aliyuncs.com で、Virtual Private Cloud (VPC) エンドポイントは servicecatalog-vpc.cn-hangzhou.aliyuncs.com です。
パブリックエンドポイントはグローバルにアクセスできます。
VPC エンドポイントは、特定の Alibaba Cloud リージョンの VPC 内からのみアクセスできます。 VPC エンドポイントには次の利点があります。
セキュリティの向上: VPC エンドポイントは VPC 内からのみアクセスできます。 これにより、セキュリティとプライバシーが向上します。
高速な応答: VPC エンドポイントは内部ネットワーク環境を使用するため、パブリックエンドポイントよりも高速な応答を提供します。 さらに、VPC エンドポイントを使用することで、ネットワーク遅延や帯域幅制限などの問題から解放されます。
低コスト: VPC エンドポイントは内部ネットワーク経由でアクセスされます。
詳細については、「エンドポイント」をご参照ください。
ユーザー ID
Alibaba Cloud アカウントを使用して OpenAPI エクスプローラーにログインすると、OpenAPI エクスプローラーはデフォルトで Alibaba Cloud アカウントを使用してオンラインデバッグを実行します。 Alibaba Cloud アカウントは、すべての API 操作に対する権限を持っています。 Alibaba Cloud アカウントを使用して API 操作をオンラインでデバッグすると、セキュリティリスクが発生する可能性があります。 API 操作の呼び出しや日常的な O&M は、Resource Access Management (RAM) ユーザーとして実行することをお勧めします。 RAM ユーザーとして API 操作を呼び出す前に、ビジネス要件に基づいて必要な権限を RAM ユーザーに付与します。 RAM ユーザーは、サービスカタログを管理するための権限を持っている必要があります。 詳細については、「RAM を使用したアクセスコントロール」をご参照ください。
ID | サポート |
はい | |
RAM ユーザー (推奨) | はい |
RAM ロール (推奨) | はい |
参照
統合方法
SDK はアプリケーションに簡単に統合でき、最も幅広い操作をカバーしています。 API 操作を呼び出すには、SDK を使用することをお勧めします。
統合方法の概要
統合方法 | サポート |
Alibaba Cloud SDK (推奨) | はい |
いいえ | |
いいえ | |
はい |
Alibaba Cloud SDK
Alibaba Cloud は、Java、C#、Go、Python、Node.js、TypeScript、PHP、C++ など、複数のプログラミング言語で SDK を提供しています。 アプリケーションに SDK を統合して、API 操作を直接呼び出すことができます。 SDK は、署名ロジック、タイムアウトメカニズム、リトライメカニズムなどの情報をカプセル化し、仕様に基づいて構造化されたレスポンスオブジェクトを返します。 これにより、開発が容易になります。 詳細については、「Alibaba Cloud SDK」をご参照ください。
OpenAPI エクスプローラーでサービスカタログ SDK を使用して API 操作を呼び出すことができます。 サポートされているプログラミング言語と依存関係のインストール方法の詳細については、サービスカタログ SDK をご参照ください。
Alibaba Cloud CLI
Alibaba Cloud CLI を使用すると、
aliyunコマンドを実行して Alibaba Cloud サービスと対話し、クラウドサービスリソースを管理できます。 詳細については、「Alibaba Cloud CLI とは」をご参照ください。Alibaba Cloud CLI を使用してサービスカタログの API 操作を呼び出すことはできません。
ROS
ROS は、クラウドコンピューティングリソースの管理を簡素化する Alibaba Cloud サービスです。 テンプレートを作成して、Elastic Compute Service (ECS) インスタンスや ApsaraDB RDS インスタンスなどの必要なクラウドコンピューティングリソースと、リソース間の関係を記述できます。 ROS は、テンプレートに基づいてすべてのリソースを自動的に作成および構成し、自動化されたデプロイと O&M を実装します。 詳細については、「ROS とは」をご参照ください。
ROS を使用してサービスカタログの API 操作を呼び出すことはできません。
カスタムカプセル化
ネイティブ HTTP 呼び出しを行うには、カスタムリクエストを作成し、リクエストに署名する必要があります。 署名方法の詳細については、「関数別の操作リスト」および「リクエスト構文と署名方法 V3」をご参照ください。
使用上の注意
API 操作の呼び出し後にエラーが返された場合は、エラーコードに基づいてリクエストパラメーターとパラメーター値が有効かどうかを確認できます。
OpenAPI 問題診断 ページで、返されたリクエスト ID または SDK エラー情報に基づいてセルフサービス診断を実行することもできます。
参照
サービスカタログは、Alibaba Cloud によって開発されたコードとしてのインフラストラクチャ (IaC) サービスです。 サービスカタログは、企業が特定の要件を満たすサービスを構成し、サービス起動の制約を定義するのに役立ちます。 これにより、企業はクラウドにワークロードを移行する際に、ビジネス要件に基づいてサービスを簡単に選択できます。 これにより、IT サービスの提供効率が向上します。 詳細については、「サービスカタログとは」をご参照ください。
サービスカタログ SDK でサポートされているプログラミング言語の詳細については、「SDK の概要」をご参照ください。