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