サービスカタログは、管理コンソールに加えて、OpenAPI Explorer でのオンラインデバッグ、Alibaba Cloud SDK など、複数の統合メソッドを提供します。 開発効率を向上させるために、要件に最も適した操作と統合メソッドを選択してください。
OpenAPI Explorer の概要
Alibaba Cloud は、開発者がさまざまな Alibaba Cloud サービスの API オペレーションを迅速かつ効率的に理解し、使用できるように OpenAPI Explorer を提供しています。 OpenAPI Explorer は、インテリジェント検索、ドキュメント、オンラインデバッグ、SDK のダウンロード、サンプルコード、エラー診断、呼び出し統計など、API オペレーションに関連する複数の機能を提供します。 OpenAPI Explorer では、Alibaba Cloud サービスの API オペレーションを呼び出し、API リクエストとレスポンスを表示できます。 さらに、OpenAPI Explorer は対応する SDK サンプルコードを自動的に生成し、Alibaba Cloud サービスの利用を容易にします。 詳細については、「API とは」をご参照ください。
バージョン
OpenAPI Explorer は、バージョン番号を使用してクラウドサービスの API オペレーションのメジャーバージョンを管理します。 たとえば、サービスカタログは 2021-09-01 バージョンの API をサポートしています。 2021-09-01 は API の最終更新日ではなく、API のバージョン番号です。 各バージョンで最新の API データが提供されます。
API バージョン | 説明 |
推奨バージョンです。 |
オンラインデバッグ
OpenAPI Explorer でサービスカタログの API オペレーションを呼び出すことができます。 サービスカタログの API オペレーションを呼び出す前に、API バージョン、エンドポイント、統合メソッドなど、API に関する情報を理解しておく必要があります。
OpenAPI Explorer で、デバッグ対象の操作として GetProductAsEndUser を選択します。 サービスアドレスには、中国 (杭州) などのターゲットリージョンを選択します。 パラメーター設定エリアで、必須パラメーターである ProductId (プロダクト ID、文字列、例: prod-bp18r7q127****) を入力し、[呼び出し開始] をクリックします。 呼び出しを行う前に、管理者がエンドユーザーにプロダクトを使用する権限を付与していることを確認してください。 ProductId は、UpdateProduct、LaunchProduct、CreateProduct、ListProductsAsAdmin、GetProductVersion などの操作のレスポンスから取得できます。
オンラインデバッグページ
次のページで 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 アカウント (root ユーザー) を使用して OpenAPI Explorer にログインすると、デフォルトで Alibaba Cloud アカウントを使用してオンラインデバッグが実行されます。 Alibaba Cloud アカウント (root ユーザー) は、すべての API オペレーションに対する権限を持っています。 Alibaba Cloud アカウント (root ユーザー) を使用してオンラインで API オペレーションをデバッグすると、セキュリティリスクが発生する可能性があります。 Resource Access Management (RAM) ユーザーとして API オペレーションを呼び出すか、日常の O&M を実行することを推奨します。 RAM ユーザーとして API オペレーションを呼び出す前に、ビジネス要件に基づいて RAM ユーザーに必要な権限を付与してください。 RAM ユーザーは、サービスカタログを管理する権限を持っている必要があります。 詳細については、「RAM を使用したアクセスの制御」をご参照ください。
アイデンティティ | サポート |
はい | |
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」をご参照ください。
-
Alibaba Cloud SDK を使用して、サービスカタログの操作を呼び出すことができます。 サポートされている言語と依存関係のインストール方法については、「サービスカタログ 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 オペレーションを呼び出した後にエラーが返された場合は、エラーコードに基づいてリクエストパラメーターとパラメーター値が有効かどうかを確認できます。
また、レスポンスまたは SDK エラーメッセージから RequestID を記録し、OpenAPI 問題診断ページを使用してセルフサービス診断を行うこともできます。
参考資料
サービスカタログは、Alibaba Cloud が開発した Infrastructure as Code (IaC) サービスです。 サービスカタログは、企業が特定の要件を満たすサービスを構成し、サービスの起動制約を定義するのに役立ちます。 これにより、企業はワークロードをクラウドに移行する際に、ビジネス要件に基づいて便利な方法でサービスを選択できます。 これにより、IT サービスのデリバリー効率が向上します。 詳細については、「サービスカタログとは」をご参照ください。
サービスカタログ SDK でサポートされているプログラミング言語の詳細については、「SDK の概要」をご参照ください。