ActionTrail は、視覚的な操作のためのコンソールと、OpenAPI エクスプローラー、Alibaba Cloud SDK、Resource Orchestration Service (ROS) を含む、API 操作を呼び出すための複数のメソッドを提供します。 OpenAPI エクスプローラーは API 操作のオンラインデバッグをサポートしています。 ActionTrail を使用して開発効率を向上させるには、ビジネス要件に基づいて適切な API 操作と統合方法を使用することをお勧めします。
OpenAPI エクスプローラーの概要
Alibaba Cloud は、開発者がさまざまな Alibaba Cloud サービスの API 操作を迅速かつ効率的に理解し、使用できるように OpenAPI エクスプローラーを提供しています。 OpenAPI エクスプローラーは、インテリジェント検索、ドキュメント、オンラインデバッグ、SDK ダウンロード、サンプルコード、エラー診断、呼び出し統計など、API 操作に関連する複数の機能を統合しています。 OpenAPI エクスプローラーでは、Alibaba Cloud サービスの API 操作を呼び出し、API リクエストとレスポンスを表示できます。 さらに、OpenAPI エクスプローラーは、Alibaba Cloud サービスの使用を容易にするために、対応する SDK サンプルコードを自動的に生成します。 詳細については、「API とは」をご参照ください。
バージョンの説明
Alibaba Cloud API は、バージョン番号を使用してクラウドサービス API のバージョンを管理します。 たとえば、ActionTrail は 2020-07-06 バージョンの API をサポートしています。 2020-07-06 は日付ではなく API のバージョン番号です。 ユーザーには、API に関する最新のパブリック情報が提供されます。 2020-07-06 は ActionTrail API の最新バージョンです。
バージョン | 説明 |
推奨 |
オンラインデバッグ
ActionTrail は、OpenAPI エクスプローラーで API デバッグなどの機能を提供します。 API 操作を呼び出す前に、ActionTrail によって提供される次の情報に注意してください: バージョン、エンドポイント、および統合方法。
デバッグページ
OpenAPI エクスプローラー にアクセスします。
エンドポイント
遅延を減らすために、アクセスするリソースが存在するリージョンに基づいてエンドポイントを選択することをお勧めします。 たとえば、ActionTrail が中国 (張家口) リージョンに存在する場合、パブリックエンドポイントは actiontrail.cn-zhangjiakou.aliyuncs.com で、VPC エンドポイントは actiontrail-vpc.cn-zhangjiakou.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 ユーザーには、ActionTrail リソースを管理するための権限が必要です。 詳細については、「RAM を使用したアクセスコントロールの実装」をご参照ください。
ID | サポート |
はい | |
RAM ユーザー (推奨) | はい |
RAM ロール (推奨) | はい |
参考資料
統合方法
SDK はアプリケーションと簡単に統合でき、幅広い操作をカバーしています。 API 操作を呼び出すには、SDK を使用することをお勧めします。
統合方法
方法 | サポート |
Alibaba Cloud SDK (推奨) | はい |
はい | |
はい | |
はい |
Alibaba Cloud SDK
Alibaba Cloud は、Java、C#、Go、Python、TypeScript、Node.js、PHP、C++ などの複数のプログラミング言語で SDK を提供しています。 アプリケーションに SDK を統合して、API 操作を直接呼び出すことができます。 SDK は、データ署名ロジック、タイムアウトメカニズム、リトライメカニズムなどのさまざまな情報をカプセル化します。 SDK は、仕様に基づいて構造化されたレスポンスオブジェクトを返し、開発を容易にします。 詳細については、「Alibaba Cloud SDK」をご参照ください。
SDK を使用して ActionTrail の API 操作を呼び出すことができます。 サポートされている言語と依存関係の詳細については、ActionTrail SDK をご参照ください。
Alibaba Cloud CLI
Alibaba Cloud CLI は、Alibaba Cloud API に基づいて開発された汎用コマンドラインツールです。 Alibaba Cloud CLI を使用すると、シェルツールを使用して Alibaba Cloud サービスと対話し、Alibaba Cloud サービスを管理できます。 Alibaba Cloud CLI の詳細については、「Alibaba Cloud CLI とは」をご参照ください。
Alibaba Cloud CLI を使用して ActionTrail の API 操作を呼び出すことができます。
ROS
ROS は、クラウドコンピューティングリソースの管理を簡素化できる Alibaba Cloud サービスです。 Elastic Compute Service (ECS) インスタンスや ApsaraDB RDS インスタンスなどの必要なクラウドコンピューティングリソースと、リソース間の関係を記述するテンプレートを作成できます。 ROS は、テンプレートに基づいてすべてのリソースを自動的に作成および構成し、自動化されたデプロイと O&M を実装します。 詳細については、「ROS とは」をご参照ください。
ROS を使用して ActionTrail の API 操作を呼び出すことができます。 詳細については、「ROS の使用」をご参照ください。
カスタム API カプセル化
ネイティブ HTTP 呼び出しを行うには、カスタムリクエストを作成し、リクエストに署名する必要があります。 署名メカニズムの詳細については、「関数別の操作リスト」および「リクエスト構文と署名方式 V3」をご参照ください。
使用上の注意
ActionTrail の API 操作を呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて、入力パラメーターと値が有効かどうかを確認してください。
OpenAPI 問題診断 ページで、返されたリクエスト ID または SDK エラー情報に基づいてセルフサービス診断を実行することもできます。
よくある質問
ActionTrail を使用すると、Alibaba Cloud アカウントのアクティビティを監視および記録でき、動作分析、セキュリティ分析、リソース変更追跡、動作コンプライアンス監査などの操作がサポートされます。 詳細については、「ActionTrail とは」をご参照ください。
ActionTrail は、Java 用の SDK に加えて、C#、Go、Python、Node.js、TypeScript、PHP、C++ などの複数のプログラミング言語で SDK を提供しています。 詳細については、「SDK リファレンス」をご参照ください。