このトピックでは、ApsaraDB for ClickHouse APIを呼び出すための基本的な情報と使用法について説明します。
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とは何ですか?
バージョンの説明
Alibaba Cloud APIはバージョン番号を使用して、異なるアーキテクチャのApsaraDB for ClickHouseクラスターのAPI操作を管理します。 クラスターエディションに基づいて適切なAPIを選択できます。
バージョン番号 | 説明 |
2019-11-11 | このバージョンのAPI操作は、Community-compatible Editionクラスターに適しています。 |
2023-05-22 | このバージョンのAPI操作は、Enterprise Editionクラスターに適しています。 |
オンラインデバッグ
ApsaraDB for ClickHouseは、OpenAPI ExplorerでのAPIデバッグなどの機能を提供します。 API操作を呼び出す前に、ApsaraDB for ClickHouseが提供するバージョン、エンドポイント、および統合方法に関する情報を理解しておく必要があります。
APIデバッグURL
ApsaraDB for ClickHouseのAPIデバッグURLCommunity-compatible EditionとEnterprise Editionは異なります。 クラスターエディションに基づいて適切なURLを選択する必要があります。
エディション | 説明 |
Community-compatible Edition | ApsaraDB for ClickHouse Community-compatible EditionのAPIデバッグURL |
Enterprise Edition |
エンドポイントの説明
リソースが存在するリージョンに基づいてエンドポイントを選択すると、遅延を減らすことができます。 ApsaraDB for ClickHouseが中国 (張家口) リージョンにある場合、パブリックエンドポイントはclickhouse.cn-zhangjiakou.aliyuncs.comであり、仮想プライベートクラウド (VPC) エンドポイントはclickhouse-vpc.cn-zhangjiakou.aliyuncs.comです。
パブリックエンドポイントはグローバルにアクセスできます。
VPCは互いに分離されています。 各VPCは仮想ネットワークに対応しています。 VPCエンドポイントには次の利点があります。
より高いセキュリティ: VPCエンドポイントは、対応するVPC内でのみアクセス可能です。 これにより、より高いセキュリティとプライバシーが提供されます。
高速応答: VPCエンドポイントは内部ネットワーク環境を使用して、パブリックエンドポイントよりも高速な応答を提供します。 さらに、ネットワークの待ち時間や帯域幅の制限などの問題も発生しません。
低コスト: VPCエンドポイントは内部ネットワーク経由でアクセスされます。
詳細については、「エンドポイント」をご参照ください。
サポートされているユーザーID
Alibaba Cloudアカウントを使用してOpenAPI Explorerにログインすると、OpenAPI ExplorerはAlibaba Cloudアカウントを使用してデフォルトでオンラインデバッグを実行します。 Alibaba Cloudアカウントには、すべてのAPI操作に対する権限があります。 Alibaba Cloudアカウントを使用してAPI操作をオンラインでデバッグすると、セキュリティリスクが発生する可能性があります。 RAMユーザーを使用してAPI操作を呼び出したり、ルーチンのO&Mを実行することを推奨します。RAMユーザーとしてAPI操作を呼び出す前に、ビジネス要件に基づいて必要な権限をRAMユーザーに付与します。 RAMユーザーにApsaraDB for ClickHouseの管理権限があることを確認します。 詳細については、「RAM権限付与」をご参照ください。
ID | 対応 |
必須 | |
RAMユーザー (推奨) | 必須 |
RAMロール (推奨) | 必須 |
統合方法
ApsaraDB for ClickHouseには、Alibaba Cloud SDK、Terraform、ROS (Resource Orchestration Service) 、およびカスタムカプセル化の統合方法があります。 ビジネス要件に基づいて統合方法を選択できます。
SDKは簡単に統合できるため、SDKはAPI操作を呼び出すために最も推奨される方法です。
統合方法 | 対応 |
Alibaba Cloud SDK | 必須 |
Alibaba Cloud CLI | いいえ |
テラフォーム | いいえ |
ROS | 一部対応 |
カスタムカプセル化 | 必須 |
Alibaba Cloud SDK
Alibaba Cloudは、Java、C# 、Go、Python、Node.js、TypeScript、PHP、C ++ などの複数のプログラミング言語でSDKを提供しています。 SDKでは、API操作の実装の詳細を考慮したり、ID、認証、署名のルールを標準化したりすることができます。 SDKを統合し、SDKを使用してAPI操作を直接呼び出すだけです。 Alibaba Cloud SDKの詳細については、「Alibaba Cloud SDK」をご参照ください。
Alibaba Cloud SDKを使用して、ApsaraDB for ClickHouseのAPI操作を呼び出すことができます。 サポートされているプログラミング言語と依存関係のインストールの詳細については、「SDKの概要」をご参照ください。
Alibaba Cloud CLI
Alibaba Cloud CLIでは、CLIシェルで
aliyunコマンドを使用してAlibaba Cloudサービスと対話し、クラウドサービスリソースを管理できます。 Alibaba Cloud CLIの詳細については、Alibaba Cloud CLIとはAlibaba Cloud CLIを使用してApsaraDB for ClickHouseのAPI操作を呼び出すことはできません。
Terraform
Terraformは、クラウドのインフラストラクチャとリソースをプレビュー、設定、管理するために使用される、安全で効率的なオープンソースツールです。 TerraformはROSと同様に機能します。 Terraformは、テンプレートを解釈してAPI操作を呼び出します。 詳細については、「」をご参照ください。Terraformとは何ですか?
Terraformを使用してApsaraDB for ClickHouseのAPI操作を呼び出すことはできません。
ROS
ROSは、クラウドコンピューティングリソースの管理を簡素化できるAlibaba Cloudサービスです。 Elastic Compute Service (ECS) やApsaraDB RDSインスタンスなどの必要なAlibaba Cloudリソース、およびリソース間の依存関係を定義するためのテンプレートを作成できます。 ROSエンジンは、テンプレートに基づいてスタック内のすべてのリソースを自動的に作成および構成して、自動デプロイとO&Mを実装します。詳細については、「」をご参照ください。ROSとは何ですか?
ROSを使用して、ApsaraDB for ClickHouseのAPI操作を呼び出すことができます。 ROSでサポートされているリソースとデータソースの詳細については、「ROSでサポートされているリソース」をご参照ください。
カスタムカプセル化
ビジネス要件に基づいてAPIリクエストをカプセル化し、API操作を呼び出すことができます。 ネイティブHTTP呼び出しを行うには、カスタムリクエストを作成し、リクエストに署名する必要があります。 署名メカニズムの詳細については、「リクエスト構文と署名メソッドV3」をご参照ください。
使用上の注意
APIを呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて、リクエストパラメーターとパラメーター値が有効かどうかを確認します。 詳細については、次をご参照ください： ApsaraDB for ClickHouse-エラーコード
返されたリクエストIDまたはSDKエラー情報に基づいて、セルフサービス診断を実行することもできます。 OpenAPIの問題診断ページ。